lib: Fix function name to match declaration
[babeltrace.git] / lib / trace-ir / field-class.c
CommitLineData
939190b3 1/*
f2b0325d 2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
939190b3
PP
3 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
939190b3
PP
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 "FIELD-CLASSES"
25#include <babeltrace/lib-logging-internal.h>
26
27#include <babeltrace/assert-pre-internal.h>
0f15f666
PP
28#include <babeltrace/trace-ir/field-class.h>
29#include <babeltrace/trace-ir/field-class-const.h>
30#include <babeltrace/trace-ir/field-class-internal.h>
939190b3 31#include <babeltrace/trace-ir/field-path-internal.h>
0f15f666
PP
32#include <babeltrace/trace-ir/field-internal.h>
33#include <babeltrace/trace-ir/field-const.h>
34#include <babeltrace/trace-ir/field.h>
939190b3 35#include <babeltrace/trace-ir/utils-internal.h>
939190b3
PP
36#include <babeltrace/trace-ir/clock-class.h>
37#include <babeltrace/trace-ir/clock-class-internal.h>
38#include <babeltrace/object-internal.h>
939190b3
PP
39#include <babeltrace/compiler-internal.h>
40#include <babeltrace/endian-internal.h>
41#include <babeltrace/assert-internal.h>
42#include <babeltrace/compat/glib-internal.h>
43#include <float.h>
44#include <inttypes.h>
45#include <stdlib.h>
46
78cf9df6
PP
47enum bt_field_class_type bt_field_class_get_type(
48 const struct bt_field_class *fc)
939190b3
PP
49{
50 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 51 return fc->type;
939190b3
PP
52}
53
54static
af0c18e3 55void init_field_class(struct bt_field_class *fc, enum bt_field_class_type type,
939190b3
PP
56 bt_object_release_func release_func)
57{
58 BT_ASSERT(fc);
af0c18e3 59 BT_ASSERT(bt_field_class_has_known_type(fc));
939190b3
PP
60 BT_ASSERT(release_func);
61 bt_object_init_shared(&fc->base, release_func);
af0c18e3 62 fc->type = type;
939190b3
PP
63}
64
65static
af0c18e3
PP
66void init_integer_field_class(struct bt_field_class_integer *fc,
67 enum bt_field_class_type type,
939190b3
PP
68 bt_object_release_func release_func)
69{
af0c18e3 70 init_field_class((void *) fc, type, release_func);
939190b3
PP
71 fc->range = 64;
72 fc->base = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL;
73}
74
75static
76void destroy_integer_field_class(struct bt_object *obj)
77{
78 BT_ASSERT(obj);
9e550e5f 79 BT_LIB_LOGD("Destroying integer field class object: %!+F", obj);
939190b3
PP
80 g_free(obj);
81}
82
83static inline
b7396828
PP
84struct bt_field_class *create_integer_field_class(bt_trace_class *trace_class,
85 enum bt_field_class_type type)
939190b3
PP
86{
87 struct bt_field_class_integer *int_fc = NULL;
88
b7396828 89 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f 90 BT_LOGD("Creating default integer field class object: type=%s",
af0c18e3 91 bt_common_field_class_type_string(type));
939190b3
PP
92 int_fc = g_new0(struct bt_field_class_integer, 1);
93 if (!int_fc) {
9e550e5f 94 BT_LOGE_STR("Failed to allocate one integer field class.");
939190b3
PP
95 goto error;
96 }
97
af0c18e3 98 init_integer_field_class(int_fc, type, destroy_integer_field_class);
9e550e5f 99 BT_LIB_LOGD("Created integer field class object: %!+F", int_fc);
939190b3
PP
100 goto end;
101
102error:
8138bfe1 103 BT_OBJECT_PUT_REF_AND_RESET(int_fc);
939190b3
PP
104
105end:
106 return (void *) int_fc;
107}
108
b7396828
PP
109struct bt_field_class *bt_field_class_unsigned_integer_create(
110 bt_trace_class *trace_class)
939190b3 111{
b7396828 112 return create_integer_field_class(trace_class,
9e550e5f 113 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
939190b3
PP
114}
115
b7396828
PP
116struct bt_field_class *bt_field_class_signed_integer_create(
117 bt_trace_class *trace_class)
939190b3 118{
b7396828 119 return create_integer_field_class(trace_class,
9e550e5f 120 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
939190b3
PP
121}
122
123uint64_t bt_field_class_integer_get_field_value_range(
78cf9df6 124 const struct bt_field_class *fc)
939190b3 125{
78cf9df6 126 const struct bt_field_class_integer *int_fc = (const void *) fc;
939190b3
PP
127
128 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
129 BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
130 return int_fc->range;
131}
132
133BT_ASSERT_PRE_FUNC
134static
135bool size_is_valid_for_enumeration_field_class(struct bt_field_class *fc,
136 uint64_t size)
137{
138 // TODO
139 return true;
140}
141
78cf9df6
PP
142void bt_field_class_integer_set_field_value_range(
143 struct bt_field_class *fc, uint64_t size)
939190b3
PP
144{
145 struct bt_field_class_integer *int_fc = (void *) fc;
146
147 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
148 BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
149 BT_ASSERT_PRE_FC_HOT(fc, "Field class");
150 BT_ASSERT_PRE(size <= 64,
9e550e5f 151 "Unsupported size for integer field class's field value range "
939190b3 152 "(maximum is 64): size=%" PRIu64, size);
af0c18e3
PP
153 BT_ASSERT_PRE(
154 int_fc->common.type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
155 int_fc->common.type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
939190b3 156 size_is_valid_for_enumeration_field_class(fc, size),
9e550e5f 157 "Invalid field value range for enumeration field class: "
939190b3
PP
158 "at least one of the current mapping ranges contains values "
159 "which are outside this range: %!+F, size=%" PRIu64, fc, size);
160 int_fc->range = size;
9e550e5f 161 BT_LIB_LOGV("Set integer field class's field value range: %!+F", fc);
939190b3
PP
162}
163
164enum bt_field_class_integer_preferred_display_base
78cf9df6 165bt_field_class_integer_get_preferred_display_base(const struct bt_field_class *fc)
939190b3 166{
78cf9df6 167 const struct bt_field_class_integer *int_fc = (const void *) fc;
939190b3
PP
168
169 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
170 BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
171 return int_fc->base;
172}
173
78cf9df6
PP
174void bt_field_class_integer_set_preferred_display_base(
175 struct bt_field_class *fc,
939190b3
PP
176 enum bt_field_class_integer_preferred_display_base base)
177{
178 struct bt_field_class_integer *int_fc = (void *) fc;
179
180 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
181 BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
182 BT_ASSERT_PRE_FC_HOT(fc, "Field class");
183 int_fc->base = base;
9e550e5f 184 BT_LIB_LOGV("Set integer field class's preferred display base: %!+F", fc);
939190b3
PP
185}
186
187static
188void finalize_enumeration_field_class_mapping(
189 struct bt_field_class_enumeration_mapping *mapping)
190{
191 BT_ASSERT(mapping);
192
193 if (mapping->label) {
194 g_string_free(mapping->label, TRUE);
195 }
196
197 if (mapping->ranges) {
198 g_array_free(mapping->ranges, TRUE);
199 }
200}
201
202static
203void destroy_enumeration_field_class(struct bt_object *obj)
204{
205 struct bt_field_class_enumeration *fc = (void *) obj;
206
207 BT_ASSERT(fc);
9e550e5f 208 BT_LIB_LOGD("Destroying enumeration field class object: %!+F", fc);
939190b3
PP
209
210 if (fc->mappings) {
211 uint64_t i;
212
213 for (i = 0; i < fc->mappings->len; i++) {
214 finalize_enumeration_field_class_mapping(
215 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, i));
216 }
217
218 g_array_free(fc->mappings, TRUE);
1248f5ea 219 fc->mappings = NULL;
939190b3
PP
220 }
221
222 if (fc->label_buf) {
223 g_ptr_array_free(fc->label_buf, TRUE);
1248f5ea 224 fc->label_buf = NULL;
939190b3
PP
225 }
226
227 g_free(fc);
228}
229
230static
78cf9df6 231struct bt_field_class *create_enumeration_field_class(
b7396828 232 bt_trace_class *trace_class, enum bt_field_class_type type)
939190b3
PP
233{
234 struct bt_field_class_enumeration *enum_fc = NULL;
235
b7396828 236 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f 237 BT_LOGD("Creating default enumeration field class object: type=%s",
af0c18e3 238 bt_common_field_class_type_string(type));
939190b3
PP
239 enum_fc = g_new0(struct bt_field_class_enumeration, 1);
240 if (!enum_fc) {
9e550e5f 241 BT_LOGE_STR("Failed to allocate one enumeration field class.");
939190b3
PP
242 goto error;
243 }
244
af0c18e3 245 init_integer_field_class((void *) enum_fc, type,
939190b3
PP
246 destroy_enumeration_field_class);
247 enum_fc->mappings = g_array_new(FALSE, TRUE,
248 sizeof(struct bt_field_class_enumeration_mapping));
249 if (!enum_fc->mappings) {
250 BT_LOGE_STR("Failed to allocate a GArray.");
251 goto error;
252 }
253
254 enum_fc->label_buf = g_ptr_array_new();
255 if (!enum_fc->label_buf) {
256 BT_LOGE_STR("Failed to allocate a GArray.");
257 goto error;
258 }
259
9e550e5f 260 BT_LIB_LOGD("Created enumeration field class object: %!+F", enum_fc);
939190b3
PP
261 goto end;
262
263error:
8138bfe1 264 BT_OBJECT_PUT_REF_AND_RESET(enum_fc);
939190b3
PP
265
266end:
267 return (void *) enum_fc;
268}
269
b7396828
PP
270struct bt_field_class *bt_field_class_unsigned_enumeration_create(
271 bt_trace_class *trace_class)
939190b3 272{
b7396828 273 return create_enumeration_field_class(trace_class,
af0c18e3 274 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
939190b3
PP
275}
276
b7396828
PP
277struct bt_field_class *bt_field_class_signed_enumeration_create(
278 bt_trace_class *trace_class)
939190b3 279{
b7396828 280 return create_enumeration_field_class(trace_class,
af0c18e3 281 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
939190b3
PP
282}
283
78cf9df6
PP
284uint64_t bt_field_class_enumeration_get_mapping_count(
285 const struct bt_field_class *fc)
939190b3 286{
78cf9df6 287 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
939190b3
PP
288
289 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
290 BT_ASSERT_PRE_FC_IS_ENUM(fc, "Field class");
291 return (uint64_t) enum_fc->mappings->len;
292}
293
78cf9df6
PP
294void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
295 const struct bt_field_class *fc, uint64_t index,
939190b3 296 const char **name,
78cf9df6 297 const struct bt_field_class_unsigned_enumeration_mapping_ranges **ranges)
939190b3 298{
78cf9df6
PP
299 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
300 const struct bt_field_class_enumeration_mapping *mapping;
939190b3
PP
301
302 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
303 BT_ASSERT_PRE_NON_NULL(name, "Name (output)");
304 BT_ASSERT_PRE_NON_NULL(ranges, "Ranges (output)");
305 BT_ASSERT_PRE_VALID_INDEX(index, enum_fc->mappings->len);
af0c18e3 306 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
939190b3
PP
307 "Field class");
308 mapping = BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index);
309 *name = mapping->label->str;
310 *ranges = (void *) mapping;
311}
312
78cf9df6
PP
313void bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
314 const struct bt_field_class *fc, uint64_t index,
939190b3 315 const char **name,
78cf9df6 316 const struct bt_field_class_signed_enumeration_mapping_ranges **ranges)
939190b3 317{
78cf9df6
PP
318 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
319 const struct bt_field_class_enumeration_mapping *mapping;
939190b3
PP
320
321 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
322 BT_ASSERT_PRE_NON_NULL(name, "Name (output)");
323 BT_ASSERT_PRE_NON_NULL(ranges, "Ranges (output)");
324 BT_ASSERT_PRE_VALID_INDEX(index, enum_fc->mappings->len);
af0c18e3 325 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
939190b3
PP
326 "Field class");
327 mapping = BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index);
328 *name = mapping->label->str;
329 *ranges = (void *) mapping;
330}
331
332static inline
333uint64_t get_enumeration_field_class_mapping_range_count(
78cf9df6 334 const struct bt_field_class_enumeration_mapping *mapping)
939190b3
PP
335{
336 BT_ASSERT_PRE_NON_NULL(mapping, "Ranges");
337 return (uint64_t) mapping->ranges->len;
338}
339
340uint64_t bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count(
78cf9df6 341 const struct bt_field_class_unsigned_enumeration_mapping_ranges *ranges)
939190b3 342{
78cf9df6
PP
343 return get_enumeration_field_class_mapping_range_count(
344 (const void *) ranges);
939190b3
PP
345}
346
347uint64_t bt_field_class_signed_enumeration_mapping_ranges_get_range_count(
78cf9df6 348 const struct bt_field_class_signed_enumeration_mapping_ranges *ranges)
939190b3 349{
78cf9df6
PP
350 return get_enumeration_field_class_mapping_range_count(
351 (const void *) ranges);
939190b3
PP
352}
353
354static inline
355void get_enumeration_field_class_mapping_range_at_index(
78cf9df6 356 const struct bt_field_class_enumeration_mapping *mapping,
939190b3
PP
357 uint64_t index, uint64_t *lower, uint64_t *upper)
358{
78cf9df6 359 const struct bt_field_class_enumeration_mapping_range *range;
939190b3
PP
360
361 BT_ASSERT_PRE_NON_NULL(mapping, "Ranges");
362 BT_ASSERT_PRE_NON_NULL(lower, "Range's lower (output)");
363 BT_ASSERT_PRE_NON_NULL(upper, "Range's upper (output)");
364 BT_ASSERT_PRE_VALID_INDEX(index, mapping->ranges->len);
365 range = BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(mapping, index);
366 *lower = range->lower.u;
367 *upper = range->upper.u;
368}
369
370void bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index(
78cf9df6 371 const struct bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
939190b3
PP
372 uint64_t index, uint64_t *lower, uint64_t *upper)
373{
78cf9df6
PP
374 get_enumeration_field_class_mapping_range_at_index(
375 (const void *) ranges, index, lower, upper);
939190b3
PP
376}
377
378void bt_field_class_signed_enumeration_mapping_ranges_get_range_by_index(
2d95225e 379 const struct bt_field_class_signed_enumeration_mapping_ranges *ranges,
939190b3
PP
380 uint64_t index, int64_t *lower, int64_t *upper)
381{
78cf9df6
PP
382 get_enumeration_field_class_mapping_range_at_index(
383 (const void *) ranges, index,
384 (uint64_t *) lower, (uint64_t *) upper);
939190b3
PP
385}
386
387
388
4b514ab3
PP
389enum bt_field_class_status
390bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
78cf9df6 391 const struct bt_field_class *fc, uint64_t value,
939190b3
PP
392 bt_field_class_enumeration_mapping_label_array *label_array,
393 uint64_t *count)
394{
78cf9df6 395 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
939190b3
PP
396 uint64_t i;
397
398 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
399 BT_ASSERT_PRE_NON_NULL(label_array, "Label array (output)");
400 BT_ASSERT_PRE_NON_NULL(count, "Count (output)");
af0c18e3 401 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
939190b3
PP
402 "Field class");
403 g_ptr_array_set_size(enum_fc->label_buf, 0);
404
405 for (i = 0; i < enum_fc->mappings->len; i++) {
406 uint64_t j;
78cf9df6 407 const struct bt_field_class_enumeration_mapping *mapping =
939190b3
PP
408 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
409
410 for (j = 0; j < mapping->ranges->len; j++) {
78cf9df6 411 const struct bt_field_class_enumeration_mapping_range *range =
939190b3
PP
412 BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(
413 mapping, j);
414
415 if (value >= range->lower.u &&
416 value <= range->upper.u) {
417 g_ptr_array_add(enum_fc->label_buf,
418 mapping->label->str);
419 break;
420 }
421 }
422 }
423
424 *label_array = (void *) enum_fc->label_buf->pdata;
425 *count = (uint64_t) enum_fc->label_buf->len;
4b514ab3 426 return BT_FIELD_CLASS_STATUS_OK;
939190b3
PP
427}
428
4b514ab3
PP
429enum bt_field_class_status
430bt_field_class_signed_enumeration_get_mapping_labels_by_value(
78cf9df6 431 const struct bt_field_class *fc, int64_t value,
939190b3
PP
432 bt_field_class_enumeration_mapping_label_array *label_array,
433 uint64_t *count)
434{
78cf9df6 435 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
939190b3
PP
436 uint64_t i;
437
438 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
439 BT_ASSERT_PRE_NON_NULL(label_array, "Label array (output)");
440 BT_ASSERT_PRE_NON_NULL(count, "Count (output)");
af0c18e3 441 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
939190b3
PP
442 "Field class");
443 g_ptr_array_set_size(enum_fc->label_buf, 0);
444
445 for (i = 0; i < enum_fc->mappings->len; i++) {
446 uint64_t j;
78cf9df6 447 const struct bt_field_class_enumeration_mapping *mapping =
939190b3
PP
448 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
449
450 for (j = 0; j < mapping->ranges->len; j++) {
78cf9df6 451 const struct bt_field_class_enumeration_mapping_range *range =
939190b3
PP
452 BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(
453 mapping, j);
454
455 if (value >= range->lower.i &&
456 value <= range->upper.i) {
457 g_ptr_array_add(enum_fc->label_buf,
458 mapping->label->str);
459 break;
460 }
461 }
462 }
463
464 *label_array = (void *) enum_fc->label_buf->pdata;
465 *count = (uint64_t) enum_fc->label_buf->len;
4b514ab3 466 return BT_FIELD_CLASS_STATUS_OK;
939190b3
PP
467}
468
469static inline
4b514ab3
PP
470enum bt_field_class_status add_mapping_to_enumeration_field_class(
471 struct bt_field_class *fc,
939190b3
PP
472 const char *label, uint64_t lower, uint64_t upper)
473{
4b514ab3 474 int ret = BT_FIELD_CLASS_STATUS_OK;
939190b3
PP
475 uint64_t i;
476 struct bt_field_class_enumeration *enum_fc = (void *) fc;
477 struct bt_field_class_enumeration_mapping *mapping = NULL;
478 struct bt_field_class_enumeration_mapping_range *range;
479
480 BT_ASSERT(fc);
481 BT_ASSERT_PRE_NON_NULL(label, "Label");
482
483 /* Find existing mapping identified by this label */
484 for (i = 0; i < enum_fc->mappings->len; i++) {
485 struct bt_field_class_enumeration_mapping *mapping_candidate =
486 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
487
488 if (strcmp(mapping_candidate->label->str, label) == 0) {
489 mapping = mapping_candidate;
490 break;
491 }
492 }
493
494 if (!mapping) {
495 /* Create new mapping for this label */
496 g_array_set_size(enum_fc->mappings, enum_fc->mappings->len + 1);
497 mapping = BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc,
498 enum_fc->mappings->len - 1);
499 mapping->ranges = g_array_new(FALSE, TRUE,
500 sizeof(struct bt_field_class_enumeration_mapping_range));
501 if (!mapping->ranges) {
502 finalize_enumeration_field_class_mapping(mapping);
503 g_array_set_size(enum_fc->mappings,
504 enum_fc->mappings->len - 1);
4b514ab3 505 ret = BT_FIELD_CLASS_STATUS_NOMEM;
939190b3
PP
506 goto end;
507 }
508
509 mapping->label = g_string_new(label);
510 if (!mapping->label) {
511 finalize_enumeration_field_class_mapping(mapping);
512 g_array_set_size(enum_fc->mappings,
513 enum_fc->mappings->len - 1);
4b514ab3 514 ret = BT_FIELD_CLASS_STATUS_NOMEM;
939190b3
PP
515 goto end;
516 }
517 }
518
519 /* Add range */
520 BT_ASSERT(mapping);
521 g_array_set_size(mapping->ranges, mapping->ranges->len + 1);
522 range = BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(mapping,
523 mapping->ranges->len - 1);
524 range->lower.u = lower;
525 range->upper.u = upper;
9e550e5f 526 BT_LIB_LOGV("Added mapping to enumeration field class: "
939190b3
PP
527 "%![fc-]+F, label=\"%s\", lower-unsigned=%" PRIu64 ", "
528 "upper-unsigned=%" PRIu64, fc, label, lower, upper);
529
530end:
531 return ret;
532}
533
4b514ab3 534enum bt_field_class_status bt_field_class_unsigned_enumeration_map_range(
78cf9df6 535 struct bt_field_class *fc, const char *label,
939190b3
PP
536 uint64_t range_lower, uint64_t range_upper)
537{
538 struct bt_field_class_enumeration *enum_fc = (void *) fc;
539
540 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 541 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
939190b3
PP
542 "Field class");
543 BT_ASSERT_PRE(range_lower <= range_upper,
544 "Range's upper bound is less than lower bound: "
545 "upper=%" PRIu64 ", lower=%" PRIu64,
546 range_lower, range_upper);
547 BT_ASSERT_PRE(bt_util_value_is_in_range_unsigned(enum_fc->common.range,
548 range_lower),
9e550e5f 549 "Range's lower bound is outside the enumeration field class's value range: "
939190b3
PP
550 "%![fc-]+F, lower=%" PRIu64, fc, range_lower);
551 BT_ASSERT_PRE(bt_util_value_is_in_range_unsigned(enum_fc->common.range,
552 range_upper),
9e550e5f 553 "Range's upper bound is outside the enumeration field class's value range: "
939190b3
PP
554 "%![fc-]+F, upper=%" PRIu64, fc, range_upper);
555 return add_mapping_to_enumeration_field_class(fc, label, range_lower,
556 range_upper);
557}
558
4b514ab3 559enum bt_field_class_status bt_field_class_signed_enumeration_map_range(
78cf9df6 560 struct bt_field_class *fc, const char *label,
939190b3
PP
561 int64_t range_lower, int64_t range_upper)
562{
563 struct bt_field_class_enumeration *enum_fc = (void *) fc;
564
565 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 566 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
939190b3
PP
567 "Field class");
568 BT_ASSERT_PRE(range_lower <= range_upper,
569 "Range's upper bound is less than lower bound: "
570 "upper=%" PRId64 ", lower=%" PRId64,
571 range_lower, range_upper);
572 BT_ASSERT_PRE(bt_util_value_is_in_range_signed(enum_fc->common.range,
573 range_lower),
9e550e5f 574 "Range's lower bound is outside the enumeration field class's value range: "
939190b3
PP
575 "%![fc-]+F, lower=%" PRId64, fc, range_lower);
576 BT_ASSERT_PRE(bt_util_value_is_in_range_signed(enum_fc->common.range,
577 range_upper),
9e550e5f 578 "Range's upper bound is outside the enumeration field class's value range: "
939190b3
PP
579 "%![fc-]+F, upper=%" PRId64, fc, range_upper);
580 return add_mapping_to_enumeration_field_class(fc, label, range_lower,
581 range_upper);
582}
583
584static
585void destroy_real_field_class(struct bt_object *obj)
586{
587 BT_ASSERT(obj);
9e550e5f 588 BT_LIB_LOGD("Destroying real field class object: %!+F", obj);
939190b3
PP
589 g_free(obj);
590}
591
b7396828 592struct bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class)
939190b3
PP
593{
594 struct bt_field_class_real *real_fc = NULL;
595
b7396828 596 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f 597 BT_LOGD_STR("Creating default real field class object.");
939190b3
PP
598 real_fc = g_new0(struct bt_field_class_real, 1);
599 if (!real_fc) {
9e550e5f 600 BT_LOGE_STR("Failed to allocate one real field class.");
939190b3
PP
601 goto error;
602 }
603
af0c18e3 604 init_field_class((void *) real_fc, BT_FIELD_CLASS_TYPE_REAL,
939190b3 605 destroy_real_field_class);
9e550e5f 606 BT_LIB_LOGD("Created real field class object: %!+F", real_fc);
939190b3
PP
607 goto end;
608
609error:
8138bfe1 610 BT_OBJECT_PUT_REF_AND_RESET(real_fc);
939190b3
PP
611
612end:
613 return (void *) real_fc;
614}
615
78cf9df6 616bt_bool bt_field_class_real_is_single_precision(const struct bt_field_class *fc)
939190b3 617{
78cf9df6 618 const struct bt_field_class_real *real_fc = (const void *) fc;
939190b3
PP
619
620 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 621 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_REAL, "Field class");
939190b3
PP
622 return real_fc->is_single_precision;
623}
624
78cf9df6 625void bt_field_class_real_set_is_single_precision(struct bt_field_class *fc,
939190b3
PP
626 bt_bool is_single_precision)
627{
628 struct bt_field_class_real *real_fc = (void *) fc;
629
630 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 631 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_REAL, "Field class");
939190b3
PP
632 BT_ASSERT_PRE_FC_HOT(fc, "Field class");
633 real_fc->is_single_precision = (bool) is_single_precision;
9e550e5f 634 BT_LIB_LOGV("Set real field class's \"is single precision\" property: "
939190b3 635 "%!+F", fc);
939190b3
PP
636}
637
638static
639int init_named_field_classes_container(
640 struct bt_field_class_named_field_class_container *fc,
78cf9df6
PP
641 enum bt_field_class_type type,
642 bt_object_release_func release_func)
939190b3
PP
643{
644 int ret = 0;
645
af0c18e3 646 init_field_class((void *) fc, type, release_func);
939190b3
PP
647 fc->named_fcs = g_array_new(FALSE, TRUE,
648 sizeof(struct bt_named_field_class));
649 if (!fc->named_fcs) {
650 BT_LOGE_STR("Failed to allocate a GArray.");
651 ret = -1;
652 goto end;
653 }
654
655 fc->name_to_index = g_hash_table_new(g_str_hash, g_str_equal);
656 if (!fc->name_to_index) {
657 BT_LOGE_STR("Failed to allocate a GHashTable.");
658 ret = -1;
659 goto end;
660 }
661
662end:
663 return ret;
664}
665
666static
667void finalize_named_field_class(struct bt_named_field_class *named_fc)
668{
669 BT_ASSERT(named_fc);
9e550e5f 670 BT_LIB_LOGD("Finalizing named field class: "
939190b3
PP
671 "addr=%p, name=\"%s\", %![fc-]+F",
672 named_fc, named_fc->name ? named_fc->name->str : NULL,
673 named_fc->fc);
674
675 if (named_fc->name) {
676 g_string_free(named_fc->name, TRUE);
677 }
678
9e550e5f 679 BT_LOGD_STR("Putting named field class's field class.");
1248f5ea 680 BT_OBJECT_PUT_REF_AND_RESET(named_fc->fc);
939190b3
PP
681}
682
683static
684void finalize_named_field_classes_container(
685 struct bt_field_class_named_field_class_container *fc)
686{
687 uint64_t i;
688
689 BT_ASSERT(fc);
690
691 if (fc->named_fcs) {
692 for (i = 0; i < fc->named_fcs->len; i++) {
693 finalize_named_field_class(
694 &g_array_index(fc->named_fcs,
695 struct bt_named_field_class, i));
696 }
697
698 g_array_free(fc->named_fcs, TRUE);
699 }
700
701 if (fc->name_to_index) {
702 g_hash_table_destroy(fc->name_to_index);
703 }
704}
705
706static
707void destroy_structure_field_class(struct bt_object *obj)
708{
709 BT_ASSERT(obj);
2d95225e 710 BT_LIB_LOGD("Destroying structure field class object: %!+F", obj);
939190b3
PP
711 finalize_named_field_classes_container((void *) obj);
712 g_free(obj);
713}
714
b7396828
PP
715struct bt_field_class *bt_field_class_structure_create(
716 bt_trace_class *trace_class)
939190b3
PP
717{
718 int ret;
719 struct bt_field_class_structure *struct_fc = NULL;
720
b7396828 721 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f 722 BT_LOGD_STR("Creating default structure field class object.");
939190b3
PP
723 struct_fc = g_new0(struct bt_field_class_structure, 1);
724 if (!struct_fc) {
9e550e5f 725 BT_LOGE_STR("Failed to allocate one structure field class.");
939190b3
PP
726 goto error;
727 }
728
729 ret = init_named_field_classes_container((void *) struct_fc,
af0c18e3 730 BT_FIELD_CLASS_TYPE_STRUCTURE, destroy_structure_field_class);
939190b3
PP
731 if (ret) {
732 goto error;
733 }
734
9e550e5f 735 BT_LIB_LOGD("Created structure field class object: %!+F", struct_fc);
939190b3
PP
736 goto end;
737
738error:
8138bfe1 739 BT_OBJECT_PUT_REF_AND_RESET(struct_fc);
939190b3
PP
740
741end:
742 return (void *) struct_fc;
743}
744
745static
4b514ab3 746enum bt_field_class_status append_named_field_class_to_container_field_class(
939190b3
PP
747 struct bt_field_class_named_field_class_container *container_fc,
748 const char *name, struct bt_field_class *fc)
749{
4b514ab3 750 int ret = BT_FIELD_CLASS_STATUS_OK;
939190b3
PP
751 struct bt_named_field_class *named_fc;
752 GString *name_str;
753
754 BT_ASSERT(container_fc);
755 BT_ASSERT_PRE_FC_HOT(container_fc, "Field class");
756 BT_ASSERT_PRE_NON_NULL(name, "Name");
757 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
758 BT_ASSERT_PRE(!bt_g_hash_table_contains(container_fc->name_to_index,
759 name),
9e550e5f 760 "Duplicate member/option name in structure/variant field class: "
939190b3
PP
761 "%![container-fc-]+F, name=\"%s\"", container_fc, name);
762 name_str = g_string_new(name);
763 if (!name_str) {
764 BT_LOGE_STR("Failed to allocate a GString.");
4b514ab3 765 ret = BT_FIELD_CLASS_STATUS_NOMEM;
939190b3
PP
766 goto end;
767 }
768
769 g_array_set_size(container_fc->named_fcs,
770 container_fc->named_fcs->len + 1);
771 named_fc = &g_array_index(container_fc->named_fcs,
772 struct bt_named_field_class, container_fc->named_fcs->len - 1);
773 named_fc->name = name_str;
4b70020d
PP
774 named_fc->fc = fc;
775 bt_object_get_no_null_check(fc);
939190b3
PP
776 g_hash_table_insert(container_fc->name_to_index, named_fc->name->str,
777 GUINT_TO_POINTER(container_fc->named_fcs->len - 1));
e24f271a
PP
778
779 /*
780 * Freeze the field class, but not the named field class (the
781 * user can still modify it, if possible, until the container
782 * itself is frozen).
783 */
939190b3
PP
784 bt_field_class_freeze(fc);
785
786end:
787 return ret;
788}
789
4b514ab3
PP
790enum bt_field_class_status bt_field_class_structure_append_member(
791 struct bt_field_class *fc, const char *name,
792 struct bt_field_class *member_fc)
939190b3 793{
9e550e5f 794
939190b3 795 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
909d0a89
PP
796 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
797 "Field class");
939190b3 798 return append_named_field_class_to_container_field_class((void *) fc,
78cf9df6 799 name, member_fc);
939190b3
PP
800}
801
78cf9df6
PP
802uint64_t bt_field_class_structure_get_member_count(
803 const struct bt_field_class *fc)
939190b3
PP
804{
805 struct bt_field_class_structure *struct_fc = (void *) fc;
806
807 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
909d0a89
PP
808 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
809 "Field class");
939190b3
PP
810 return (uint64_t) struct_fc->common.named_fcs->len;
811}
812
813static
e24f271a
PP
814struct bt_named_field_class *
815borrow_named_field_class_from_container_field_class_at_index(
909d0a89 816 struct bt_field_class_named_field_class_container *fc,
e24f271a 817 uint64_t index)
939190b3 818{
939190b3 819 BT_ASSERT(fc);
939190b3 820 BT_ASSERT_PRE_VALID_INDEX(index, fc->named_fcs->len);
e24f271a 821 return BT_FIELD_CLASS_NAMED_FC_AT_INDEX(fc, index);
939190b3
PP
822}
823
e24f271a
PP
824const struct bt_field_class_structure_member *
825bt_field_class_structure_borrow_member_by_index_const(
826 const struct bt_field_class *fc, uint64_t index)
939190b3
PP
827{
828 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
909d0a89
PP
829 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
830 "Field class");
e24f271a
PP
831 return (const void *)
832 borrow_named_field_class_from_container_field_class_at_index(
833 (void *) fc, index);
909d0a89
PP
834}
835
e24f271a
PP
836struct bt_field_class_structure_member *
837bt_field_class_structure_borrow_member_by_index(
838 struct bt_field_class *fc, uint64_t index)
909d0a89
PP
839{
840 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
841 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
842 "Field class");
e24f271a
PP
843 return (void *)
844 borrow_named_field_class_from_container_field_class_at_index(
845 (void *) fc, index);
9e550e5f
PP
846}
847
939190b3 848static
e24f271a
PP
849struct bt_named_field_class *
850borrow_named_field_class_from_container_field_class_by_name(
909d0a89 851 struct bt_field_class_named_field_class_container *fc,
939190b3
PP
852 const char *name)
853{
e24f271a 854 struct bt_named_field_class *named_fc = NULL;
939190b3
PP
855 gpointer orig_key;
856 gpointer value;
857
858 BT_ASSERT(fc);
859 BT_ASSERT_PRE_NON_NULL(name, "Name");
860 if (!g_hash_table_lookup_extended(fc->name_to_index, name, &orig_key,
861 &value)) {
862 goto end;
863 }
864
865 named_fc = BT_FIELD_CLASS_NAMED_FC_AT_INDEX(fc,
866 GPOINTER_TO_UINT(value));
939190b3
PP
867
868end:
e24f271a 869 return named_fc;
939190b3
PP
870}
871
e24f271a 872const struct bt_field_class_structure_member *
c0db9072 873bt_field_class_structure_borrow_member_by_name_const(
78cf9df6 874 const struct bt_field_class *fc, const char *name)
939190b3
PP
875{
876 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
909d0a89
PP
877 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
878 "Field class");
e24f271a
PP
879 return (const void *)
880 borrow_named_field_class_from_container_field_class_by_name(
909d0a89
PP
881 (void *) fc, name);
882}
883
e24f271a 884struct bt_field_class_structure_member *
fe65b1fe 885bt_field_class_structure_borrow_member_by_name(
909d0a89
PP
886 struct bt_field_class *fc, const char *name)
887{
888 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
889 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
890 "Field class");
e24f271a
PP
891 return (void *)
892 borrow_named_field_class_from_container_field_class_by_name(
78cf9df6 893 (void *) fc, name);
9e550e5f
PP
894}
895
e24f271a
PP
896const char *bt_field_class_structure_member_get_name(
897 const struct bt_field_class_structure_member *member)
898{
899 const struct bt_named_field_class *named_fc = (const void *) member;
900
901 BT_ASSERT_PRE_NON_NULL(member, "Structure field class member");
902 return named_fc->name->str;
903}
904
905const struct bt_field_class *
906bt_field_class_structure_member_borrow_field_class_const(
907 const struct bt_field_class_structure_member *member)
908{
909 const struct bt_named_field_class *named_fc = (const void *) member;
910
911 BT_ASSERT_PRE_NON_NULL(member, "Structure field class member");
912 return named_fc->fc;
913}
914
915struct bt_field_class *
916bt_field_class_structure_member_borrow_field_class(
917 struct bt_field_class_structure_member *member)
918{
919 struct bt_named_field_class *named_fc = (void *) member;
920
921 BT_ASSERT_PRE_NON_NULL(member, "Structure field class member");
922 return named_fc->fc;
923}
924
939190b3
PP
925static
926void destroy_variant_field_class(struct bt_object *obj)
927{
928 struct bt_field_class_variant *fc = (void *) obj;
929
930 BT_ASSERT(fc);
9e550e5f 931 BT_LIB_LOGD("Destroying variant field class object: %!+F", fc);
939190b3
PP
932 finalize_named_field_classes_container((void *) fc);
933 BT_LOGD_STR("Putting selector field path.");
1248f5ea
PP
934 BT_OBJECT_PUT_REF_AND_RESET(fc->selector_field_path);
935 BT_LOGD_STR("Putting selector field class.");
936 BT_OBJECT_PUT_REF_AND_RESET(fc->selector_fc);
939190b3
PP
937 g_free(fc);
938}
939
b7396828
PP
940struct bt_field_class *bt_field_class_variant_create(
941 bt_trace_class *trace_class)
939190b3
PP
942{
943 int ret;
944 struct bt_field_class_variant *var_fc = NULL;
945
b7396828 946 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f 947 BT_LOGD_STR("Creating default variant field class object.");
939190b3
PP
948 var_fc = g_new0(struct bt_field_class_variant, 1);
949 if (!var_fc) {
9e550e5f 950 BT_LOGE_STR("Failed to allocate one variant field class.");
939190b3
PP
951 goto error;
952 }
953
954 ret = init_named_field_classes_container((void *) var_fc,
af0c18e3 955 BT_FIELD_CLASS_TYPE_VARIANT, destroy_variant_field_class);
939190b3
PP
956 if (ret) {
957 goto error;
958 }
959
9e550e5f 960 BT_LIB_LOGD("Created variant field class object: %!+F", var_fc);
939190b3
PP
961 goto end;
962
963error:
8138bfe1 964 BT_OBJECT_PUT_REF_AND_RESET(var_fc);
939190b3
PP
965
966end:
967 return (void *) var_fc;
968}
969
4b514ab3 970enum bt_field_class_status bt_field_class_variant_set_selector_field_class(
78cf9df6
PP
971 struct bt_field_class *fc,
972 struct bt_field_class *selector_fc)
939190b3
PP
973{
974 struct bt_field_class_variant *var_fc = (void *) fc;
975
9e550e5f
PP
976 BT_ASSERT_PRE_NON_NULL(fc, "Variant field class");
977 BT_ASSERT_PRE_NON_NULL(selector_fc, "Selector field class");
af0c18e3 978 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class");
9e550e5f
PP
979 BT_ASSERT_PRE_FC_IS_ENUM(selector_fc, "Selector field class");
980 BT_ASSERT_PRE_FC_HOT(fc, "Variant field class");
78cf9df6 981 var_fc->selector_fc = selector_fc;
4b70020d 982 bt_object_get_no_null_check(selector_fc);
78cf9df6 983 bt_field_class_freeze(selector_fc);
4b514ab3 984 return BT_FIELD_CLASS_STATUS_OK;
939190b3
PP
985}
986
4b514ab3 987enum bt_field_class_status bt_field_class_variant_append_option(
78cf9df6
PP
988 struct bt_field_class *fc,
989 const char *name, struct bt_field_class *option_fc)
939190b3 990{
9e550e5f 991
939190b3 992 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 993 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class");
939190b3 994 return append_named_field_class_to_container_field_class((void *) fc,
78cf9df6 995 name, option_fc);
939190b3
PP
996}
997
e24f271a 998const struct bt_field_class_variant_option *
c0db9072 999bt_field_class_variant_borrow_option_by_name_const(
78cf9df6 1000 const struct bt_field_class *fc, const char *name)
939190b3
PP
1001{
1002 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 1003 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class");
e24f271a
PP
1004 return (const void *)
1005 borrow_named_field_class_from_container_field_class_by_name(
1006 (void *) fc, name);
909d0a89
PP
1007}
1008
e24f271a 1009struct bt_field_class_variant_option *
c0db9072 1010bt_field_class_variant_borrow_option_by_name(
909d0a89
PP
1011 struct bt_field_class *fc, const char *name)
1012{
1013 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1014 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class");
e24f271a
PP
1015 return (void *)
1016 borrow_named_field_class_from_container_field_class_by_name(
1017 (void *) fc, name);
9e550e5f
PP
1018}
1019
78cf9df6 1020uint64_t bt_field_class_variant_get_option_count(const struct bt_field_class *fc)
939190b3 1021{
78cf9df6 1022 const struct bt_field_class_variant *var_fc = (const void *) fc;
939190b3
PP
1023
1024 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 1025 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class");
939190b3
PP
1026 return (uint64_t) var_fc->common.named_fcs->len;
1027}
1028
e24f271a
PP
1029const struct bt_field_class_variant_option *
1030bt_field_class_variant_borrow_option_by_index_const(
1031 const struct bt_field_class *fc, uint64_t index)
939190b3
PP
1032{
1033 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 1034 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class");
e24f271a
PP
1035 return (const void *)
1036 borrow_named_field_class_from_container_field_class_at_index(
1037 (void *) fc, index);
909d0a89
PP
1038}
1039
e24f271a
PP
1040struct bt_field_class_variant_option *
1041bt_field_class_variant_borrow_option_by_index(
1042 struct bt_field_class *fc, uint64_t index)
909d0a89
PP
1043{
1044 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1045 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT, "Field class");
e24f271a
PP
1046 return (void *)
1047 borrow_named_field_class_from_container_field_class_at_index(
1048 (void *) fc, index);
1049}
1050
1051const char *bt_field_class_variant_option_get_name(
1052 const struct bt_field_class_variant_option *option)
1053{
1054 const struct bt_named_field_class *named_fc = (const void *) option;
1055
1056 BT_ASSERT_PRE_NON_NULL(option, "Variant field class option");
1057 return named_fc->name->str;
1058}
1059
1060const struct bt_field_class *
1061bt_field_class_variant_option_borrow_field_class_const(
1062 const struct bt_field_class_variant_option *option)
1063{
1064 const struct bt_named_field_class *named_fc = (const void *) option;
1065
1066 BT_ASSERT_PRE_NON_NULL(option, "Variant field class option");
1067 return named_fc->fc;
1068}
1069
1070struct bt_field_class *
1071bt_field_class_variant_option_borrow_field_class(
1072 struct bt_field_class_variant_option *option)
1073{
1074 struct bt_named_field_class *named_fc = (void *) option;
1075
1076 BT_ASSERT_PRE_NON_NULL(option, "Variant field class option");
1077 return named_fc->fc;
939190b3
PP
1078}
1079
78cf9df6
PP
1080const struct bt_field_path *
1081bt_field_class_variant_borrow_selector_field_path_const(
1082 const struct bt_field_class *fc)
9e550e5f 1083{
78cf9df6 1084 const struct bt_field_class_variant *var_fc = (const void *) fc;
939190b3
PP
1085
1086 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 1087 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_VARIANT,
939190b3
PP
1088 "Field class");
1089 return var_fc->selector_field_path;
1090}
1091
1092static
1093void init_array_field_class(struct bt_field_class_array *fc,
af0c18e3 1094 enum bt_field_class_type type, bt_object_release_func release_func,
939190b3
PP
1095 struct bt_field_class *element_fc)
1096{
1097 BT_ASSERT(element_fc);
af0c18e3 1098 init_field_class((void *) fc, type, release_func);
4b70020d
PP
1099 fc->element_fc = element_fc;
1100 bt_object_get_no_null_check(element_fc);
939190b3
PP
1101 bt_field_class_freeze(element_fc);
1102}
1103
1104static
1105void finalize_array_field_class(struct bt_field_class_array *array_fc)
1106{
1107 BT_ASSERT(array_fc);
9e550e5f 1108 BT_LOGD_STR("Putting element field class.");
1248f5ea 1109 BT_OBJECT_PUT_REF_AND_RESET(array_fc->element_fc);
939190b3
PP
1110}
1111
1112static
1113void destroy_static_array_field_class(struct bt_object *obj)
1114{
1115 BT_ASSERT(obj);
9e550e5f 1116 BT_LIB_LOGD("Destroying static array field class object: %!+F", obj);
939190b3
PP
1117 finalize_array_field_class((void *) obj);
1118 g_free(obj);
1119}
1120
78cf9df6 1121struct bt_field_class *
b7396828
PP
1122bt_field_class_static_array_create(bt_trace_class *trace_class,
1123 struct bt_field_class *element_fc, uint64_t length)
939190b3
PP
1124{
1125 struct bt_field_class_static_array *array_fc = NULL;
1126
b7396828 1127 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f
PP
1128 BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
1129 BT_LOGD_STR("Creating default static array field class object.");
939190b3
PP
1130 array_fc = g_new0(struct bt_field_class_static_array, 1);
1131 if (!array_fc) {
9e550e5f 1132 BT_LOGE_STR("Failed to allocate one static array field class.");
939190b3
PP
1133 goto error;
1134 }
1135
af0c18e3 1136 init_array_field_class((void *) array_fc, BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
939190b3
PP
1137 destroy_static_array_field_class, element_fc);
1138 array_fc->length = length;
9e550e5f 1139 BT_LIB_LOGD("Created static array field class object: %!+F", array_fc);
939190b3
PP
1140 goto end;
1141
1142error:
8138bfe1 1143 BT_OBJECT_PUT_REF_AND_RESET(array_fc);
939190b3
PP
1144
1145end:
1146 return (void *) array_fc;
1147}
1148
78cf9df6
PP
1149const struct bt_field_class *
1150bt_field_class_array_borrow_element_field_class_const(
1151 const struct bt_field_class *fc)
939190b3 1152{
78cf9df6 1153 const struct bt_field_class_array *array_fc = (const void *) fc;
939190b3
PP
1154
1155 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1156 BT_ASSERT_PRE_FC_IS_ARRAY(fc, "Field class");
1157 return array_fc->element_fc;
1158}
1159
909d0a89
PP
1160struct bt_field_class *
1161bt_field_class_array_borrow_element_field_class(struct bt_field_class *fc)
1162{
1163 struct bt_field_class_array *array_fc = (void *) fc;
1164
1165 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1166 BT_ASSERT_PRE_FC_IS_ARRAY(fc, "Field class");
1167 return array_fc->element_fc;
1168}
1169
78cf9df6 1170uint64_t bt_field_class_static_array_get_length(const struct bt_field_class *fc)
9e550e5f 1171{
78cf9df6 1172 const struct bt_field_class_static_array *array_fc = (const void *) fc;
939190b3
PP
1173
1174 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 1175 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
939190b3
PP
1176 "Field class");
1177 return (uint64_t) array_fc->length;
1178}
1179
1180static
1181void destroy_dynamic_array_field_class(struct bt_object *obj)
1182{
1183 struct bt_field_class_dynamic_array *fc = (void *) obj;
1184
1185 BT_ASSERT(fc);
9e550e5f 1186 BT_LIB_LOGD("Destroying dynamic array field class object: %!+F", fc);
939190b3
PP
1187 finalize_array_field_class((void *) fc);
1188 BT_LOGD_STR("Putting length field path.");
1248f5ea
PP
1189 BT_OBJECT_PUT_REF_AND_RESET(fc->length_field_path);
1190 BT_LOGD_STR("Putting length field class.");
1191 BT_OBJECT_PUT_REF_AND_RESET(fc->length_fc);
939190b3
PP
1192 g_free(fc);
1193}
1194
78cf9df6 1195struct bt_field_class *bt_field_class_dynamic_array_create(
b7396828 1196 bt_trace_class *trace_class,
78cf9df6 1197 struct bt_field_class *element_fc)
939190b3
PP
1198{
1199 struct bt_field_class_dynamic_array *array_fc = NULL;
1200
b7396828 1201 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f
PP
1202 BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
1203 BT_LOGD_STR("Creating default dynamic array field class object.");
939190b3
PP
1204 array_fc = g_new0(struct bt_field_class_dynamic_array, 1);
1205 if (!array_fc) {
9e550e5f 1206 BT_LOGE_STR("Failed to allocate one dynamic array field class.");
939190b3
PP
1207 goto error;
1208 }
1209
78cf9df6
PP
1210 init_array_field_class((void *) array_fc,
1211 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
939190b3 1212 destroy_dynamic_array_field_class, element_fc);
9e550e5f 1213 BT_LIB_LOGD("Created dynamic array field class object: %!+F", array_fc);
939190b3
PP
1214 goto end;
1215
1216error:
8138bfe1 1217 BT_OBJECT_PUT_REF_AND_RESET(array_fc);
939190b3
PP
1218
1219end:
1220 return (void *) array_fc;
1221}
1222
4b514ab3 1223enum bt_field_class_status bt_field_class_dynamic_array_set_length_field_class(
78cf9df6
PP
1224 struct bt_field_class *fc,
1225 struct bt_field_class *length_fc)
939190b3
PP
1226{
1227 struct bt_field_class_dynamic_array *array_fc = (void *) fc;
1228
9e550e5f
PP
1229 BT_ASSERT_PRE_NON_NULL(fc, "Dynamic array field class");
1230 BT_ASSERT_PRE_NON_NULL(length_fc, "Length field class");
af0c18e3 1231 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
939190b3 1232 "Field class");
9e550e5f
PP
1233 BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(length_fc, "Length field class");
1234 BT_ASSERT_PRE_FC_HOT(fc, "Dynamic array field class");
78cf9df6 1235 array_fc->length_fc = length_fc;
4b70020d 1236 bt_object_get_no_null_check(length_fc);
939190b3 1237 bt_field_class_freeze(length_fc);
4b514ab3 1238 return BT_FIELD_CLASS_STATUS_OK;
939190b3
PP
1239}
1240
78cf9df6
PP
1241const struct bt_field_path *
1242bt_field_class_dynamic_array_borrow_length_field_path_const(
1243 const struct bt_field_class *fc)
939190b3 1244{
78cf9df6 1245 const struct bt_field_class_dynamic_array *seq_fc = (const void *) fc;
939190b3
PP
1246
1247 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
af0c18e3 1248 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
939190b3
PP
1249 "Field class");
1250 return seq_fc->length_field_path;
1251}
1252
1253static
1254void destroy_string_field_class(struct bt_object *obj)
1255{
1256 BT_ASSERT(obj);
9e550e5f 1257 BT_LIB_LOGD("Destroying string field class object: %!+F", obj);
939190b3
PP
1258 g_free(obj);
1259}
1260
b7396828 1261struct bt_field_class *bt_field_class_string_create(bt_trace_class *trace_class)
939190b3
PP
1262{
1263 struct bt_field_class_string *string_fc = NULL;
1264
b7396828 1265 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
9e550e5f 1266 BT_LOGD_STR("Creating default string field class object.");
939190b3
PP
1267 string_fc = g_new0(struct bt_field_class_string, 1);
1268 if (!string_fc) {
9e550e5f 1269 BT_LOGE_STR("Failed to allocate one string field class.");
939190b3
PP
1270 goto error;
1271 }
1272
af0c18e3 1273 init_field_class((void *) string_fc, BT_FIELD_CLASS_TYPE_STRING,
939190b3 1274 destroy_string_field_class);
9e550e5f 1275 BT_LIB_LOGD("Created string field class object: %!+F", string_fc);
939190b3
PP
1276 goto end;
1277
1278error:
8138bfe1 1279 BT_OBJECT_PUT_REF_AND_RESET(string_fc);
939190b3
PP
1280
1281end:
1282 return (void *) string_fc;
1283}
1284
1285BT_HIDDEN
e24f271a 1286void _bt_field_class_freeze(const struct bt_field_class *c_fc)
939190b3 1287{
e24f271a
PP
1288 struct bt_field_class *fc = (void *) c_fc;
1289
939190b3
PP
1290 /*
1291 * Element/member/option field classes are frozen when added to
1292 * their owner.
1293 */
1294 BT_ASSERT(fc);
e24f271a
PP
1295 fc->frozen = true;
1296
1297 switch (fc->type) {
1298 case BT_FIELD_CLASS_TYPE_STRUCTURE:
1299 case BT_FIELD_CLASS_TYPE_VARIANT:
1300 {
1301 struct bt_field_class_named_field_class_container *container_fc =
1302 (void *) fc;
1303 uint64_t i;
1304
1305 for (i = 0; i < container_fc->named_fcs->len; i++) {
1306 struct bt_named_field_class *named_fc =
1307 BT_FIELD_CLASS_NAMED_FC_AT_INDEX(
1308 container_fc, i);
1309
1310 bt_named_field_class_freeze(named_fc);
1311 }
1312
1313 break;
1314 }
1315 default:
1316 break;
1317 }
1318}
1319
1320BT_HIDDEN
1321void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc)
1322{
1323 BT_ASSERT(named_fc);
1324 ((struct bt_named_field_class *) named_fc)->frozen = true;
1325 bt_field_class_freeze(named_fc->fc);
939190b3
PP
1326}
1327
1328BT_HIDDEN
10b7a2e4 1329void _bt_field_class_make_part_of_trace_class(const struct bt_field_class *c_fc)
939190b3 1330{
78cf9df6
PP
1331 struct bt_field_class *fc = (void *) c_fc;
1332
939190b3 1333 BT_ASSERT(fc);
10b7a2e4 1334 BT_ASSERT_PRE(!fc->part_of_trace_class,
939190b3 1335 "Field class is already part of a trace: %!+F", fc);
10b7a2e4 1336 fc->part_of_trace_class = true;
939190b3 1337
af0c18e3
PP
1338 switch (fc->type) {
1339 case BT_FIELD_CLASS_TYPE_STRUCTURE:
1340 case BT_FIELD_CLASS_TYPE_VARIANT:
939190b3
PP
1341 {
1342 struct bt_field_class_named_field_class_container *container_fc =
1343 (void *) fc;
1344 uint64_t i;
1345
1346 for (i = 0; i < container_fc->named_fcs->len; i++) {
1347 struct bt_named_field_class *named_fc =
1348 BT_FIELD_CLASS_NAMED_FC_AT_INDEX(
1349 container_fc, i);
1350
10b7a2e4 1351 bt_field_class_make_part_of_trace_class(named_fc->fc);
939190b3
PP
1352 }
1353
1354 break;
1355 }
af0c18e3
PP
1356 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
1357 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
939190b3
PP
1358 {
1359 struct bt_field_class_array *array_fc = (void *) fc;
1360
10b7a2e4 1361 bt_field_class_make_part_of_trace_class(array_fc->element_fc);
939190b3
PP
1362 break;
1363 }
1364 default:
1365 break;
1366 }
1367}
8c6884d9
PP
1368
1369void bt_field_class_get_ref(const struct bt_field_class *field_class)
1370{
1371 bt_object_get_ref(field_class);
1372}
1373
1374void bt_field_class_put_ref(const struct bt_field_class *field_class)
1375{
1376 bt_object_put_ref(field_class);
1377}
This page took 0.089205 seconds and 4 git commands to generate.