lib/ctf-ir/attributes.c

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