lib/ctf-ir/field-path.c

   1 /*
   2  * field-path.c
   3  *
   4  * Babeltrace CTF IR - Field path
   5  *
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  */
  27
  28 #define BT_LOG_TAG "FIELD-PATH"
  29 #include <babeltrace/lib-logging-internal.h>
  30
  31 #include <babeltrace/assert-pre-internal.h>
  32 #include <babeltrace/ctf-ir/field-types.h>
  33 #include <babeltrace/ctf-ir/field-types-internal.h>
  34 #include <babeltrace/ctf-ir/field-path-internal.h>
  35 #include <babeltrace/ctf-ir/field-path.h>
  36 #include <limits.h>
  37 #include <stdint.h>
  38 #include <inttypes.h>
  39 #include <babeltrace/assert-internal.h>
  40 #include <glib.h>
  41
  42 static
  43 void destroy_field_path(struct bt_object *obj)
  44 {
  45         struct bt_field_path *field_path = (struct bt_field_path *) obj;
  46
  47         BT_ASSERT(field_path);
  48         BT_LIB_LOGD("Destroying field path: %!+P", field_path);
  49         g_array_free(field_path->indexes, TRUE);
  50         g_free(field_path);
  51 }
  52
  53 BT_HIDDEN
  54 struct bt_field_path *bt_field_path_create(void)
  55 {
  56         struct bt_field_path *field_path = NULL;
  57
  58         BT_LOGD_STR("Creating empty field path object.");
  59
  60         field_path = g_new0(struct bt_field_path, 1);
  61         if (!field_path) {
  62                 BT_LOGE_STR("Failed to allocate one field path.");
  63                 goto error;
  64         }
  65
  66         bt_object_init_shared(&field_path->base, destroy_field_path);
  67         field_path->indexes = g_array_new(FALSE, FALSE, sizeof(uint64_t));
  68         if (!field_path->indexes) {
  69                 BT_LOGE_STR("Failed to allocate a GArray.");
  70                 goto error;
  71         }
  72
  73         BT_LIB_LOGD("Created empty field path object: %!+P", field_path);
  74         goto end;
  75
  76 error:
  77         BT_PUT(field_path);
  78
  79 end:
  80         return field_path;
  81 }
  82
  83 enum bt_scope bt_field_path_get_root_scope(struct bt_field_path *field_path)
  84 {
  85         BT_ASSERT_PRE_NON_NULL(field_path, "Field path");
  86         return field_path->root;
  87 }
  88
  89 uint64_t bt_field_path_get_index_count(struct bt_field_path *field_path)
  90 {
  91         BT_ASSERT_PRE_NON_NULL(field_path, "Field path");
  92         return (uint64_t) field_path->indexes->len;
  93 }
  94
  95 uint64_t bt_field_path_get_index_by_index(struct bt_field_path *field_path,
  96                 uint64_t index)
  97 {
  98         BT_ASSERT_PRE_NON_NULL(field_path, "Field path");
  99         BT_ASSERT_PRE_VALID_INDEX(index, field_path->indexes->len);
 100         return bt_field_path_get_index_by_index_inline(field_path, index);
 101 }