lib/ctf-ir/utils.c

   1 /*
   2  * utils.c
   3  *
   4  * Babeltrace CTF IR - Utilities
   5  *
   6  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  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:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  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
  26  * SOFTWARE.
  27  */
  28
  29 #define BT_LOG_TAG "CTF-IR-UTILS"
  30 #include <babeltrace/lib-logging-internal.h>
  31
  32 #include <stdlib.h>
  33 #include <glib.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>
  39
  40 static
  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"};
  46
  47 static GHashTable *reserved_keywords_set;
  48 static int init_done;
  49
  50 static
  51 void try_init_reserved_keywords(void)
  52 {
  53         size_t i;
  54         const size_t reserved_keywords_count =
  55                 sizeof(reserved_keywords_str) / sizeof(char *);
  56
  57         if (reserved_keywords_set) {
  58                 return;
  59         }
  60
  61         reserved_keywords_set = g_hash_table_new(g_direct_hash, g_direct_equal);
  62         BT_ASSERT(reserved_keywords_set);
  63
  64         for (i = 0; i < reserved_keywords_count; i++) {
  65                 gpointer quark = GINT_TO_POINTER(g_quark_from_string(
  66                         reserved_keywords_str[i]));
  67
  68                 g_hash_table_insert(reserved_keywords_set, quark, quark);
  69         }
  70
  71         init_done = 1;
  72 }
  73
  74 static __attribute__((destructor))
  75 void trace_finalize(void)
  76 {
  77         if (reserved_keywords_set) {
  78                 g_hash_table_destroy(reserved_keywords_set);
  79         }
  80 }
  81
  82 int bt_validate_identifier(const char *input_string)
  83 {
  84         int ret = 0;
  85         char *string = NULL;
  86         char *save_ptr, *token;
  87
  88         if (!input_string) {
  89                 BT_LOGV_STR("Invalid parameter: input string is NULL.");
  90                 ret = -1;
  91                 goto end;
  92         }
  93
  94         try_init_reserved_keywords();
  95
  96         if (input_string[0] == '\0') {
  97                 ret = -1;
  98                 goto end;
  99         }
 100
 101         string = strdup(input_string);
 102         if (!string) {
 103                 BT_LOGE("strdup() failed.");
 104                 ret = -1;
 105                 goto end;
 106         }
 107
 108         token = strtok_r(string, " ", &save_ptr);
 109         while (token) {
 110                 if (g_hash_table_lookup_extended(reserved_keywords_set,
 111                         GINT_TO_POINTER(g_quark_from_string(token)),
 112                         NULL, NULL)) {
 113                         ret = -1;
 114                         goto end;
 115                 }
 116
 117                 token = strtok_r(NULL, " ", &save_ptr);
 118         }
 119 end:
 120         free(string);
 121         return ret;
 122 }
 123
 124 bt_bool bt_identifier_is_valid(const char *identifier)
 125 {
 126         return bt_validate_identifier(identifier) == 0;
 127 }
 128
 129 BT_HIDDEN
 130 int bt_validate_single_clock_class(struct bt_field_type *field_type,
 131                 struct bt_clock_class **expected_clock_class)
 132 {
 133         int ret = 0;
 134
 135         if (!field_type) {
 136                 goto end;
 137         }
 138
 139         BT_ASSERT(expected_clock_class);
 140
 141         switch (bt_field_type_get_type_id(field_type)) {
 142         case BT_FIELD_TYPE_ID_INTEGER:
 143         {
 144                 struct bt_clock_class *mapped_clock_class =
 145                         bt_field_type_integer_get_mapped_clock_class(field_type);
 146
 147                 if (!mapped_clock_class) {
 148                         goto end;
 149                 }
 150
 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);
 158                 } else {
 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\"",
 166                                         mapped_clock_class,
 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);
 171                                 ret = -1;
 172                                 goto end;
 173                         }
 174                 }
 175
 176                 bt_put(mapped_clock_class);
 177                 break;
 178         }
 179         case BT_FIELD_TYPE_ID_ENUM:
 180         case BT_FIELD_TYPE_ID_ARRAY:
 181         case BT_FIELD_TYPE_ID_SEQUENCE:
 182         {
 183                 struct bt_field_type *subtype = NULL;
 184
 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(
 188                                 field_type);
 189                         break;
 190                 case BT_FIELD_TYPE_ID_ARRAY:
 191                         subtype = bt_field_type_array_get_element_type(
 192                                 field_type);
 193                         break;
 194                 case BT_FIELD_TYPE_ID_SEQUENCE:
 195                         subtype = bt_field_type_sequence_get_element_type(
 196                                 field_type);
 197                         break;
 198                 default:
 199                         BT_LOGF("Unexpected field type ID: id=%d",
 200                                 bt_field_type_get_type_id(field_type));
 201                         abort();
 202                 }
 203
 204                 BT_ASSERT(subtype);
 205                 ret = bt_validate_single_clock_class(subtype,
 206                         expected_clock_class);
 207                 bt_put(subtype);
 208                 break;
 209         }
 210         case BT_FIELD_TYPE_ID_STRUCT:
 211         {
 212                 uint64_t i;
 213                 int64_t count = bt_field_type_structure_get_field_count(
 214                         field_type);
 215
 216                 for (i = 0; i < count; i++) {
 217                         const char *name;
 218                         struct bt_field_type *member_type;
 219
 220                         ret = bt_field_type_structure_get_field_by_index(
 221                                 field_type, &name, &member_type, i);
 222                         BT_ASSERT(ret == 0);
 223                         ret = bt_validate_single_clock_class(member_type,
 224                                 expected_clock_class);
 225                         bt_put(member_type);
 226                         if (ret) {
 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\"",
 231                                         member_type, name);
 232                                 goto end;
 233                         }
 234                 }
 235
 236                 break;
 237         }
 238         case BT_FIELD_TYPE_ID_VARIANT:
 239         {
 240                 uint64_t i;
 241                 int64_t count = bt_field_type_variant_get_field_count(
 242                         field_type);
 243
 244                 for (i = 0; i < count; i++) {
 245                         const char *name;
 246                         struct bt_field_type *member_type;
 247
 248                         ret = bt_field_type_variant_get_field_by_index(
 249                                 field_type, &name, &member_type, i);
 250                         BT_ASSERT(ret == 0);
 251                         ret = bt_validate_single_clock_class(member_type,
 252                                 expected_clock_class);
 253                         bt_put(member_type);
 254                         if (ret) {
 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\"",
 259                                         member_type, name);
 260                                 goto end;
 261                         }
 262                 }
 263
 264                 break;
 265         }
 266         default:
 267                 break;
 268         }
 269
 270 end:
 271         return ret;
 272 }