lib: use BT_LIB_LOG*_APPEND_CAUSE() where appropriate
[babeltrace.git] / 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 "LIB/ATTRS"
25 #include "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_LIB_LOGE_APPEND_CAUSE("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 BT_ASSERT(attr_obj);
94 BT_ASSERT(index < bt_value_array_get_size(attr_obj));
95 attr_field_obj = bt_value_array_borrow_element_by_index_const(
96 attr_obj, index);
97 if (!attr_field_obj) {
98 BT_LIB_LOGE_APPEND_CAUSE(
99 "Cannot borrow attributes object's array value's element by index: "
100 "%![value-]+v, index=%" PRIu64, attr_obj, index);
101 goto end;
102 }
103
104 attr_field_name_obj =
105 bt_value_array_borrow_element_by_index_const(attr_field_obj,
106 BT_ATTR_NAME_INDEX);
107 if (!attr_field_name_obj) {
108 BT_LIB_LOGE_APPEND_CAUSE(
109 "Cannot get attribute array value's element by index: "
110 "%![value-]+v, index=%" PRIu64, attr_field_obj,
111 (uint64_t) BT_ATTR_NAME_INDEX);
112 goto end;
113 }
114
115 ret = bt_value_string_get(attr_field_name_obj);
116
117 end:
118 return ret;
119 }
120
121 BT_HIDDEN
122 struct bt_value *bt_attributes_borrow_field_value(
123 struct bt_value *attr_obj, uint64_t index)
124 {
125 struct bt_value *value_obj = NULL;
126 struct bt_value *attr_field_obj = NULL;
127
128 BT_ASSERT(attr_obj);
129 BT_ASSERT(index < bt_value_array_get_size(attr_obj));
130 attr_field_obj =
131 bt_value_array_borrow_element_by_index(attr_obj, index);
132 if (!attr_field_obj) {
133 BT_LIB_LOGE_APPEND_CAUSE(
134 "Cannot get attributes object's array value's element by index: "
135 "%![value-]+v, index=%" PRIu64, attr_obj, index);
136 goto end;
137 }
138
139 value_obj = bt_value_array_borrow_element_by_index(
140 attr_field_obj, BT_ATTR_VALUE_INDEX);
141 if (!value_obj) {
142 BT_LIB_LOGE_APPEND_CAUSE(
143 "Cannot get attribute array value's element by index: "
144 "%![value-]+v, index=%" PRIu64, attr_field_obj,
145 (uint64_t) BT_ATTR_VALUE_INDEX);
146 }
147
148 end:
149 return value_obj;
150 }
151
152 static
153 struct bt_value *bt_attributes_borrow_field_by_name(
154 struct bt_value *attr_obj, const char *name)
155 {
156 uint64_t i;
157 int64_t attr_size;
158 struct bt_value *value_obj = NULL;
159 struct bt_value *attr_field_name_obj = NULL;
160
161 attr_size = bt_value_array_get_size(attr_obj);
162 if (attr_size < 0) {
163 BT_LIB_LOGE_APPEND_CAUSE(
164 "Cannot get array value's size: %![value-]+v",
165 attr_obj);
166 goto error;
167 }
168
169 for (i = 0; i < attr_size; ++i) {
170 const char *field_name;
171
172 value_obj = bt_value_array_borrow_element_by_index(
173 attr_obj, i);
174 if (!value_obj) {
175 BT_LIB_LOGE_APPEND_CAUSE(
176 "Cannot get attributes object's array value's element by index: "
177 "%![value-]+v, index=%" PRIu64, attr_obj, i);
178 goto error;
179 }
180
181 attr_field_name_obj =
182 bt_value_array_borrow_element_by_index(
183 value_obj, BT_ATTR_NAME_INDEX);
184 if (!attr_field_name_obj) {
185 BT_LIB_LOGE_APPEND_CAUSE(
186 "Cannot get attribute array value's element by index: "
187 "%![value-]+v, index=%" PRIu64,
188 value_obj, (int64_t) BT_ATTR_NAME_INDEX);
189 goto error;
190 }
191
192 field_name = bt_value_string_get(attr_field_name_obj);
193
194 if (!strcmp(field_name, name)) {
195 break;
196 }
197
198 value_obj = NULL;
199 }
200
201 return value_obj;
202
203 error:
204 value_obj = NULL;
205 return value_obj;
206 }
207
208 BT_HIDDEN
209 int bt_attributes_set_field_value(struct bt_value *attr_obj,
210 const char *name, struct bt_value *value_obj)
211 {
212 int ret = 0;
213 struct bt_value *attr_field_obj = NULL;
214
215 BT_ASSERT(attr_obj);
216 BT_ASSERT(name);
217 BT_ASSERT(value_obj);
218 attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
219 if (attr_field_obj) {
220 ret = bt_value_array_set_element_by_index(
221 attr_field_obj, BT_ATTR_VALUE_INDEX,
222 value_obj);
223 attr_field_obj = NULL;
224 goto end;
225 }
226
227 attr_field_obj = bt_value_array_create();
228 if (!attr_field_obj) {
229 BT_LIB_LOGE_APPEND_CAUSE("Failed to create empty array value.");
230 ret = -1;
231 goto end;
232 }
233
234 ret = bt_value_array_append_string_element(attr_field_obj,
235 name);
236 ret |= bt_value_array_append_element(attr_field_obj,
237 value_obj);
238 if (ret) {
239 BT_LIB_LOGE_APPEND_CAUSE(
240 "Cannot append elements to array value: %!+v",
241 attr_field_obj);
242 goto end;
243 }
244
245 ret = bt_value_array_append_element(attr_obj,
246 attr_field_obj);
247 if (ret) {
248 BT_LIB_LOGE_APPEND_CAUSE(
249 "Cannot append element to array value: "
250 "%![array-value-]+v, %![element-value-]+v",
251 attr_obj, attr_field_obj);
252 }
253
254 end:
255 bt_object_put_ref(attr_field_obj);
256 return ret;
257 }
258
259 BT_HIDDEN
260 struct bt_value *bt_attributes_borrow_field_value_by_name(
261 struct bt_value *attr_obj, const char *name)
262 {
263 struct bt_value *value_obj = NULL;
264 struct bt_value *attr_field_obj = NULL;
265
266 BT_ASSERT(attr_obj);
267 BT_ASSERT(name);
268 attr_field_obj = bt_attributes_borrow_field_by_name(attr_obj, name);
269 if (!attr_field_obj) {
270 BT_LOGD("Cannot find attributes object's field by name: "
271 "value-addr=%p, name=\"%s\"", attr_obj, name);
272 goto end;
273 }
274
275 value_obj = bt_value_array_borrow_element_by_index(
276 attr_field_obj, BT_ATTR_VALUE_INDEX);
277 if (!value_obj) {
278 BT_LIB_LOGE_APPEND_CAUSE(
279 "Cannot get attribute array value's element by index: "
280 "%![value-]+v, index=%" PRIu64, attr_field_obj,
281 (uint64_t) BT_ATTR_VALUE_INDEX);
282 }
283
284 end:
285 return value_obj;
286 }
287
288 BT_HIDDEN
289 int bt_attributes_freeze(const struct bt_value *attr_obj)
290 {
291 uint64_t i;
292 int64_t count;
293 int ret = 0;
294
295 BT_ASSERT(attr_obj);
296 BT_LOGD("Freezing attributes object: value-addr=%p", attr_obj);
297 count = bt_value_array_get_size(attr_obj);
298 BT_ASSERT(count >= 0);
299
300 /*
301 * We do not freeze the array value object itself here, since
302 * internal stuff could need to modify/add attributes. Each
303 * attribute is frozen one by one.
304 */
305 for (i = 0; i < count; ++i) {
306 struct bt_value *obj = NULL;
307
308 obj = bt_attributes_borrow_field_value(
309 (void *) attr_obj, i);
310 if (!obj) {
311 BT_LIB_LOGE_APPEND_CAUSE(
312 "Cannot get attributes object's field value by index: "
313 "%![value-]+v, index=%" PRIu64,
314 attr_obj, i);
315 ret = -1;
316 goto end;
317 }
318
319 bt_value_freeze(obj);
320 }
321
322 end:
323 return ret;
324 }
This page took 0.037238 seconds and 4 git commands to generate.