1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
2 #define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
30 #ifndef __BT_IN_BABELTRACE_H
31 # error "Please include <babeltrace2/babeltrace.h> instead."
37 /* For bt_bool, bt_field_class, bt_trace_class */
38 #include <babeltrace2/types.h>
40 /* For bt_field_class_integer_preferred_display_base */
41 #include <babeltrace2/trace-ir/field-class-const.h>
47 extern bt_field_class
*bt_field_class_unsigned_integer_create(
48 bt_trace_class
*trace_class
);
50 extern bt_field_class
*bt_field_class_signed_integer_create(
51 bt_trace_class
*trace_class
);
53 extern void bt_field_class_integer_set_field_value_range(
54 bt_field_class
*field_class
, uint64_t size
);
56 extern void bt_field_class_integer_set_preferred_display_base(
57 bt_field_class
*field_class
,
58 bt_field_class_integer_preferred_display_base base
);
60 extern bt_field_class
*bt_field_class_real_create(bt_trace_class
*trace_class
);
62 extern void bt_field_class_real_set_is_single_precision(
63 bt_field_class
*field_class
,
64 bt_bool is_single_precision
);
66 extern bt_field_class
*bt_field_class_unsigned_enumeration_create(
67 bt_trace_class
*trace_class
);
69 extern bt_field_class
*bt_field_class_signed_enumeration_create(
70 bt_trace_class
*trace_class
);
72 typedef enum bt_field_class_enumeration_map_range_status
{
73 BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
74 BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
75 } bt_field_class_enumeration_map_range_status
;
77 extern bt_field_class_enumeration_map_range_status
78 bt_field_class_unsigned_enumeration_map_range(
79 bt_field_class
*field_class
, const char *label
,
80 uint64_t range_lower
, uint64_t range_upper
);
82 extern bt_field_class_enumeration_map_range_status
83 bt_field_class_signed_enumeration_map_range(
84 bt_field_class
*field_class
, const char *label
,
85 int64_t range_lower
, int64_t range_upper
);
87 extern bt_field_class
*bt_field_class_string_create(
88 bt_trace_class
*trace_class
);
90 extern bt_field_class
*bt_field_class_structure_create(
91 bt_trace_class
*trace_class
);
93 typedef enum bt_field_class_structure_append_member_status
{
94 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
95 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
= __BT_FUNC_STATUS_OK
,
96 } bt_field_class_structure_append_member_status
;
98 extern bt_field_class_structure_append_member_status
99 bt_field_class_structure_append_member(
100 bt_field_class
*struct_field_class
,
101 const char *name
, bt_field_class
*field_class
);
103 extern bt_field_class_structure_member
*
104 bt_field_class_structure_borrow_member_by_index(
105 bt_field_class
*field_class
, uint64_t index
);
107 extern bt_field_class_structure_member
*
108 bt_field_class_structure_borrow_member_by_name(
109 bt_field_class
*field_class
, const char *name
);
111 extern bt_field_class
*bt_field_class_static_array_create(
112 bt_trace_class
*trace_class
,
113 bt_field_class
*elem_field_class
, uint64_t length
);
115 extern bt_field_class
*bt_field_class_dynamic_array_create(
116 bt_trace_class
*trace_class
,
117 bt_field_class
*elem_field_class
);
119 extern bt_field_class
*bt_field_class_array_borrow_element_field_class(
120 bt_field_class
*field_class
);
122 typedef enum bt_field_class_dynamic_array_set_length_field_class_status
{
123 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
124 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK
= __BT_FUNC_STATUS_OK
,
125 } bt_field_class_dynamic_array_set_length_field_class_status
;
127 extern bt_field_class_dynamic_array_set_length_field_class_status
128 bt_field_class_dynamic_array_set_length_field_class(
129 bt_field_class
*field_class
,
130 bt_field_class
*length_field_class
);
132 extern bt_field_class
*bt_field_class_variant_create(
133 bt_trace_class
*trace_class
);
135 typedef enum bt_field_class_variant_set_selector_field_class_status
{
136 BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
137 BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_OK
= __BT_FUNC_STATUS_OK
,
138 } bt_field_class_variant_set_selector_field_class_status
;
140 extern bt_field_class_variant_set_selector_field_class_status
141 bt_field_class_variant_set_selector_field_class(bt_field_class
*field_class
,
142 bt_field_class
*selector_field_class
);
144 typedef enum bt_field_class_variant_append_option_status
{
145 BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
146 BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_OK
= __BT_FUNC_STATUS_OK
,
147 } bt_field_class_variant_append_option_status
;
149 extern bt_field_class_variant_append_option_status
150 bt_field_class_variant_append_option(
151 bt_field_class
*var_field_class
,
152 const char *name
, bt_field_class
*field_class
);
154 extern bt_field_class_variant_option
*
155 bt_field_class_variant_borrow_option_by_index(
156 bt_field_class
*field_class
, uint64_t index
);
158 extern bt_field_class_variant_option
*
159 bt_field_class_variant_borrow_option_by_name(
160 bt_field_class
*field_class
, const char *name
);
162 extern bt_field_class
*bt_field_class_variant_option_borrow_field_class(
163 bt_field_class_variant_option
*option
);
169 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */