Cleanup: usages of bt_value_array_borrow_element_by_index{,_const}()
[babeltrace.git] / src / lib / trace-ir / attributes.c
CommitLineData
44e0a4f5 1/*
44e0a4f5
JG
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
b03487ab 24#define BT_LOG_TAG "LIB/ATTRS"
1633ef46 25#include "lib/logging.h"
0f5e83e5 26
85e7137b 27#include "common/macros.h"
71c5da58 28#include <babeltrace2/value.h>
57952005
MJ
29#include "lib/assert-pre.h"
30#include "lib/object.h"
71c5da58 31#include <babeltrace2/value-const.h>
57952005
MJ
32#include "lib/value.h"
33#include "attributes.h"
561ad8c1 34#include <inttypes.h>
57952005
MJ
35#include "compat/string.h"
36#include "common/assert.h"
44e0a4f5 37
839d52a5
PP
38#define BT_ATTR_NAME_INDEX 0
39#define BT_ATTR_VALUE_INDEX 1
44e0a4f5
JG
40
41BT_HIDDEN
ce141536 42struct bt_value *bt_attributes_create(void)
44e0a4f5 43{
ce141536 44 struct bt_value *attr_obj;
561ad8c1 45
44e0a4f5 46 /*
dac5c838
PP
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).
44e0a4f5
JG
50 *
51 * Example (JSON representation):
52 *
53 * [
54 * ["hostname", "eeppdesk"],
55 * ["sysname", "Linux"],
56 * ["tracer_major", 2],
57 * ["tracer_minor", 5]
58 * ]
59 */
561ad8c1 60 BT_LOGD_STR("Creating attributes object.");
ce141536 61 attr_obj = bt_value_array_create();
561ad8c1 62 if (!attr_obj) {
a8f90e5d 63 BT_LIB_LOGE_APPEND_CAUSE("Failed to create array value.");
561ad8c1
PP
64 } else {
65 BT_LOGD("Created attributes object: addr=%p",
66 attr_obj);
67 }
68
69 return attr_obj;
44e0a4f5
JG
70}
71
72BT_HIDDEN
ce141536 73void bt_attributes_destroy(struct bt_value *attr_obj)
44e0a4f5 74{
561ad8c1 75 BT_LOGD("Destroying attributes object: addr=%p", attr_obj);
1248f5ea 76 BT_OBJECT_PUT_REF_AND_RESET(attr_obj);
44e0a4f5
JG
77}
78
79BT_HIDDEN
6e30bfda 80uint64_t bt_attributes_get_count(const struct bt_value *attr_obj)
44e0a4f5 81{
1270d0e9 82 return bt_value_array_get_length(attr_obj);
44e0a4f5
JG
83}
84
85BT_HIDDEN
ce141536 86const char *bt_attributes_get_field_name(const struct bt_value *attr_obj,
dcf0cc71 87 uint64_t index)
44e0a4f5 88{
ce141536
PP
89 const struct bt_value *attr_field_obj = NULL;
90 const struct bt_value *attr_field_name_obj = NULL;
44e0a4f5 91
ec4a3354
PP
92 BT_ASSERT_DBG(attr_obj);
93 BT_ASSERT_DBG(index < bt_value_array_get_length(attr_obj));
ce141536 94 attr_field_obj = bt_value_array_borrow_element_by_index_const(
17582c6d 95 attr_obj, index);
44e0a4f5 96
17582c6d 97 attr_field_name_obj =
ce141536 98 bt_value_array_borrow_element_by_index_const(attr_field_obj,
17582c6d 99 BT_ATTR_NAME_INDEX);
44e0a4f5 100
85e6a116 101 return bt_value_string_get(attr_field_name_obj);
44e0a4f5
JG
102}
103
104BT_HIDDEN
ce141536
PP
105struct bt_value *bt_attributes_borrow_field_value(
106 struct bt_value *attr_obj, uint64_t index)
44e0a4f5 107{
ce141536 108 struct bt_value *attr_field_obj = NULL;
44e0a4f5 109
ec4a3354
PP
110 BT_ASSERT_DBG(attr_obj);
111 BT_ASSERT_DBG(index < bt_value_array_get_length(attr_obj));
85e6a116 112
17582c6d 113 attr_field_obj =
ce141536 114 bt_value_array_borrow_element_by_index(attr_obj, index);
44e0a4f5 115
85e6a116
FD
116 return bt_value_array_borrow_element_by_index( attr_field_obj,
117 BT_ATTR_VALUE_INDEX);
44e0a4f5
JG
118}
119
120static
ce141536
PP
121struct bt_value *bt_attributes_borrow_field_by_name(
122 struct bt_value *attr_obj, const char *name)
44e0a4f5 123{
b602018b 124 uint64_t i, attr_size;
ce141536
PP
125 struct bt_value *value_obj = NULL;
126 struct bt_value *attr_field_name_obj = NULL;
44e0a4f5 127
1270d0e9 128 attr_size = bt_value_array_get_length(attr_obj);
44e0a4f5 129 for (i = 0; i < attr_size; ++i) {
44e0a4f5
JG
130 const char *field_name;
131
ce141536 132 value_obj = bt_value_array_borrow_element_by_index(
17582c6d 133 attr_obj, i);
44e0a4f5 134
17582c6d 135 attr_field_name_obj =
ce141536 136 bt_value_array_borrow_element_by_index(
17582c6d 137 value_obj, BT_ATTR_NAME_INDEX);
44e0a4f5 138
ce141536 139 field_name = bt_value_string_get(attr_field_name_obj);
44e0a4f5 140
acfa8112 141 if (strcmp(field_name, name) == 0) {
44e0a4f5
JG
142 break;
143 }
144
5fe68922 145 value_obj = NULL;
44e0a4f5
JG
146 }
147
148 return value_obj;
44e0a4f5
JG
149}
150
151BT_HIDDEN
ce141536
PP
152int bt_attributes_set_field_value(struct bt_value *attr_obj,
153 const char *name, struct bt_value *value_obj)
44e0a4f5
JG
154{
155 int ret = 0;
ce141536 156 struct bt_value *attr_field_obj = NULL;
44e0a4f5 157
a8f90e5d
PP
158 BT_ASSERT(attr_obj);
159 BT_ASSERT(name);
160 BT_ASSERT(value_obj);
5fe68922 161 attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
44e0a4f5 162 if (attr_field_obj) {
ce141536 163 ret = bt_value_array_set_element_by_index(
17582c6d 164 attr_field_obj, BT_ATTR_VALUE_INDEX,
ce141536 165 value_obj);
5fe68922 166 attr_field_obj = NULL;
44e0a4f5
JG
167 goto end;
168 }
169
ce141536 170 attr_field_obj = bt_value_array_create();
44e0a4f5 171 if (!attr_field_obj) {
a8f90e5d 172 BT_LIB_LOGE_APPEND_CAUSE("Failed to create empty array value.");
44e0a4f5
JG
173 ret = -1;
174 goto end;
175 }
176
ce141536 177 ret = bt_value_array_append_string_element(attr_field_obj,
17582c6d 178 name);
ce141536
PP
179 ret |= bt_value_array_append_element(attr_field_obj,
180 value_obj);
44e0a4f5 181 if (ret) {
a8f90e5d
PP
182 BT_LIB_LOGE_APPEND_CAUSE(
183 "Cannot append elements to array value: %!+v",
561ad8c1 184 attr_field_obj);
44e0a4f5
JG
185 goto end;
186 }
187
ce141536
PP
188 ret = bt_value_array_append_element(attr_obj,
189 attr_field_obj);
561ad8c1 190 if (ret) {
a8f90e5d
PP
191 BT_LIB_LOGE_APPEND_CAUSE(
192 "Cannot append element to array value: "
193 "%![array-value-]+v, %![element-value-]+v",
561ad8c1
PP
194 attr_obj, attr_field_obj);
195 }
44e0a4f5
JG
196
197end:
8138bfe1 198 bt_object_put_ref(attr_field_obj);
44e0a4f5
JG
199 return ret;
200}
201
202BT_HIDDEN
ce141536
PP
203struct bt_value *bt_attributes_borrow_field_value_by_name(
204 struct bt_value *attr_obj, const char *name)
44e0a4f5 205{
ce141536
PP
206 struct bt_value *value_obj = NULL;
207 struct bt_value *attr_field_obj = NULL;
44e0a4f5 208
ec4a3354
PP
209 BT_ASSERT_DBG(attr_obj);
210 BT_ASSERT_DBG(name);
5fe68922 211 attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
44e0a4f5 212 if (!attr_field_obj) {
561ad8c1
PP
213 BT_LOGD("Cannot find attributes object's field by name: "
214 "value-addr=%p, name=\"%s\"", attr_obj, name);
44e0a4f5
JG
215 goto end;
216 }
217
ce141536 218 value_obj = bt_value_array_borrow_element_by_index(
17582c6d 219 attr_field_obj, BT_ATTR_VALUE_INDEX);
44e0a4f5
JG
220
221end:
44e0a4f5
JG
222 return value_obj;
223}
224
225BT_HIDDEN
ce141536 226int bt_attributes_freeze(const struct bt_value *attr_obj)
44e0a4f5 227{
b602018b 228 uint64_t i, count;
44e0a4f5
JG
229 int ret = 0;
230
a8f90e5d 231 BT_ASSERT(attr_obj);
561ad8c1 232 BT_LOGD("Freezing attributes object: value-addr=%p", attr_obj);
b602018b 233
1270d0e9 234 count = bt_value_array_get_length(attr_obj);
44e0a4f5
JG
235
236 /*
dac5c838
PP
237 * We do not freeze the array value object itself here, since
238 * internal stuff could need to modify/add attributes. Each
239 * attribute is frozen one by one.
44e0a4f5
JG
240 */
241 for (i = 0; i < count; ++i) {
ce141536 242 struct bt_value *obj = NULL;
44e0a4f5 243
ce141536
PP
244 obj = bt_attributes_borrow_field_value(
245 (void *) attr_obj, i);
44e0a4f5 246 if (!obj) {
a8f90e5d
PP
247 BT_LIB_LOGE_APPEND_CAUSE(
248 "Cannot get attributes object's field value by index: "
249 "%![value-]+v, index=%" PRIu64,
561ad8c1 250 attr_obj, i);
44e0a4f5
JG
251 ret = -1;
252 goto end;
253 }
254
ce141536 255 bt_value_freeze(obj);
44e0a4f5
JG
256 }
257
258end:
44e0a4f5
JG
259 return ret;
260}
This page took 0.096217 seconds and 4 git commands to generate.