projects / babeltrace.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Tests: flt.lttng-utils.debug-info: update debug-info tests
[babeltrace.git] / src / lib / trace-ir / field-class.c
... / ...
CommitLineData
1/*
2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@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/FIELD-CLASS"
25#include "lib/logging.h"
26
27#include "lib/assert-pre.h"
28#include <babeltrace2/trace-ir/field-class.h>
29#include <babeltrace2/trace-ir/field-class-const.h>
30#include <babeltrace2/trace-ir/field-const.h>
31#include <babeltrace2/trace-ir/field.h>
32#include <babeltrace2/trace-ir/clock-class.h>
33#include "lib/object.h"
34#include "compat/compiler.h"
35#include "compat/endian.h"
36#include "common/assert.h"
37#include "compat/glib.h"
38#include <float.h>
39#include <inttypes.h>
40#include <stdlib.h>
41
42#include "clock-class.h"
43#include "field-class.h"
44#include "field.h"
45#include "field-path.h"
46#include "utils.h"
47#include "lib/func-status.h"
48#include "lib/integer-range-set.h"
49
50enum bt_field_class_type bt_field_class_get_type(
51 const struct bt_field_class *fc)
52{
53 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
54 return fc->type;
55}
56
57static
58void init_field_class(struct bt_field_class *fc, enum bt_field_class_type type,
59 bt_object_release_func release_func)
60{
61 BT_ASSERT(fc);
62 BT_ASSERT(release_func);
63 bt_object_init_shared(&fc->base, release_func);
64 fc->type = type;
65}
66
67static
68void init_integer_field_class(struct bt_field_class_integer *fc,
69 enum bt_field_class_type type,
70 bt_object_release_func release_func)
71{
72 init_field_class((void *) fc, type, release_func);
73 fc->range = 64;
74 fc->base = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL;
75}
76
77static
78void destroy_integer_field_class(struct bt_object *obj)
79{
80 BT_ASSERT(obj);
81 BT_LIB_LOGD("Destroying integer field class object: %!+F", obj);
82 g_free(obj);
83}
84
85static inline
86struct bt_field_class *create_integer_field_class(bt_trace_class *trace_class,
87 enum bt_field_class_type type)
88{
89 struct bt_field_class_integer *int_fc = NULL;
90
91 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
92 BT_LOGD("Creating default integer field class object: type=%s",
93 bt_common_field_class_type_string(type));
94 int_fc = g_new0(struct bt_field_class_integer, 1);
95 if (!int_fc) {
96 BT_LIB_LOGE_APPEND_CAUSE(
97 "Failed to allocate one integer field class.");
98 goto error;
99 }
100
101 init_integer_field_class(int_fc, type, destroy_integer_field_class);
102 BT_LIB_LOGD("Created integer field class object: %!+F", int_fc);
103 goto end;
104
105error:
106 BT_OBJECT_PUT_REF_AND_RESET(int_fc);
107
108end:
109 return (void *) int_fc;
110}
111
112struct bt_field_class *bt_field_class_unsigned_integer_create(
113 bt_trace_class *trace_class)
114{
115 return create_integer_field_class(trace_class,
116 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
117}
118
119struct bt_field_class *bt_field_class_signed_integer_create(
120 bt_trace_class *trace_class)
121{
122 return create_integer_field_class(trace_class,
123 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
124}
125
126uint64_t bt_field_class_integer_get_field_value_range(
127 const struct bt_field_class *fc)
128{
129 const struct bt_field_class_integer *int_fc = (const void *) fc;
130
131 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
132 BT_ASSERT_PRE_DEV_FC_IS_INT(fc, "Field class");
133 return int_fc->range;
134}
135
136static
137bool size_is_valid_for_enumeration_field_class(struct bt_field_class *fc,
138 uint64_t size)
139{
140 // TODO
141 return true;
142}
143
144void bt_field_class_integer_set_field_value_range(
145 struct bt_field_class *fc, uint64_t size)
146{
147 struct bt_field_class_integer *int_fc = (void *) fc;
148
149 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
150 BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
151 BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class");
152 BT_ASSERT_PRE(size <= 64,
153 "Unsupported size for integer field class's field value range "
154 "(maximum is 64): size=%" PRIu64, size);
155 BT_ASSERT_PRE(
156 int_fc->common.type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
157 int_fc->common.type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
158 size_is_valid_for_enumeration_field_class(fc, size),
159 "Invalid field value range for enumeration field class: "
160 "at least one of the current mapping ranges contains values "
161 "which are outside this range: %!+F, size=%" PRIu64, fc, size);
162 int_fc->range = size;
163 BT_LIB_LOGD("Set integer field class's field value range: %!+F", fc);
164}
165
166enum bt_field_class_integer_preferred_display_base
167bt_field_class_integer_get_preferred_display_base(const struct bt_field_class *fc)
168{
169 const struct bt_field_class_integer *int_fc = (const void *) fc;
170
171 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
172 BT_ASSERT_PRE_DEV_FC_IS_INT(fc, "Field class");
173 return int_fc->base;
174}
175
176void bt_field_class_integer_set_preferred_display_base(
177 struct bt_field_class *fc,
178 enum bt_field_class_integer_preferred_display_base base)
179{
180 struct bt_field_class_integer *int_fc = (void *) fc;
181
182 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
183 BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
184 BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class");
185 int_fc->base = base;
186 BT_LIB_LOGD("Set integer field class's preferred display base: %!+F", fc);
187}
188
189static
190void finalize_enumeration_field_class_mapping(
191 struct bt_field_class_enumeration_mapping *mapping)
192{
193 BT_ASSERT(mapping);
194
195 if (mapping->label) {
196 g_string_free(mapping->label, TRUE);
197 mapping->label = NULL;
198 }
199
200 BT_OBJECT_PUT_REF_AND_RESET(mapping->range_set);
201}
202
203static
204void destroy_enumeration_field_class(struct bt_object *obj)
205{
206 struct bt_field_class_enumeration *fc = (void *) obj;
207
208 BT_ASSERT(fc);
209 BT_LIB_LOGD("Destroying enumeration field class object: %!+F", fc);
210
211 if (fc->mappings) {
212 uint64_t i;
213
214 for (i = 0; i < fc->mappings->len; i++) {
215 finalize_enumeration_field_class_mapping(
216 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, i));
217 }
218
219 g_array_free(fc->mappings, TRUE);
220 fc->mappings = NULL;
221 }
222
223 if (fc->label_buf) {
224 g_ptr_array_free(fc->label_buf, TRUE);
225 fc->label_buf = NULL;
226 }
227
228 g_free(fc);
229}
230
231static
232struct bt_field_class *create_enumeration_field_class(
233 bt_trace_class *trace_class, enum bt_field_class_type type)
234{
235 struct bt_field_class_enumeration *enum_fc = NULL;
236
237 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
238 BT_LOGD("Creating default enumeration field class object: type=%s",
239 bt_common_field_class_type_string(type));
240 enum_fc = g_new0(struct bt_field_class_enumeration, 1);
241 if (!enum_fc) {
242 BT_LIB_LOGE_APPEND_CAUSE(
243 "Failed to allocate one enumeration field class.");
244 goto error;
245 }
246
247 init_integer_field_class((void *) enum_fc, type,
248 destroy_enumeration_field_class);
249 enum_fc->mappings = g_array_new(FALSE, TRUE,
250 sizeof(struct bt_field_class_enumeration_mapping));
251 if (!enum_fc->mappings) {
252 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
253 goto error;
254 }
255
256 enum_fc->label_buf = g_ptr_array_new();
257 if (!enum_fc->label_buf) {
258 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
259 goto error;
260 }
261
262 BT_LIB_LOGD("Created enumeration field class object: %!+F", enum_fc);
263 goto end;
264
265error:
266 BT_OBJECT_PUT_REF_AND_RESET(enum_fc);
267
268end:
269 return (void *) enum_fc;
270}
271
272struct bt_field_class *bt_field_class_unsigned_enumeration_create(
273 bt_trace_class *trace_class)
274{
275 return create_enumeration_field_class(trace_class,
276 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
277}
278
279struct bt_field_class *bt_field_class_signed_enumeration_create(
280 bt_trace_class *trace_class)
281{
282 return create_enumeration_field_class(trace_class,
283 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
284}
285
286uint64_t bt_field_class_enumeration_get_mapping_count(
287 const struct bt_field_class *fc)
288{
289 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
290
291 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
292 BT_ASSERT_PRE_DEV_FC_IS_ENUM(fc, "Field class");
293 return (uint64_t) enum_fc->mappings->len;
294}
295
296const struct bt_field_class_unsigned_enumeration_mapping *
297bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
298 const struct bt_field_class *fc, uint64_t index)
299{
300 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
301
302 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
303 BT_ASSERT_PRE_DEV_VALID_INDEX(index, enum_fc->mappings->len);
304 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
305 "Field class");
306 return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index);
307}
308
309const struct bt_field_class_signed_enumeration_mapping *
310bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
311 const struct bt_field_class *fc, uint64_t index)
312{
313 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
314
315 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
316 BT_ASSERT_PRE_DEV_VALID_INDEX(index, enum_fc->mappings->len);
317 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
318 "Field class");
319 return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index);
320}
321
322static
323const struct bt_field_class_enumeration_mapping *
324borrow_enumeration_field_class_mapping_by_label(
325 const struct bt_field_class_enumeration *fc, const char *label)
326{
327 struct bt_field_class_enumeration_mapping *mapping = NULL;
328 uint64_t i;
329
330 BT_ASSERT(fc);
331 BT_ASSERT_PRE_DEV_NON_NULL(label, "Label");
332
333 for (i = 0; i < fc->mappings->len; i++) {
334 struct bt_field_class_enumeration_mapping *this_mapping =
335 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, i);
336
337 if (strcmp(this_mapping->label->str, label) == 0) {
338 mapping = this_mapping;
339 goto end;
340 }
341 }
342
343end:
344 return mapping;
345}
346
347const struct bt_field_class_signed_enumeration_mapping *
348bt_field_class_signed_enumeration_borrow_mapping_by_label_const(
349 const struct bt_field_class *fc, const char *label)
350{
351 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
352 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
353 "Field class");
354 return (const void *) borrow_enumeration_field_class_mapping_by_label(
355 (const void *) fc, label);
356}
357
358const struct bt_field_class_unsigned_enumeration_mapping *
359bt_field_class_unsigned_enumeration_borrow_mapping_by_label_const(
360 const struct bt_field_class *fc, const char *label)
361{
362 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
363 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
364 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field class");
365 return (const void *) borrow_enumeration_field_class_mapping_by_label(
366 (const void *) fc, label);
367}
368
369const char *bt_field_class_enumeration_mapping_get_label(
370 const struct bt_field_class_enumeration_mapping *mapping)
371{
372 BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping");
373 return mapping->label->str;
374}
375
376const struct bt_integer_range_set_unsigned *
377bt_field_class_unsigned_enumeration_mapping_borrow_ranges_const(
378 const struct bt_field_class_unsigned_enumeration_mapping *u_mapping)
379{
380 const struct bt_field_class_enumeration_mapping *mapping =
381 (const void *) u_mapping;
382
383 BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping");
384 return (const void *) mapping->range_set;
385}
386
387const struct bt_integer_range_set_signed *
388bt_field_class_signed_enumeration_mapping_borrow_ranges_const(
389 const struct bt_field_class_signed_enumeration_mapping *s_mapping)
390{
391 const struct bt_field_class_enumeration_mapping *mapping =
392 (const void *) s_mapping;
393
394 BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping");
395 return (const void *) mapping->range_set;
396}
397
398enum bt_field_class_enumeration_get_mapping_labels_for_value_status
399bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
400 const struct bt_field_class *fc, uint64_t value,
401 bt_field_class_enumeration_mapping_label_array *label_array,
402 uint64_t *count)
403{
404 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
405 uint64_t i;
406
407 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
408 BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
409 BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
410 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
411 "Field class");
412 g_ptr_array_set_size(enum_fc->label_buf, 0);
413
414 for (i = 0; i < enum_fc->mappings->len; i++) {
415 uint64_t j;
416 const struct bt_field_class_enumeration_mapping *mapping =
417 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
418
419 for (j = 0; j < mapping->range_set->ranges->len; j++) {
420 const struct bt_integer_range *range = (const void *)
421 BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
422 mapping->range_set, j);
423
424 if (value >= range->lower.u &&
425 value <= range->upper.u) {
426 g_ptr_array_add(enum_fc->label_buf,
427 mapping->label->str);
428 break;
429 }
430 }
431 }
432
433 *label_array = (void *) enum_fc->label_buf->pdata;
434 *count = (uint64_t) enum_fc->label_buf->len;
435 return BT_FUNC_STATUS_OK;
436}
437
438enum bt_field_class_enumeration_get_mapping_labels_for_value_status
439bt_field_class_signed_enumeration_get_mapping_labels_for_value(
440 const struct bt_field_class *fc, int64_t value,
441 bt_field_class_enumeration_mapping_label_array *label_array,
442 uint64_t *count)
443{
444 const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
445 uint64_t i;
446
447 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
448 BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
449 BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
450 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
451 "Field class");
452 g_ptr_array_set_size(enum_fc->label_buf, 0);
453
454 for (i = 0; i < enum_fc->mappings->len; i++) {
455 uint64_t j;
456 const struct bt_field_class_enumeration_mapping *mapping =
457 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
458
459 for (j = 0; j < mapping->range_set->ranges->len; j++) {
460 const struct bt_integer_range *range = (const void *)
461 BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
462 mapping->range_set, j);
463
464 if (value >= range->lower.i &&
465 value <= range->upper.i) {
466 g_ptr_array_add(enum_fc->label_buf,
467 mapping->label->str);
468 break;
469 }
470 }
471 }
472
473 *label_array = (void *) enum_fc->label_buf->pdata;
474 *count = (uint64_t) enum_fc->label_buf->len;
475 return BT_FUNC_STATUS_OK;
476}
477
478static
479bool enumeration_field_class_has_mapping_with_label(
480 const struct bt_field_class_enumeration *enum_fc,
481 const char *label)
482{
483 uint64_t i;
484 bool exists = false;
485
486 BT_ASSERT(enum_fc);
487 BT_ASSERT(label);
488
489 for (i = 0; i < enum_fc->mappings->len; i++) {
490 struct bt_field_class_enumeration_mapping *mapping_candidate =
491 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
492
493 if (strcmp(mapping_candidate->label->str, label) == 0) {
494 exists = true;
495 goto end;
496 }
497 }
498
499end:
500 return exists;
501}
502
503static inline
504enum bt_field_class_enumeration_add_mapping_status
505add_mapping_to_enumeration_field_class(struct bt_field_class *fc,
506 const char *label, const struct bt_integer_range_set *range_set)
507{
508 enum bt_field_class_enumeration_add_mapping_status status =
509 BT_FUNC_STATUS_OK;
510 struct bt_field_class_enumeration *enum_fc = (void *) fc;
511 struct bt_field_class_enumeration_mapping mapping = { 0 };
512
513 BT_ASSERT(fc);
514 BT_ASSERT_PRE_NON_NULL(label, "Label");
515 BT_ASSERT_PRE_NON_NULL(range_set, "Range set");
516 BT_ASSERT_PRE(!enumeration_field_class_has_mapping_with_label(
517 enum_fc, label),
518 "Duplicate mapping name in enumeration field class: "
519 "%![enum-fc-]+F, label=\"%s\"", fc, label);
520 mapping.range_set = range_set;
521 bt_object_get_ref(mapping.range_set);
522 mapping.label = g_string_new(label);
523 if (!mapping.label) {
524 finalize_enumeration_field_class_mapping(&mapping);
525 status = BT_FUNC_STATUS_MEMORY_ERROR;
526 goto end;
527 }
528
529 g_array_append_val(enum_fc->mappings, mapping);
530 BT_LIB_LOGD("Added mapping to enumeration field class: "
531 "%![fc-]+F, label=\"%s\"", fc, label);
532
533end:
534 return status;
535}
536
537enum bt_field_class_enumeration_add_mapping_status
538bt_field_class_unsigned_enumeration_add_mapping(
539 struct bt_field_class *fc, const char *label,
540 const struct bt_integer_range_set_unsigned *range_set)
541{
542 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
543 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
544 "Field class");
545 return add_mapping_to_enumeration_field_class(fc, label,
546 (const void *) range_set);
547}
548
549enum bt_field_class_enumeration_add_mapping_status
550bt_field_class_signed_enumeration_add_mapping(
551 struct bt_field_class *fc, const char *label,
552 const struct bt_integer_range_set_signed *range_set)
553{
554 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
555 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
556 "Field class");
557 return add_mapping_to_enumeration_field_class(fc, label,
558 (const void *) range_set);
559}
560
561static
562void destroy_real_field_class(struct bt_object *obj)
563{
564 BT_ASSERT(obj);
565 BT_LIB_LOGD("Destroying real field class object: %!+F", obj);
566 g_free(obj);
567}
568
569struct bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class)
570{
571 struct bt_field_class_real *real_fc = NULL;
572
573 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
574 BT_LOGD_STR("Creating default real field class object.");
575 real_fc = g_new0(struct bt_field_class_real, 1);
576 if (!real_fc) {
577 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one real field class.");
578 goto error;
579 }
580
581 init_field_class((void *) real_fc, BT_FIELD_CLASS_TYPE_REAL,
582 destroy_real_field_class);
583 BT_LIB_LOGD("Created real field class object: %!+F", real_fc);
584 goto end;
585
586error:
587 BT_OBJECT_PUT_REF_AND_RESET(real_fc);
588
589end:
590 return (void *) real_fc;
591}
592
593bt_bool bt_field_class_real_is_single_precision(const struct bt_field_class *fc)
594{
595 const struct bt_field_class_real *real_fc = (const void *) fc;
596
597 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
598 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_REAL, "Field class");
599 return real_fc->is_single_precision;
600}
601
602void bt_field_class_real_set_is_single_precision(struct bt_field_class *fc,
603 bt_bool is_single_precision)
604{
605 struct bt_field_class_real *real_fc = (void *) fc;
606
607 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
608 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_REAL, "Field class");
609 BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class");
610 real_fc->is_single_precision = (bool) is_single_precision;
611 BT_LIB_LOGD("Set real field class's \"is single precision\" property: "
612 "%!+F", fc);
613}
614
615static
616int init_named_field_classes_container(
617 struct bt_field_class_named_field_class_container *fc,
618 enum bt_field_class_type type,
619 bt_object_release_func fc_release_func,
620 GDestroyNotify named_fc_destroy_func)
621{
622 int ret = 0;
623
624 init_field_class((void *) fc, type, fc_release_func);
625 fc->named_fcs = g_ptr_array_new_with_free_func(named_fc_destroy_func);
626 if (!fc->named_fcs) {
627 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
628 ret = -1;
629 goto end;
630 }
631
632 fc->name_to_index = g_hash_table_new(g_str_hash, g_str_equal);
633 if (!fc->name_to_index) {
634 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GHashTable.");
635 ret = -1;
636 goto end;
637 }
638
639end:
640 return ret;
641}
642
643static
644void finalize_named_field_class(struct bt_named_field_class *named_fc)
645{
646 BT_ASSERT(named_fc);
647 BT_LIB_LOGD("Finalizing named field class: "
648 "addr=%p, name=\"%s\", %![fc-]+F",
649 named_fc, named_fc->name ? named_fc->name->str : NULL,
650 named_fc->fc);
651
652 if (named_fc->name) {
653 g_string_free(named_fc->name, TRUE);
654 named_fc->name = NULL;
655 }
656
657 BT_LOGD_STR("Putting named field class's field class.");
658 BT_OBJECT_PUT_REF_AND_RESET(named_fc->fc);
659}
660
661static
662void destroy_named_field_class(gpointer ptr)
663{
664 if (ptr) {
665 finalize_named_field_class(ptr);
666 g_free(ptr);
667 }
668}
669
670static
671void destroy_variant_with_selector_option(gpointer ptr)
672{
673 struct bt_field_class_variant_with_selector_option *opt = ptr;
674
675 if (ptr) {
676 finalize_named_field_class(&opt->common);
677 BT_OBJECT_PUT_REF_AND_RESET(opt->range_set);
678 g_free(ptr);
679 }
680}
681
682static
683void finalize_named_field_classes_container(
684 struct bt_field_class_named_field_class_container *fc)
685{
686 BT_ASSERT(fc);
687
688 if (fc->named_fcs) {
689 g_ptr_array_free(fc->named_fcs, TRUE);
690 fc->named_fcs = NULL;
691
692 }
693
694 if (fc->name_to_index) {
695 g_hash_table_destroy(fc->name_to_index);
696 fc->name_to_index = NULL;
697 }
698}
699
700static
701void destroy_structure_field_class(struct bt_object *obj)
702{
703 BT_ASSERT(obj);
704 BT_LIB_LOGD("Destroying structure field class object: %!+F", obj);
705 finalize_named_field_classes_container((void *) obj);
706 g_free(obj);
707}
708
709struct bt_field_class *bt_field_class_structure_create(
710 bt_trace_class *trace_class)
711{
712 int ret;
713 struct bt_field_class_structure *struct_fc = NULL;
714
715 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
716 BT_LOGD_STR("Creating default structure field class object.");
717 struct_fc = g_new0(struct bt_field_class_structure, 1);
718 if (!struct_fc) {
719 BT_LIB_LOGE_APPEND_CAUSE(
720 "Failed to allocate one structure field class.");
721 goto error;
722 }
723
724 ret = init_named_field_classes_container((void *) struct_fc,
725 BT_FIELD_CLASS_TYPE_STRUCTURE, destroy_structure_field_class,
726 destroy_named_field_class);
727 if (ret) {
728 /* init_named_field_classes_container() logs errors */
729 goto error;
730 }
731
732 BT_LIB_LOGD("Created structure field class object: %!+F", struct_fc);
733 goto end;
734
735error:
736 BT_OBJECT_PUT_REF_AND_RESET(struct_fc);
737
738end:
739 return (void *) struct_fc;
740}
741
742static
743int init_named_field_class(struct bt_named_field_class *named_fc,
744 const char *name, struct bt_field_class *fc)
745{
746 int status = BT_FUNC_STATUS_OK;
747
748 BT_ASSERT(named_fc);
749 BT_ASSERT(name);
750 BT_ASSERT(fc);
751 named_fc->name = g_string_new(name);
752 if (!named_fc->name) {
753 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
754 status = BT_FUNC_STATUS_MEMORY_ERROR;
755 goto end;
756 }
757
758 named_fc->fc = fc;
759 bt_object_get_no_null_check(named_fc->fc);
760 bt_named_field_class_freeze(named_fc);
761
762end:
763 return status;
764}
765
766static
767struct bt_named_field_class *create_named_field_class(const char *name,
768 struct bt_field_class *fc)
769{
770 struct bt_named_field_class *named_fc = g_new0(
771 struct bt_named_field_class, 1);
772
773 if (!named_fc) {
774 BT_LIB_LOGE_APPEND_CAUSE(
775 "Failed to allocate a named field class.");
776 goto error;
777 }
778
779 if (init_named_field_class(named_fc, name, fc)) {
780 /* init_named_field_class() logs errors */
781 goto error;
782 }
783
784 goto end;
785
786error:
787 destroy_named_field_class(named_fc);
788 named_fc = NULL;
789
790end:
791 return named_fc;
792}
793
794static
795struct bt_field_class_variant_with_selector_option *
796create_variant_with_selector_option(
797 const char *name, struct bt_field_class *fc,
798 const struct bt_integer_range_set *range_set)
799{
800 struct bt_field_class_variant_with_selector_option *opt = g_new0(
801 struct bt_field_class_variant_with_selector_option, 1);
802
803 BT_ASSERT(range_set);
804
805 if (!opt) {
806 BT_LIB_LOGE_APPEND_CAUSE(
807 "Failed to allocate a named field class.");
808 goto error;
809 }
810
811 if (init_named_field_class(&opt->common, name, fc)) {
812 goto error;
813 }
814
815 opt->range_set = range_set;
816 bt_object_get_no_null_check(opt->range_set);
817 bt_integer_range_set_freeze(range_set);
818 goto end;
819
820error:
821 destroy_variant_with_selector_option(opt);
822 opt = NULL;
823
824end:
825 return opt;
826}
827
828static
829int append_named_field_class_to_container_field_class(
830 struct bt_field_class_named_field_class_container *container_fc,
831 struct bt_named_field_class *named_fc)
832{
833 BT_ASSERT(container_fc);
834 BT_ASSERT(named_fc);
835 BT_ASSERT_PRE_DEV_FC_HOT(container_fc, "Field class");
836 BT_ASSERT_PRE(!bt_g_hash_table_contains(container_fc->name_to_index,
837 named_fc->name->str),
838 "Duplicate member/option name in structure/variant field class: "
839 "%![container-fc-]+F, name=\"%s\"", container_fc,
840 named_fc->name->str);
841 g_ptr_array_add(container_fc->named_fcs, named_fc);
842 g_hash_table_insert(container_fc->name_to_index, named_fc->name->str,
843 GUINT_TO_POINTER(container_fc->named_fcs->len - 1));
844 return BT_FUNC_STATUS_OK;
845}
846
847enum bt_field_class_structure_append_member_status
848bt_field_class_structure_append_member(
849 struct bt_field_class *fc, const char *name,
850 struct bt_field_class *member_fc)
851{
852 enum bt_field_class_structure_append_member_status status;
853 struct bt_named_field_class *named_fc = NULL;
854
855 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
856 BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
857 "Field class");
858 named_fc = create_named_field_class(name, member_fc);
859 if (!named_fc) {
860 /* create_named_field_class() logs errors */
861 status = BT_FUNC_STATUS_MEMORY_ERROR;
862 goto end;
863 }
864
865 status = append_named_field_class_to_container_field_class((void *) fc,
866 named_fc);
867 if (status == BT_FUNC_STATUS_OK) {
868 /* Moved to the container */
869 named_fc = NULL;
870 }
871
872end:
873 return status;
874}
875
876uint64_t bt_field_class_structure_get_member_count(
877 const struct bt_field_class *fc)
878{
879 struct bt_field_class_structure *struct_fc = (void *) fc;
880
881 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
882 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
883 "Field class");
884 return (uint64_t) struct_fc->common.named_fcs->len;
885}
886
887static
888struct bt_named_field_class *
889borrow_named_field_class_from_container_field_class_at_index(
890 struct bt_field_class_named_field_class_container *fc,
891 uint64_t index)
892{
893 BT_ASSERT(fc);
894 BT_ASSERT_PRE_DEV_VALID_INDEX(index, fc->named_fcs->len);
895 return fc->named_fcs->pdata[index];
896}
897
898const struct bt_field_class_structure_member *
899bt_field_class_structure_borrow_member_by_index_const(
900 const struct bt_field_class *fc, uint64_t index)
901{
902 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
903 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
904 "Field class");
905 return (const void *)
906 borrow_named_field_class_from_container_field_class_at_index(
907 (void *) fc, index);
908}
909
910struct bt_field_class_structure_member *
911bt_field_class_structure_borrow_member_by_index(
912 struct bt_field_class *fc, uint64_t index)
913{
914 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
915 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
916 "Field class");
917 return (void *)
918 borrow_named_field_class_from_container_field_class_at_index(
919 (void *) fc, index);
920}
921
922static
923struct bt_named_field_class *
924borrow_named_field_class_from_container_field_class_by_name(
925 struct bt_field_class_named_field_class_container *fc,
926 const char *name)
927{
928 struct bt_named_field_class *named_fc = NULL;
929 gpointer orig_key;
930 gpointer value;
931
932 BT_ASSERT(fc);
933 BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
934 if (!g_hash_table_lookup_extended(fc->name_to_index, name, &orig_key,
935 &value)) {
936 goto end;
937 }
938
939 named_fc = fc->named_fcs->pdata[GPOINTER_TO_UINT(value)];
940
941end:
942 return named_fc;
943}
944
945const struct bt_field_class_structure_member *
946bt_field_class_structure_borrow_member_by_name_const(
947 const struct bt_field_class *fc, const char *name)
948{
949 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
950 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
951 "Field class");
952 return (const void *)
953 borrow_named_field_class_from_container_field_class_by_name(
954 (void *) fc, name);
955}
956
957struct bt_field_class_structure_member *
958bt_field_class_structure_borrow_member_by_name(
959 struct bt_field_class *fc, const char *name)
960{
961 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
962 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
963 "Field class");
964 return (void *)
965 borrow_named_field_class_from_container_field_class_by_name(
966 (void *) fc, name);
967}
968
969const char *bt_field_class_structure_member_get_name(
970 const struct bt_field_class_structure_member *member)
971{
972 const struct bt_named_field_class *named_fc = (const void *) member;
973
974 BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member");
975 return named_fc->name->str;
976}
977
978const struct bt_field_class *
979bt_field_class_structure_member_borrow_field_class_const(
980 const struct bt_field_class_structure_member *member)
981{
982 const struct bt_named_field_class *named_fc = (const void *) member;
983
984 BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member");
985 return named_fc->fc;
986}
987
988static
989void finalize_variant_field_class(struct bt_field_class_variant *var_fc)
990{
991 BT_ASSERT(var_fc);
992 BT_LIB_LOGD("Finalizing variant field class object: %!+F", var_fc);
993 finalize_named_field_classes_container((void *) var_fc);
994}
995
996static
997void destroy_variant_field_class(struct bt_object *obj)
998{
999 struct bt_field_class_variant *fc = (void *) obj;
1000
1001 BT_ASSERT(fc);
1002 finalize_variant_field_class(fc);
1003 g_free(fc);
1004}
1005
1006static
1007void destroy_variant_with_selector_field_class(struct bt_object *obj)
1008{
1009 struct bt_field_class_variant_with_selector *fc = (void *) obj;
1010
1011 BT_ASSERT(fc);
1012 finalize_variant_field_class(&fc->common);
1013 BT_LOGD_STR("Putting selector field path.");
1014 BT_OBJECT_PUT_REF_AND_RESET(fc->selector_field_path);
1015 BT_LOGD_STR("Putting selector field class.");
1016 BT_OBJECT_PUT_REF_AND_RESET(fc->selector_fc);
1017 g_free(fc);
1018}
1019
1020struct bt_field_class *bt_field_class_variant_create(
1021 bt_trace_class *trace_class, bt_field_class *selector_fc)
1022{
1023 int ret;
1024 struct bt_field_class_variant *var_fc = NULL;
1025 struct bt_field_class_variant_with_selector *var_with_sel_fc = NULL;
1026 enum bt_field_class_type fc_type;
1027
1028 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
1029
1030 if (selector_fc) {
1031 BT_ASSERT_PRE_FC_IS_INT(selector_fc, "Selector field class");
1032 }
1033
1034 BT_LIB_LOGD("Creating default variant field class: %![sel-fc-]+F",
1035 selector_fc);
1036
1037 if (selector_fc) {
1038 var_with_sel_fc = g_new0(
1039 struct bt_field_class_variant_with_selector, 1);
1040 if (!var_with_sel_fc) {
1041 BT_LIB_LOGE_APPEND_CAUSE(
1042 "Failed to allocate one variant field class with selector.");
1043 goto error;
1044 }
1045
1046 if (selector_fc->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
1047 selector_fc->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION) {
1048 fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR;
1049 } else {
1050 fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR;
1051 }
1052
1053 ret = init_named_field_classes_container(
1054 (void *) var_with_sel_fc, fc_type,
1055 destroy_variant_with_selector_field_class,
1056 destroy_variant_with_selector_option);
1057 if (ret) {
1058 /* init_named_field_classes_container() logs errors */
1059 goto error;
1060 }
1061
1062 var_with_sel_fc->selector_fc = selector_fc;
1063 bt_object_get_no_null_check(var_with_sel_fc->selector_fc);
1064 bt_field_class_freeze(selector_fc);
1065 var_fc = (void *) var_with_sel_fc;
1066 } else {
1067 var_fc = g_new0(struct bt_field_class_variant, 1);
1068 if (!var_fc) {
1069 BT_LIB_LOGE_APPEND_CAUSE(
1070 "Failed to allocate one variant field class without selector.");
1071 goto error;
1072 }
1073
1074 ret = init_named_field_classes_container((void *) var_fc,
1075 BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR,
1076 destroy_variant_field_class, destroy_named_field_class);
1077 if (ret) {
1078 /* init_named_field_classes_container() logs errors */
1079 goto error;
1080 }
1081 }
1082
1083 BT_ASSERT(var_fc);
1084 BT_LIB_LOGD("Created default variant field class with selector object: "
1085 "%![var-fc-]+F, %![sel-fc-]+F", var_fc, selector_fc);
1086 goto end;
1087
1088error:
1089 BT_OBJECT_PUT_REF_AND_RESET(var_fc);
1090
1091end:
1092 return (void *) var_fc;
1093}
1094
1095enum bt_field_class_variant_without_selector_append_option_status
1096bt_field_class_variant_without_selector_append_option(struct bt_field_class *fc,
1097 const char *name, struct bt_field_class *option_fc)
1098{
1099 enum bt_field_class_variant_without_selector_append_option_status status;
1100 struct bt_named_field_class *named_fc = NULL;
1101
1102 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1103 BT_ASSERT_PRE_NON_NULL(name, "Name");
1104 BT_ASSERT_PRE_NON_NULL(option_fc, "Option field class");
1105 BT_ASSERT_PRE_FC_HAS_ID(fc,
1106 BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR, "Field class");
1107 named_fc = create_named_field_class(name, option_fc);
1108 if (!named_fc) {
1109 /* create_named_field_class() logs errors */
1110 status = BT_FUNC_STATUS_MEMORY_ERROR;
1111 goto end;
1112 }
1113
1114 status = append_named_field_class_to_container_field_class((void *) fc,
1115 named_fc);
1116 if (status == BT_FUNC_STATUS_OK) {
1117 /* Moved to the container */
1118 named_fc = NULL;
1119 }
1120
1121end:
1122 if (named_fc) {
1123 destroy_named_field_class(named_fc);
1124 }
1125
1126 return status;
1127}
1128
1129static
1130int ranges_overlap(GPtrArray *var_fc_opts, const struct bt_integer_range_set *range_set,
1131 bool is_signed, bool *has_overlap)
1132{
1133 int status = BT_FUNC_STATUS_OK;
1134 struct bt_integer_range_set *full_range_set;
1135 uint64_t i;
1136
1137 *has_overlap = false;
1138
1139 /*
1140 * Build a single range set with all the ranges and test for
1141 * overlaps.
1142 */
1143 if (is_signed) {
1144 full_range_set = (void *) bt_integer_range_set_signed_create();
1145 } else {
1146 full_range_set = (void *) bt_integer_range_set_unsigned_create();
1147 }
1148
1149 if (!full_range_set) {
1150 BT_LOGE_STR("Failed to create a range set.");
1151 status = BT_FUNC_STATUS_MEMORY_ERROR;
1152 goto end;
1153 }
1154
1155 /* Add existing option ranges */
1156 for (i = 0; i < var_fc_opts->len; i++) {
1157 struct bt_field_class_variant_with_selector_option *opt =
1158 var_fc_opts->pdata[i];
1159 uint64_t j;
1160
1161 for (j = 0; j < opt->range_set->ranges->len; j++) {
1162 struct bt_integer_range *range = BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
1163 opt->range_set, j);
1164
1165 if (is_signed) {
1166 status = bt_integer_range_set_signed_add_range(
1167 (void *) full_range_set, range->lower.i,
1168 range->upper.i);
1169 } else {
1170 status = bt_integer_range_set_unsigned_add_range(
1171 (void *) full_range_set, range->lower.u,
1172 range->upper.u);
1173 }
1174
1175 if (status) {
1176 goto end;
1177 }
1178 }
1179 }
1180
1181 /* Add new ranges */
1182 for (i = 0; i < range_set->ranges->len; i++) {
1183 struct bt_integer_range *range = BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
1184 range_set, i);
1185
1186 if (is_signed) {
1187 status = bt_integer_range_set_signed_add_range(
1188 (void *) full_range_set, range->lower.i,
1189 range->upper.i);
1190 } else {
1191 status = bt_integer_range_set_unsigned_add_range(
1192 (void *) full_range_set, range->lower.u,
1193 range->upper.u);
1194 }
1195
1196 if (status) {
1197 goto end;
1198 }
1199 }
1200
1201 /* Check overlaps */
1202 if (is_signed) {
1203 *has_overlap = bt_integer_range_set_signed_has_overlaps(full_range_set);
1204 } else {
1205 *has_overlap = bt_integer_range_set_unsigned_has_overlaps(
1206 full_range_set);
1207 }
1208
1209end:
1210 bt_object_put_ref(full_range_set);
1211 return status;
1212}
1213
1214static
1215int append_option_to_variant_with_selector_field_class(
1216 struct bt_field_class *fc, const char *name,
1217 struct bt_field_class *option_fc,
1218 const struct bt_integer_range_set *range_set,
1219 enum bt_field_class_type expected_type)
1220{
1221 int status;
1222 struct bt_field_class_variant_with_selector *var_fc = (void *) fc;
1223 struct bt_field_class_variant_with_selector_option *opt = NULL;
1224 bool has_overlap;
1225
1226 BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1227 BT_ASSERT_PRE_NON_NULL(name, "Name");
1228 BT_ASSERT_PRE_NON_NULL(option_fc, "Option field class");
1229 BT_ASSERT_PRE_NON_NULL(range_set, "Range set");
1230 BT_ASSERT_PRE_FC_HAS_ID(fc, expected_type, "Field class");
1231 BT_ASSERT_PRE(range_set->ranges->len > 0,
1232 "Range set is empty: addr=%p", range_set);
1233 status = ranges_overlap(var_fc->common.common.named_fcs, range_set,
1234 expected_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR,
1235 &has_overlap);
1236 if (status) {
1237 /* ranges_overlap() logs errors */
1238 goto end;
1239 }
1240
1241 BT_ASSERT_PRE(!has_overlap,
1242 "Range set's ranges and existing ranges have an overlap: "
1243 "addr=%p", range_set);
1244 opt = create_variant_with_selector_option(name, option_fc, range_set);
1245 if (!opt) {
1246 /* create_variant_with_selector_option() logs errors */
1247 status = BT_FUNC_STATUS_MEMORY_ERROR;
1248 goto end;
1249 }
1250
1251 status = append_named_field_class_to_container_field_class((void *) fc,
1252 &opt->common);
1253 if (status == BT_FUNC_STATUS_OK) {
1254 /* Moved to the container */
1255 opt = NULL;
1256 }
1257
1258end:
1259 if (opt) {
1260 destroy_variant_with_selector_option(opt);
1261 }
1262
1263 return status;
1264}
1265
1266enum bt_field_class_variant_with_selector_append_option_status
1267bt_field_class_variant_with_unsigned_selector_append_option(
1268 struct bt_field_class *fc, const char *name,
1269 struct bt_field_class *option_fc,
1270 const struct bt_integer_range_set_unsigned *range_set)
1271{
1272 return append_option_to_variant_with_selector_field_class(fc,
1273 name, option_fc, (const void *) range_set,
1274 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR);
1275}
1276
1277enum bt_field_class_variant_with_selector_append_option_status
1278bt_field_class_variant_with_signed_selector_append_option(
1279 struct bt_field_class *fc, const char *name,
1280 struct bt_field_class *option_fc,
1281 const struct bt_integer_range_set_signed *range_set)
1282{
1283 return append_option_to_variant_with_selector_field_class(fc,
1284 name, option_fc, (const void *) range_set,
1285 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR);
1286}
1287
1288uint64_t bt_field_class_variant_get_option_count(const struct bt_field_class *fc)
1289{
1290 const struct bt_field_class_variant *var_fc = (const void *) fc;
1291
1292 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1293 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1294 return (uint64_t) var_fc->common.named_fcs->len;
1295}
1296
1297const struct bt_field_class_variant_option *
1298bt_field_class_variant_borrow_option_by_name_const(
1299 const struct bt_field_class *fc, const char *name)
1300{
1301 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1302 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1303 return (const void *)
1304 borrow_named_field_class_from_container_field_class_by_name(
1305 (void *) fc, name);
1306}
1307
1308const struct bt_field_class_variant_option *
1309bt_field_class_variant_borrow_option_by_index_const(
1310 const struct bt_field_class *fc, uint64_t index)
1311{
1312 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1313 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1314 return (const void *)
1315 borrow_named_field_class_from_container_field_class_at_index(
1316 (void *) fc, index);
1317}
1318
1319const struct bt_field_class_variant_with_unsigned_selector_option *
1320bt_field_class_variant_with_unsigned_selector_borrow_option_by_name_const(
1321 const struct bt_field_class *fc, const char *name)
1322{
1323 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1324 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1325 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR,
1326 "Field class");
1327 return (const void *)
1328 borrow_named_field_class_from_container_field_class_by_name(
1329 (void *) fc, name);
1330}
1331
1332const struct bt_field_class_variant_with_unsigned_selector_option *
1333bt_field_class_variant_with_unsigned_selector_borrow_option_by_index_const(
1334 const struct bt_field_class *fc, uint64_t index)
1335{
1336 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1337 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1338 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR,
1339 "Field class");
1340 return (const void *)
1341 borrow_named_field_class_from_container_field_class_at_index(
1342 (void *) fc, index);
1343}
1344
1345const struct bt_field_class_variant_with_signed_selector_option *
1346bt_field_class_variant_with_signed_selector_borrow_option_by_name_const(
1347 const struct bt_field_class *fc, const char *name)
1348{
1349 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1350 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1351 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR,
1352 "Field class");
1353 return (const void *)
1354 borrow_named_field_class_from_container_field_class_by_name(
1355 (void *) fc, name);
1356}
1357
1358const struct bt_field_class_variant_with_signed_selector_option *
1359bt_field_class_variant_with_signed_selector_borrow_option_by_index_const(
1360 const struct bt_field_class *fc, uint64_t index)
1361{
1362 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1363 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1364 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR,
1365 "Field class");
1366 return (const void *)
1367 borrow_named_field_class_from_container_field_class_at_index(
1368 (void *) fc, index);
1369}
1370
1371const char *bt_field_class_variant_option_get_name(
1372 const struct bt_field_class_variant_option *option)
1373{
1374 const struct bt_named_field_class *named_fc = (const void *) option;
1375
1376 BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1377 return named_fc->name->str;
1378}
1379
1380const struct bt_field_class *
1381bt_field_class_variant_option_borrow_field_class_const(
1382 const struct bt_field_class_variant_option *option)
1383{
1384 const struct bt_named_field_class *named_fc = (const void *) option;
1385
1386 BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1387 return named_fc->fc;
1388}
1389
1390const struct bt_integer_range_set_unsigned *
1391bt_field_class_variant_with_unsigned_selector_option_borrow_ranges_const(
1392 const struct bt_field_class_variant_with_unsigned_selector_option *option)
1393{
1394 const struct bt_field_class_variant_with_selector_option *opt =
1395 (const void *) option;
1396
1397 BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1398 return (const void *) opt->range_set;
1399}
1400
1401const struct bt_integer_range_set_signed *
1402bt_field_class_variant_with_signed_selector_option_borrow_ranges_const(
1403 const struct bt_field_class_variant_with_signed_selector_option *option)
1404{
1405 const struct bt_field_class_variant_with_selector_option *opt =
1406 (const void *) option;
1407
1408 BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1409 return (const void *) opt->range_set;
1410}
1411
1412const struct bt_field_path *
1413bt_field_class_variant_with_selector_borrow_selector_field_path_const(
1414 const struct bt_field_class *fc)
1415{
1416 const struct bt_field_class_variant_with_selector *var_fc =
1417 (const void *) fc;
1418
1419 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1420 BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(fc, "Field class");
1421 return var_fc->selector_field_path;
1422}
1423
1424static
1425void init_array_field_class(struct bt_field_class_array *fc,
1426 enum bt_field_class_type type, bt_object_release_func release_func,
1427 struct bt_field_class *element_fc)
1428{
1429 BT_ASSERT(element_fc);
1430 init_field_class((void *) fc, type, release_func);
1431 fc->element_fc = element_fc;
1432 bt_object_get_no_null_check(fc->element_fc);
1433 bt_field_class_freeze(element_fc);
1434}
1435
1436static
1437void finalize_array_field_class(struct bt_field_class_array *array_fc)
1438{
1439 BT_ASSERT(array_fc);
1440 BT_LOGD_STR("Putting element field class.");
1441 BT_OBJECT_PUT_REF_AND_RESET(array_fc->element_fc);
1442}
1443
1444static
1445void destroy_static_array_field_class(struct bt_object *obj)
1446{
1447 BT_ASSERT(obj);
1448 BT_LIB_LOGD("Destroying static array field class object: %!+F", obj);
1449 finalize_array_field_class((void *) obj);
1450 g_free(obj);
1451}
1452
1453struct bt_field_class *
1454bt_field_class_static_array_create(bt_trace_class *trace_class,
1455 struct bt_field_class *element_fc, uint64_t length)
1456{
1457 struct bt_field_class_static_array *array_fc = NULL;
1458
1459 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
1460 BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
1461 BT_LOGD_STR("Creating default static array field class object.");
1462 array_fc = g_new0(struct bt_field_class_static_array, 1);
1463 if (!array_fc) {
1464 BT_LIB_LOGE_APPEND_CAUSE(
1465 "Failed to allocate one static array field class.");
1466 goto error;
1467 }
1468
1469 init_array_field_class((void *) array_fc, BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
1470 destroy_static_array_field_class, element_fc);
1471 array_fc->length = length;
1472 BT_LIB_LOGD("Created static array field class object: %!+F", array_fc);
1473 goto end;
1474
1475error:
1476 BT_OBJECT_PUT_REF_AND_RESET(array_fc);
1477
1478end:
1479 return (void *) array_fc;
1480}
1481
1482const struct bt_field_class *
1483bt_field_class_array_borrow_element_field_class_const(
1484 const struct bt_field_class *fc)
1485{
1486 const struct bt_field_class_array *array_fc = (const void *) fc;
1487
1488 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1489 BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc, "Field class");
1490 return array_fc->element_fc;
1491}
1492
1493struct bt_field_class *
1494bt_field_class_array_borrow_element_field_class(struct bt_field_class *fc)
1495{
1496 struct bt_field_class_array *array_fc = (void *) fc;
1497
1498 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1499 BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc, "Field class");
1500 return array_fc->element_fc;
1501}
1502
1503uint64_t bt_field_class_static_array_get_length(const struct bt_field_class *fc)
1504{
1505 const struct bt_field_class_static_array *array_fc = (const void *) fc;
1506
1507 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1508 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
1509 "Field class");
1510 return (uint64_t) array_fc->length;
1511}
1512
1513static
1514void destroy_dynamic_array_field_class(struct bt_object *obj)
1515{
1516 struct bt_field_class_dynamic_array *fc = (void *) obj;
1517
1518 BT_ASSERT(fc);
1519 BT_LIB_LOGD("Destroying dynamic array field class object: %!+F", fc);
1520 finalize_array_field_class((void *) fc);
1521 BT_LOGD_STR("Putting length field path.");
1522 BT_OBJECT_PUT_REF_AND_RESET(fc->length_field_path);
1523 BT_LOGD_STR("Putting length field class.");
1524 BT_OBJECT_PUT_REF_AND_RESET(fc->length_fc);
1525 g_free(fc);
1526}
1527
1528struct bt_field_class *bt_field_class_dynamic_array_create(
1529 struct bt_trace_class *trace_class,
1530 struct bt_field_class *element_fc,
1531 struct bt_field_class *length_fc)
1532{
1533 struct bt_field_class_dynamic_array *array_fc = NULL;
1534
1535 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
1536 BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
1537 BT_LOGD_STR("Creating default dynamic array field class object.");
1538 array_fc = g_new0(struct bt_field_class_dynamic_array, 1);
1539 if (!array_fc) {
1540 BT_LIB_LOGE_APPEND_CAUSE(
1541 "Failed to allocate one dynamic array field class.");
1542 goto error;
1543 }
1544
1545 init_array_field_class((void *) array_fc,
1546 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
1547 destroy_dynamic_array_field_class, element_fc);
1548
1549 if (length_fc) {
1550 BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(length_fc,
1551 "Length field class");
1552 array_fc->length_fc = length_fc;
1553 bt_object_get_no_null_check(array_fc->length_fc);
1554 bt_field_class_freeze(length_fc);
1555 }
1556
1557 BT_LIB_LOGD("Created dynamic array field class object: %!+F", array_fc);
1558 goto end;
1559
1560error:
1561 BT_OBJECT_PUT_REF_AND_RESET(array_fc);
1562
1563end:
1564 return (void *) array_fc;
1565}
1566
1567const struct bt_field_path *
1568bt_field_class_dynamic_array_borrow_length_field_path_const(
1569 const struct bt_field_class *fc)
1570{
1571 const struct bt_field_class_dynamic_array *seq_fc = (const void *) fc;
1572
1573 BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1574 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
1575 "Field class");
1576 return seq_fc->length_field_path;
1577}
1578
1579static
1580void destroy_string_field_class(struct bt_object *obj)
1581{
1582 BT_ASSERT(obj);
1583 BT_LIB_LOGD("Destroying string field class object: %!+F", obj);
1584 g_free(obj);
1585}
1586
1587struct bt_field_class *bt_field_class_string_create(bt_trace_class *trace_class)
1588{
1589 struct bt_field_class_string *string_fc = NULL;
1590
1591 BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
1592 BT_LOGD_STR("Creating default string field class object.");
1593 string_fc = g_new0(struct bt_field_class_string, 1);
1594 if (!string_fc) {
1595 BT_LIB_LOGE_APPEND_CAUSE(
1596 "Failed to allocate one string field class.");
1597 goto error;
1598 }
1599
1600 init_field_class((void *) string_fc, BT_FIELD_CLASS_TYPE_STRING,
1601 destroy_string_field_class);
1602 BT_LIB_LOGD("Created string field class object: %!+F", string_fc);
1603 goto end;
1604
1605error:
1606 BT_OBJECT_PUT_REF_AND_RESET(string_fc);
1607
1608end:
1609 return (void *) string_fc;
1610}
1611
1612BT_HIDDEN
1613void _bt_field_class_freeze(const struct bt_field_class *c_fc)
1614{
1615 struct bt_field_class *fc = (void *) c_fc;
1616
1617 /*
1618 * Element/member/option field classes are frozen when added to
1619 * their owner.
1620 */
1621 BT_ASSERT(fc);
1622 fc->frozen = true;
1623
1624 switch (fc->type) {
1625 case BT_FIELD_CLASS_TYPE_STRUCTURE:
1626 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
1627 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR:
1628 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR:
1629 {
1630 struct bt_field_class_named_field_class_container *container_fc =
1631 (void *) fc;
1632 uint64_t i;
1633
1634 for (i = 0; i < container_fc->named_fcs->len; i++) {
1635 bt_named_field_class_freeze(
1636 container_fc->named_fcs->pdata[i]);
1637 }
1638
1639 break;
1640 }
1641 default:
1642 break;
1643 }
1644}
1645
1646BT_HIDDEN
1647void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc)
1648{
1649 BT_ASSERT(named_fc);
1650 ((struct bt_named_field_class *) named_fc)->frozen = true;
1651 bt_field_class_freeze(named_fc->fc);
1652}
1653
1654BT_HIDDEN
1655void bt_field_class_make_part_of_trace_class(const struct bt_field_class *c_fc)
1656{
1657 struct bt_field_class *fc = (void *) c_fc;
1658
1659 BT_ASSERT(fc);
1660 BT_ASSERT_PRE(!fc->part_of_trace_class,
1661 "Field class is already part of a trace: %!+F", fc);
1662 fc->part_of_trace_class = true;
1663
1664 switch (fc->type) {
1665 case BT_FIELD_CLASS_TYPE_STRUCTURE:
1666 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
1667 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR:
1668 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR:
1669 {
1670 struct bt_field_class_named_field_class_container *container_fc =
1671 (void *) fc;
1672 uint64_t i;
1673
1674 for (i = 0; i < container_fc->named_fcs->len; i++) {
1675 struct bt_named_field_class *named_fc =
1676 container_fc->named_fcs->pdata[i];
1677
1678 bt_field_class_make_part_of_trace_class(named_fc->fc);
1679 }
1680
1681 break;
1682 }
1683 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
1684 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
1685 {
1686 struct bt_field_class_array *array_fc = (void *) fc;
1687
1688 bt_field_class_make_part_of_trace_class(array_fc->element_fc);
1689 break;
1690 }
1691 default:
1692 break;
1693 }
1694}
1695
1696void bt_field_class_get_ref(const struct bt_field_class *field_class)
1697{
1698 bt_object_get_ref(field_class);
1699}
1700
1701void bt_field_class_put_ref(const struct bt_field_class *field_class)
1702{
1703 bt_object_put_ref(field_class);
1704}
BabelTrace - Trace Format Babel Tower
This page took 0.029263 seconds and 4 git commands to generate.