src/lib/trace-ir/attributes.c

   1 /*
   2  * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
   3  * Copyright (c) 2015 Philippe Proulx <pproulx@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "ATTRS"
  25 #include "lib/lib-logging.h"
  26
  27 #include "common/macros.h"
  28 #include <babeltrace2/value.h>
  29 #include "lib/assert-pre.h"
  30 #include "lib/object.h"
  31 #include <babeltrace2/value-const.h>
  32 #include "lib/value.h"
  33 #include "attributes.h"
  34 #include <inttypes.h>
  35 #include "compat/string.h"
  36 #include "common/assert.h"
  37
  38 #define BT_ATTR_NAME_INDEX              0
  39 #define BT_ATTR_VALUE_INDEX             1
  40
  41 BT_HIDDEN
  42 struct bt_value *bt_attributes_create(void)
  43 {
  44         struct bt_value *attr_obj;
  45
  46         /*
  47          * Attributes: array value object of array value objects, each one
  48          * containing two entries: a string value object (attributes
  49          * field name), and a value object (attributes field value).
  50          *
  51          * Example (JSON representation):
  52          *
  53          *     [
  54          *         ["hostname", "eeppdesk"],
  55          *         ["sysname", "Linux"],
  56          *         ["tracer_major", 2],
  57          *         ["tracer_minor", 5]
  58          *     ]
  59          */
  60         BT_LOGD_STR("Creating attributes object.");
  61         attr_obj = bt_value_array_create();
  62         if (!attr_obj) {
  63                 BT_LOGE_STR("Failed to create array value.");
  64         } else {
  65                 BT_LOGD("Created attributes object: addr=%p",
  66                         attr_obj);
  67         }
  68
  69         return attr_obj;
  70 }
  71
  72 BT_HIDDEN
  73 void bt_attributes_destroy(struct bt_value *attr_obj)
  74 {
  75         BT_LOGD("Destroying attributes object: addr=%p", attr_obj);
  76         BT_OBJECT_PUT_REF_AND_RESET(attr_obj);
  77 }
  78
  79 BT_HIDDEN
  80 int64_t bt_attributes_get_count(const struct bt_value *attr_obj)
  81 {
  82         return bt_value_array_get_size(attr_obj);
  83 }
  84
  85 BT_HIDDEN
  86 const char *bt_attributes_get_field_name(const struct bt_value *attr_obj,
  87                 uint64_t index)
  88 {
  89         const char *ret = NULL;
  90         const struct bt_value *attr_field_obj = NULL;
  91         const struct bt_value *attr_field_name_obj = NULL;
  92
  93         if (!attr_obj) {
  94                 BT_LOGW_STR("Invalid parameter: attributes object is NULL.");
  95                 goto end;
  96         }
  97
  98         if (index >= bt_value_array_get_size(attr_obj)) {
  99                 BT_LOGW("Invalid parameter: index is out of bounds: "
 100                         "index=%" PRIu64 ", count=%" PRId64,
 101                         index, bt_value_array_get_size(attr_obj));
 102                 goto end;
 103         }
 104
 105         attr_field_obj = bt_value_array_borrow_element_by_index_const(
 106                 attr_obj, index);
 107         if (!attr_field_obj) {
 108                 BT_LOGE("Cannot get attributes object's array value's element by index: "
 109                         "value-addr=%p, index=%" PRIu64, attr_obj, index);
 110                 goto end;
 111         }
 112
 113         attr_field_name_obj =
 114                 bt_value_array_borrow_element_by_index_const(attr_field_obj,
 115                         BT_ATTR_NAME_INDEX);
 116         if (!attr_field_name_obj) {
 117                 BT_LOGE("Cannot get attribute array value's element by index: "
 118                         "value-addr=%p, index=%" PRIu64, attr_field_obj,
 119                         (uint64_t) BT_ATTR_NAME_INDEX);
 120                 goto end;
 121         }
 122
 123         ret = bt_value_string_get(attr_field_name_obj);
 124
 125 end:
 126         return ret;
 127 }
 128
 129 BT_HIDDEN
 130 struct bt_value *bt_attributes_borrow_field_value(
 131                 struct bt_value *attr_obj, uint64_t index)
 132 {
 133         struct bt_value *value_obj = NULL;
 134         struct bt_value *attr_field_obj = NULL;
 135
 136         if (!attr_obj) {
 137                 BT_LOGW_STR("Invalid parameter: attributes object is NULL.");
 138                 goto end;
 139         }
 140
 141         if (index >= bt_value_array_get_size(attr_obj)) {
 142                 BT_LOGW("Invalid parameter: index is out of bounds: "
 143                         "index=%" PRIu64 ", count=%" PRId64,
 144                         index, bt_value_array_get_size(attr_obj));
 145                 goto end;
 146         }
 147
 148         attr_field_obj =
 149                 bt_value_array_borrow_element_by_index(attr_obj, index);
 150         if (!attr_field_obj) {
 151                 BT_LOGE("Cannot get attributes object's array value's element by index: "
 152                         "value-addr=%p, index=%" PRIu64, attr_obj, index);
 153                 goto end;
 154         }
 155
 156         value_obj = bt_value_array_borrow_element_by_index(
 157                 attr_field_obj, BT_ATTR_VALUE_INDEX);
 158         if (!value_obj) {
 159                 BT_LOGE("Cannot get attribute array value's element by index: "
 160                         "value-addr=%p, index=%" PRIu64, attr_field_obj,
 161                         (uint64_t) BT_ATTR_VALUE_INDEX);
 162         }
 163
 164 end:
 165         return value_obj;
 166 }
 167
 168 static
 169 struct bt_value *bt_attributes_borrow_field_by_name(
 170                 struct bt_value *attr_obj, const char *name)
 171 {
 172         uint64_t i;
 173         int64_t attr_size;
 174         struct bt_value *value_obj = NULL;
 175         struct bt_value *attr_field_name_obj = NULL;
 176
 177         attr_size = bt_value_array_get_size(attr_obj);
 178         if (attr_size < 0) {
 179                 BT_LOGE("Cannot get array value's size: value-addr=%p",
 180                         attr_obj);
 181                 goto error;
 182         }
 183
 184         for (i = 0; i < attr_size; ++i) {
 185                 const char *field_name;
 186
 187                 value_obj = bt_value_array_borrow_element_by_index(
 188                         attr_obj, i);
 189                 if (!value_obj) {
 190                         BT_LOGE("Cannot get attributes object's array value's element by index: "
 191                                 "value-addr=%p, index=%" PRIu64, attr_obj, i);
 192                         goto error;
 193                 }
 194
 195                 attr_field_name_obj =
 196                         bt_value_array_borrow_element_by_index(
 197                                 value_obj, BT_ATTR_NAME_INDEX);
 198                 if (!attr_field_name_obj) {
 199                         BT_LOGE("Cannot get attribute array value's element by index: "
 200                                 "value-addr=%p, index=%" PRIu64,
 201                                 value_obj, (int64_t) BT_ATTR_NAME_INDEX);
 202                         goto error;
 203                 }
 204
 205                 field_name = bt_value_string_get(attr_field_name_obj);
 206
 207                 if (!strcmp(field_name, name)) {
 208                         break;
 209                 }
 210
 211                 value_obj = NULL;
 212         }
 213
 214         return value_obj;
 215
 216 error:
 217         value_obj = NULL;
 218         return value_obj;
 219 }
 220
 221 BT_HIDDEN
 222 int bt_attributes_set_field_value(struct bt_value *attr_obj,
 223                 const char *name, struct bt_value *value_obj)
 224 {
 225         int ret = 0;
 226         struct bt_value *attr_field_obj = NULL;
 227
 228         if (!attr_obj || !name || !value_obj) {
 229                 BT_LOGW("Invalid parameter: attributes object, name, or value object is NULL: "
 230                         "attr-value-addr=%p, name-addr=%p, value-addr=%p",
 231                         attr_obj, name, value_obj);
 232                 ret = -1;
 233                 goto end;
 234         }
 235
 236         attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
 237         if (attr_field_obj) {
 238                 ret = bt_value_array_set_element_by_index(
 239                         attr_field_obj, BT_ATTR_VALUE_INDEX,
 240                         value_obj);
 241                 attr_field_obj = NULL;
 242                 goto end;
 243         }
 244
 245         attr_field_obj = bt_value_array_create();
 246         if (!attr_field_obj) {
 247                 BT_LOGE_STR("Failed to create empty array value.");
 248                 ret = -1;
 249                 goto end;
 250         }
 251
 252         ret = bt_value_array_append_string_element(attr_field_obj,
 253                 name);
 254         ret |= bt_value_array_append_element(attr_field_obj,
 255                 value_obj);
 256         if (ret) {
 257                 BT_LOGE("Cannot append elements to array value: addr=%p",
 258                         attr_field_obj);
 259                 goto end;
 260         }
 261
 262         ret = bt_value_array_append_element(attr_obj,
 263                 attr_field_obj);
 264         if (ret) {
 265                 BT_LOGE("Cannot append element to array value: "
 266                         "array-value-addr=%p, element-value-addr=%p",
 267                         attr_obj, attr_field_obj);
 268         }
 269
 270 end:
 271         bt_object_put_ref(attr_field_obj);
 272         return ret;
 273 }
 274
 275 BT_HIDDEN
 276 struct bt_value *bt_attributes_borrow_field_value_by_name(
 277                 struct bt_value *attr_obj, const char *name)
 278 {
 279         struct bt_value *value_obj = NULL;
 280         struct bt_value *attr_field_obj = NULL;
 281
 282         if (!attr_obj || !name) {
 283                 BT_LOGW("Invalid parameter: attributes object or name is NULL: "
 284                         "value-addr=%p, name-addr=%p", attr_obj, name);
 285                 goto end;
 286         }
 287
 288         attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
 289         if (!attr_field_obj) {
 290                 BT_LOGD("Cannot find attributes object's field by name: "
 291                         "value-addr=%p, name=\"%s\"", attr_obj, name);
 292                 goto end;
 293         }
 294
 295         value_obj = bt_value_array_borrow_element_by_index(
 296                 attr_field_obj, BT_ATTR_VALUE_INDEX);
 297         if (!value_obj) {
 298                 BT_LOGE("Cannot get attribute array value's element by index: "
 299                         "value-addr=%p, index=%" PRIu64, attr_field_obj,
 300                         (uint64_t) BT_ATTR_VALUE_INDEX);
 301         }
 302
 303 end:
 304         return value_obj;
 305 }
 306
 307 BT_HIDDEN
 308 int bt_attributes_freeze(const struct bt_value *attr_obj)
 309 {
 310         uint64_t i;
 311         int64_t count;
 312         int ret = 0;
 313
 314         if (!attr_obj) {
 315                 BT_LOGW_STR("Invalid parameter: attributes object is NULL.");
 316                 ret = -1;
 317                 goto end;
 318         }
 319
 320         BT_LOGD("Freezing attributes object: value-addr=%p", attr_obj);
 321         count = bt_value_array_get_size(attr_obj);
 322         BT_ASSERT(count >= 0);
 323
 324         /*
 325          * We do not freeze the array value object itself here, since
 326          * internal stuff could need to modify/add attributes. Each
 327          * attribute is frozen one by one.
 328          */
 329         for (i = 0; i < count; ++i) {
 330                 struct bt_value *obj = NULL;
 331
 332                 obj = bt_attributes_borrow_field_value(
 333                         (void *) attr_obj, i);
 334                 if (!obj) {
 335                         BT_LOGE("Cannot get attributes object's field value by index: "
 336                                 "value-addr=%p, index=%" PRIu64,
 337                                 attr_obj, i);
 338                         ret = -1;
 339                         goto end;
 340                 }
 341
 342                 bt_value_freeze(obj);
 343         }
 344
 345 end:
 346         return ret;
 347 }