src/lib/trace-ir/field-path.c

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
   5  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  */
   7
   8 #define BT_LOG_TAG "LIB/FIELD-PATH"
   9 #include "lib/logging.h"
  10
  11 #include "lib/assert-cond.h"
  12 #include <babeltrace2/trace-ir/field-class.h>
  13 #include <babeltrace2/trace-ir/field-path.h>
  14 #include <limits.h>
  15 #include <stdint.h>
  16 #include <inttypes.h>
  17 #include "common/assert.h"
  18 #include <glib.h>
  19
  20 #include "field-class.h"
  21 #include "field-path.h"
  22
  23 static
  24 void destroy_field_path(struct bt_object *obj)
  25 {
  26         struct bt_field_path *field_path = (struct bt_field_path *) obj;
  27
  28         BT_ASSERT(field_path);
  29         BT_LIB_LOGD("Destroying field path: %!+P", field_path);
  30         g_array_free(field_path->items, TRUE);
  31         field_path->items = NULL;
  32         g_free(field_path);
  33 }
  34
  35 struct bt_field_path *bt_field_path_create(void)
  36 {
  37         struct bt_field_path *field_path = NULL;
  38
  39         BT_LOGD_STR("Creating empty field path object.");
  40
  41         field_path = g_new0(struct bt_field_path, 1);
  42         if (!field_path) {
  43                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one field path.");
  44                 goto error;
  45         }
  46
  47         bt_object_init_shared(&field_path->base, destroy_field_path);
  48         field_path->items = g_array_new(FALSE, FALSE,
  49                 sizeof(struct bt_field_path_item));
  50         if (!field_path->items) {
  51                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
  52                 goto error;
  53         }
  54
  55         BT_LIB_LOGD("Created empty field path object: %!+P", field_path);
  56         goto end;
  57
  58 error:
  59         BT_OBJECT_PUT_REF_AND_RESET(field_path);
  60
  61 end:
  62         return field_path;
  63 }
  64
  65 BT_EXPORT
  66 enum bt_field_path_scope bt_field_path_get_root_scope(
  67                 const struct bt_field_path *field_path)
  68 {
  69         BT_ASSERT_PRE_DEV_FP_NON_NULL(field_path);
  70         return field_path->root;
  71 }
  72
  73 BT_EXPORT
  74 uint64_t bt_field_path_get_item_count(const struct bt_field_path *field_path)
  75 {
  76         BT_ASSERT_PRE_DEV_FP_NON_NULL(field_path);
  77         return (uint64_t) field_path->items->len;
  78 }
  79
  80 BT_EXPORT
  81 const struct bt_field_path_item *bt_field_path_borrow_item_by_index_const(
  82                 const struct bt_field_path *field_path, uint64_t index)
  83 {
  84         BT_ASSERT_PRE_DEV_FP_NON_NULL(field_path);
  85         BT_ASSERT_PRE_DEV_VALID_INDEX(index, field_path->items->len);
  86         return bt_field_path_borrow_item_by_index_inline(field_path, index);
  87 }
  88
  89 BT_EXPORT
  90 enum bt_field_path_item_type bt_field_path_item_get_type(
  91                 const struct bt_field_path_item *field_path_item)
  92 {
  93         BT_ASSERT_PRE_DEV_NON_NULL("field-path-item", field_path_item,
  94                 "Field path item");
  95         return field_path_item->type;
  96 }
  97
  98 BT_EXPORT
  99 uint64_t bt_field_path_item_index_get_index(
 100                 const struct bt_field_path_item *field_path_item)
 101 {
 102         BT_ASSERT_PRE_DEV_NON_NULL("field-path-item", field_path_item,
 103                 "Field path item");
 104         BT_ASSERT_PRE_DEV("is-index-field-path-item",
 105                 field_path_item->type == BT_FIELD_PATH_ITEM_TYPE_INDEX,
 106                 "Field path item is not an index field path item: "
 107                 "addr=%p, type=%s", field_path_item,
 108                 bt_field_path_item_type_string(field_path_item->type));
 109         return  field_path_item->index;
 110 }
 111
 112 BT_EXPORT
 113 void bt_field_path_get_ref(const struct bt_field_path *field_path)
 114 {
 115         bt_object_get_ref(field_path);
 116 }
 117
 118 BT_EXPORT
 119 void bt_field_path_put_ref(const struct bt_field_path *field_path)
 120 {
 121         bt_object_put_ref(field_path);
 122 }