src/ctf-writer/utils.c

   1 /*
   2  * utils.c
   3  *
   4  * Babeltrace CTF writer - 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-WRITER/UTILS"
  30 #include "logging.h"
  31
  32 #include <glib.h>
  33 #include <stdlib.h>
  34
  35 #include <babeltrace2-ctf-writer/utils.h>
  36 #include <babeltrace2-ctf-writer/object.h>
  37
  38 #include "common/assert.h"
  39
  40 #include "clock-class.h"
  41 #include "field-types.h"
  42
  43 static
  44 const char * const reserved_keywords_str[] = {"align", "callsite",
  45         "const", "char", "clock", "double", "enum", "env", "event",
  46         "floating_point", "float", "integer", "int", "long", "short", "signed",
  47         "stream", "string", "struct", "trace", "typealias", "typedef",
  48         "unsigned", "variant", "void" "_Bool", "_Complex", "_Imaginary"};
  49
  50 static GHashTable *reserved_keywords_set;
  51 static int init_done;
  52
  53 static
  54 void try_init_reserved_keywords(void)
  55 {
  56         size_t i;
  57         const size_t reserved_keywords_count =
  58                 sizeof(reserved_keywords_str) / sizeof(char *);
  59
  60         if (reserved_keywords_set) {
  61                 return;
  62         }
  63
  64         reserved_keywords_set = g_hash_table_new(g_direct_hash, g_direct_equal);
  65         BT_ASSERT_DBG(reserved_keywords_set);
  66
  67         for (i = 0; i < reserved_keywords_count; i++) {
  68                 gpointer quark = GINT_TO_POINTER(g_quark_from_string(
  69                         reserved_keywords_str[i]));
  70
  71                 g_hash_table_insert(reserved_keywords_set, quark, quark);
  72         }
  73
  74         init_done = 1;
  75 }
  76
  77 static __attribute__((destructor))
  78 void trace_finalize(void)
  79 {
  80         if (reserved_keywords_set) {
  81                 g_hash_table_destroy(reserved_keywords_set);
  82         }
  83 }
  84
  85 bt_ctf_bool bt_ctf_identifier_is_valid(const char *identifier)
  86 {
  87         bt_ctf_bool is_valid = BT_CTF_TRUE;
  88         char *string = NULL;
  89         char *save_ptr, *token;
  90
  91         if (!identifier) {
  92                 BT_LOGT_STR("Invalid parameter: input string is NULL.");
  93                 is_valid = BT_CTF_FALSE;
  94                 goto end;
  95         }
  96
  97         try_init_reserved_keywords();
  98
  99         if (identifier[0] == '\0') {
 100                 is_valid = BT_CTF_FALSE;
 101                 goto end;
 102         }
 103
 104         string = strdup(identifier);
 105         if (!string) {
 106                 BT_LOGE("strdup() failed.");
 107                 is_valid = BT_CTF_FALSE;
 108                 goto end;
 109         }
 110
 111         token = strtok_r(string, " ", &save_ptr);
 112         while (token) {
 113                 if (g_hash_table_lookup_extended(reserved_keywords_set,
 114                         GINT_TO_POINTER(g_quark_from_string(token)),
 115                         NULL, NULL)) {
 116                         is_valid = BT_CTF_FALSE;
 117                         goto end;
 118                 }
 119
 120                 token = strtok_r(NULL, " ", &save_ptr);
 121         }
 122 end:
 123         free(string);
 124         return is_valid;
 125 }