lib/trace-ir/attributes.c

   1 /*
   2  * attributes.c
   3  *
   4  * Babeltrace trace IR - Attributes
   5  *
   6  * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
   7  * Copyright (c) 2015 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 "ATTRS"
  29 #include <babeltrace/lib-logging-internal.h>
  30
  31 #include <babeltrace/object.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/values.h>
  34 #include <babeltrace/private-values.h>
  35 #include <babeltrace/values-internal.h>
  36 #include <inttypes.h>
  37 #include <babeltrace/compat/string-internal.h>
  38 #include <babeltrace/assert-internal.h>
  39
  40 #define BT_ATTR_NAME_INDEX              0
  41 #define BT_ATTR_VALUE_INDEX             1
  42
  43 BT_HIDDEN
  44 struct bt_private_value *bt_attributes_create(void)
  45 {
  46         struct bt_private_value *attr_obj;
  47
  48         /*
  49          * Attributes: array value object of array value objects, each one
  50          * containing two entries: a string value object (attributes
  51          * field name), and a value object (attributes field value).
  52          *
  53          * Example (JSON representation):
  54          *
  55          *     [
  56          *         ["hostname", "eeppdesk"],
  57          *         ["sysname", "Linux"],
  58          *         ["tracer_major", 2],
  59          *         ["tracer_minor", 5]
  60          *     ]
  61          */
  62         BT_LOGD_STR("Creating attributes object.");
  63         attr_obj = bt_private_value_array_create();
  64         if (!attr_obj) {
  65                 BT_LOGE_STR("Failed to create array value.");
  66         } else {
  67                 BT_LOGD("Created attributes object: addr=%p",
  68                         attr_obj);
  69         }
  70
  71         return attr_obj;
  72 }
  73
  74 BT_HIDDEN
  75 void bt_attributes_destroy(struct bt_private_value *attr_obj)
  76 {
  77         BT_LOGD("Destroying attributes object: addr=%p", attr_obj);
  78         bt_object_put_ref(attr_obj);
  79 }
  80
  81 BT_HIDDEN
  82 int64_t bt_attributes_get_count(struct bt_private_value *attr_obj)
  83 {
  84         return bt_value_array_get_size(bt_value_borrow_from_private(attr_obj));
  85 }
  86
  87 BT_HIDDEN
  88 const char *bt_attributes_get_field_name(struct bt_private_value *attr_obj,
  89                 uint64_t index)
  90 {
  91         int rc;
  92         const char *ret = NULL;
  93         struct bt_private_value *attr_field_obj = NULL;
  94         struct bt_private_value *attr_field_name_obj = NULL;
  95
  96         if (!attr_obj) {
  97                 BT_LOGW_STR("Invalid parameter: attributes object is NULL.");
  98                 goto end;
  99         }
 100
 101         if (index >= bt_value_array_get_size(
 102                         bt_value_borrow_from_private(attr_obj))) {
 103                 BT_LOGW("Invalid parameter: index is out of bounds: "
 104                         "index=%" PRIu64 ", count=%" PRId64,
 105                         index, bt_value_array_get_size(
 106                                 bt_value_borrow_from_private(attr_obj)));
 107                 goto end;
 108         }
 109
 110         attr_field_obj = bt_private_value_array_borrow_element_by_index(
 111                 attr_obj, index);
 112         if (!attr_field_obj) {
 113                 BT_LOGE("Cannot get attributes object's array value's element by index: "
 114                         "value-addr=%p, index=%" PRIu64, attr_obj, index);
 115                 goto end;
 116         }
 117
 118         attr_field_name_obj =
 119                 bt_private_value_array_borrow_element_by_index(attr_field_obj,
 120                         BT_ATTR_NAME_INDEX);
 121         if (!attr_field_name_obj) {
 122                 BT_LOGE("Cannot get attribute array value's element by index: "
 123                         "value-addr=%p, index=%" PRIu64, attr_field_obj,
 124                         (uint64_t) BT_ATTR_NAME_INDEX);
 125                 goto end;
 126         }
 127
 128         rc = bt_value_string_get(
 129                 bt_value_borrow_from_private(attr_field_name_obj), &ret);
 130         if (rc) {
 131                 BT_LOGE("Cannot get raw value from string value: value-addr=%p",
 132                         attr_field_name_obj);
 133                 ret = NULL;
 134         }
 135
 136 end:
 137         return ret;
 138 }
 139
 140 BT_HIDDEN
 141 struct bt_private_value *bt_attributes_borrow_field_value(
 142                 struct bt_private_value *attr_obj, uint64_t index)
 143 {
 144         struct bt_private_value *value_obj = NULL;
 145         struct bt_private_value *attr_field_obj = NULL;
 146
 147         if (!attr_obj) {
 148                 BT_LOGW_STR("Invalid parameter: attributes object is NULL.");
 149                 goto end;
 150         }
 151
 152         if (index >= bt_value_array_get_size(bt_value_borrow_from_private(attr_obj))) {
 153                 BT_LOGW("Invalid parameter: index is out of bounds: "
 154                         "index=%" PRIu64 ", count=%" PRId64,
 155                         index, bt_value_array_get_size(
 156                                 bt_value_borrow_from_private(attr_obj)));
 157                 goto end;
 158         }
 159
 160         attr_field_obj =
 161                 bt_private_value_array_borrow_element_by_index(attr_obj, index);
 162         if (!attr_field_obj) {
 163                 BT_LOGE("Cannot get attributes object's array value's element by index: "
 164                         "value-addr=%p, index=%" PRIu64, attr_obj, index);
 165                 goto end;
 166         }
 167
 168         value_obj = bt_private_value_array_borrow_element_by_index(
 169                 attr_field_obj, BT_ATTR_VALUE_INDEX);
 170         if (!value_obj) {
 171                 BT_LOGE("Cannot get attribute array value's element by index: "
 172                         "value-addr=%p, index=%" PRIu64, attr_field_obj,
 173                         (uint64_t) BT_ATTR_VALUE_INDEX);
 174         }
 175
 176 end:
 177         return value_obj;
 178 }
 179
 180 static
 181 struct bt_private_value *bt_attributes_borrow_field_by_name(
 182                 struct bt_private_value *attr_obj, const char *name)
 183 {
 184         uint64_t i;
 185         int64_t attr_size;
 186         struct bt_private_value *value_obj = NULL;
 187         struct bt_private_value *attr_field_name_obj = NULL;
 188
 189         attr_size = bt_value_array_get_size(
 190                 bt_value_borrow_from_private(attr_obj));
 191         if (attr_size < 0) {
 192                 BT_LOGE("Cannot get array value's size: value-addr=%p",
 193                         attr_obj);
 194                 goto error;
 195         }
 196
 197         for (i = 0; i < attr_size; ++i) {
 198                 int ret;
 199                 const char *field_name;
 200
 201                 value_obj = bt_private_value_array_borrow_element_by_index(
 202                         attr_obj, i);
 203                 if (!value_obj) {
 204                         BT_LOGE("Cannot get attributes object's array value's element by index: "
 205                                 "value-addr=%p, index=%" PRIu64, attr_obj, i);
 206                         goto error;
 207                 }
 208
 209                 attr_field_name_obj =
 210                         bt_private_value_array_borrow_element_by_index(
 211                                 value_obj, BT_ATTR_NAME_INDEX);
 212                 if (!attr_field_name_obj) {
 213                         BT_LOGE("Cannot get attribute array value's element by index: "
 214                                 "value-addr=%p, index=%" PRIu64,
 215                                 value_obj, (int64_t) BT_ATTR_NAME_INDEX);
 216                         goto error;
 217                 }
 218
 219                 ret = bt_value_string_get(
 220                         bt_value_borrow_from_private(attr_field_name_obj),
 221                         &field_name);
 222                 if (ret) {
 223                         BT_LOGE("Cannot get raw value from string value: value-addr=%p",
 224                                 attr_field_name_obj);
 225                         goto error;
 226                 }
 227
 228                 if (!strcmp(field_name, name)) {
 229                         break;
 230                 }
 231
 232                 value_obj = NULL;
 233         }
 234
 235         return value_obj;
 236
 237 error:
 238         value_obj = NULL;
 239         return value_obj;
 240 }
 241
 242 BT_HIDDEN
 243 int bt_attributes_set_field_value(struct bt_private_value *attr_obj,
 244                 const char *name, struct bt_private_value *value_obj)
 245 {
 246         int ret = 0;
 247         struct bt_private_value *attr_field_obj = NULL;
 248
 249         if (!attr_obj || !name || !value_obj) {
 250                 BT_LOGW("Invalid parameter: attributes object, name, or value object is NULL: "
 251                         "attr-value-addr=%p, name-addr=%p, value-addr=%p",
 252                         attr_obj, name, value_obj);
 253                 ret = -1;
 254                 goto end;
 255         }
 256
 257         attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
 258         if (attr_field_obj) {
 259                 ret = bt_private_value_array_set_element_by_index(
 260                         attr_field_obj, BT_ATTR_VALUE_INDEX,
 261                         bt_value_borrow_from_private(value_obj));
 262                 attr_field_obj = NULL;
 263                 goto end;
 264         }
 265
 266         attr_field_obj = bt_private_value_array_create();
 267         if (!attr_field_obj) {
 268                 BT_LOGE_STR("Failed to create empty array value.");
 269                 ret = -1;
 270                 goto end;
 271         }
 272
 273         ret = bt_private_value_array_append_string_element(attr_field_obj,
 274                 name);
 275         ret |= bt_private_value_array_append_element(attr_field_obj,
 276                 bt_value_borrow_from_private(value_obj));
 277         if (ret) {
 278                 BT_LOGE("Cannot append elements to array value: addr=%p",
 279                         attr_field_obj);
 280                 goto end;
 281         }
 282
 283         ret = bt_private_value_array_append_element(attr_obj,
 284                 bt_value_borrow_from_private(attr_field_obj));
 285         if (ret) {
 286                 BT_LOGE("Cannot append element to array value: "
 287                         "array-value-addr=%p, element-value-addr=%p",
 288                         attr_obj, attr_field_obj);
 289         }
 290
 291 end:
 292         bt_object_put_ref(attr_field_obj);
 293         return ret;
 294 }
 295
 296 BT_HIDDEN
 297 struct bt_private_value *bt_attributes_borrow_field_value_by_name(
 298                 struct bt_private_value *attr_obj, const char *name)
 299 {
 300         struct bt_private_value *value_obj = NULL;
 301         struct bt_private_value *attr_field_obj = NULL;
 302
 303         if (!attr_obj || !name) {
 304                 BT_LOGW("Invalid parameter: attributes object or name is NULL: "
 305                         "value-addr=%p, name-addr=%p", attr_obj, name);
 306                 goto end;
 307         }
 308
 309         attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
 310         if (!attr_field_obj) {
 311                 BT_LOGD("Cannot find attributes object's field by name: "
 312                         "value-addr=%p, name=\"%s\"", attr_obj, name);
 313                 goto end;
 314         }
 315
 316         value_obj = bt_private_value_array_borrow_element_by_index(
 317                 attr_field_obj, BT_ATTR_VALUE_INDEX);
 318         if (!value_obj) {
 319                 BT_LOGE("Cannot get attribute array value's element by index: "
 320                         "value-addr=%p, index=%" PRIu64, attr_field_obj,
 321                         (uint64_t) BT_ATTR_VALUE_INDEX);
 322         }
 323
 324 end:
 325         return value_obj;
 326 }
 327
 328 BT_HIDDEN
 329 int bt_attributes_freeze(struct bt_private_value *attr_obj)
 330 {
 331         uint64_t i;
 332         int64_t count;
 333         int ret = 0;
 334
 335         if (!attr_obj) {
 336                 BT_LOGW_STR("Invalid parameter: attributes object is NULL.");
 337                 ret = -1;
 338                 goto end;
 339         }
 340
 341         BT_LOGD("Freezing attributes object: value-addr=%p", attr_obj);
 342         count = bt_value_array_get_size(bt_value_borrow_from_private(attr_obj));
 343         BT_ASSERT(count >= 0);
 344
 345         /*
 346          * We do not freeze the array value object itself here, since
 347          * internal stuff could need to modify/add attributes. Each
 348          * attribute is frozen one by one.
 349          */
 350         for (i = 0; i < count; ++i) {
 351                 struct bt_private_value *obj = NULL;
 352
 353                 obj = bt_attributes_borrow_field_value(attr_obj, i);
 354                 if (!obj) {
 355                         BT_LOGE("Cannot get attributes object's field value by index: "
 356                                 "value-addr=%p, index=%" PRIu64,
 357                                 attr_obj, i);
 358                         ret = -1;
 359                         goto end;
 360                 }
 361
 362                 bt_value_freeze(bt_value_borrow_from_private(obj));
 363         }
 364
 365 end:
 366         return ret;
 367 }