include/babeltrace2/trace-ir/field-class.h

   1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
   2 #define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <stdint.h>
  31 #include <stddef.h>
  32
  33 #include <babeltrace2/types.h>
  34 #include <babeltrace2/trace-ir/field-class-const.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 extern bt_field_class *bt_field_class_unsigned_integer_create(
  41                 bt_trace_class *trace_class);
  42
  43 extern bt_field_class *bt_field_class_signed_integer_create(
  44                 bt_trace_class *trace_class);
  45
  46 extern void bt_field_class_integer_set_field_value_range(
  47                 bt_field_class *field_class, uint64_t size);
  48
  49 extern void bt_field_class_integer_set_preferred_display_base(
  50                 bt_field_class *field_class,
  51                 bt_field_class_integer_preferred_display_base base);
  52
  53 extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);
  54
  55 extern void bt_field_class_real_set_is_single_precision(
  56                 bt_field_class *field_class,
  57                 bt_bool is_single_precision);
  58
  59 extern bt_field_class *bt_field_class_unsigned_enumeration_create(
  60                 bt_trace_class *trace_class);
  61
  62 extern bt_field_class *bt_field_class_signed_enumeration_create(
  63                 bt_trace_class *trace_class);
  64
  65 typedef enum bt_field_class_enumeration_add_mapping_status {
  66         BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  67         BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_OK                = __BT_FUNC_STATUS_OK,
  68 } bt_field_class_enumeration_add_mapping_status;
  69
  70 extern bt_field_class_enumeration_add_mapping_status
  71 bt_field_class_unsigned_enumeration_add_mapping(
  72                 bt_field_class *field_class, const char *label,
  73                 const bt_integer_range_set_unsigned *range_set);
  74
  75 extern bt_field_class_enumeration_add_mapping_status
  76 bt_field_class_signed_enumeration_add_mapping(
  77                 bt_field_class *field_class, const char *label,
  78                 const bt_integer_range_set_signed *range_set);
  79
  80 extern bt_field_class *bt_field_class_string_create(
  81                 bt_trace_class *trace_class);
  82
  83 extern bt_field_class *bt_field_class_structure_create(
  84                 bt_trace_class *trace_class);
  85
  86 typedef enum bt_field_class_structure_append_member_status {
  87         BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  88         BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK                = __BT_FUNC_STATUS_OK,
  89 } bt_field_class_structure_append_member_status;
  90
  91 extern bt_field_class_structure_append_member_status
  92 bt_field_class_structure_append_member(
  93                 bt_field_class *struct_field_class,
  94                 const char *name, bt_field_class *field_class);
  95
  96 extern bt_field_class_structure_member *
  97 bt_field_class_structure_borrow_member_by_index(
  98                 bt_field_class *field_class, uint64_t index);
  99
 100 extern bt_field_class_structure_member *
 101 bt_field_class_structure_borrow_member_by_name(
 102                 bt_field_class *field_class, const char *name);
 103
 104 extern bt_field_class *bt_field_class_static_array_create(
 105                 bt_trace_class *trace_class,
 106                 bt_field_class *elem_field_class, uint64_t length);
 107
 108 extern bt_field_class *bt_field_class_dynamic_array_create(
 109                 bt_trace_class *trace_class,
 110                 bt_field_class *elem_field_class);
 111
 112 extern bt_field_class *bt_field_class_array_borrow_element_field_class(
 113                 bt_field_class *field_class);
 114
 115 typedef enum bt_field_class_dynamic_array_set_length_field_class_status {
 116         BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 117         BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK           = __BT_FUNC_STATUS_OK,
 118 } bt_field_class_dynamic_array_set_length_field_class_status;
 119
 120 extern bt_field_class_dynamic_array_set_length_field_class_status
 121 bt_field_class_dynamic_array_set_length_field_class(
 122                 bt_field_class *field_class,
 123                 bt_field_class *length_field_class);
 124
 125 extern bt_field_class *bt_field_class_variant_create(
 126                 bt_trace_class *trace_class,
 127                 bt_field_class *selector_field_class);
 128
 129 typedef enum bt_field_class_variant_without_selector_append_option_status {
 130         BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR       = __BT_FUNC_STATUS_MEMORY_ERROR,
 131         BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_OK                 = __BT_FUNC_STATUS_OK,
 132 } bt_field_class_variant_without_selector_append_option_status;
 133
 134 extern bt_field_class_variant_without_selector_append_option_status
 135 bt_field_class_variant_without_selector_append_option(
 136                 bt_field_class *var_field_class, const char *name,
 137                 bt_field_class *field_class);
 138
 139 typedef enum bt_field_class_variant_with_selector_append_option_status {
 140         BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 141         BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_OK            = __BT_FUNC_STATUS_OK,
 142 } bt_field_class_variant_with_selector_append_option_status;
 143
 144 extern bt_field_class_variant_with_selector_append_option_status
 145 bt_field_class_variant_with_unsigned_selector_append_option(
 146                 bt_field_class *var_field_class, const char *name,
 147                 bt_field_class *field_class,
 148                 const bt_integer_range_set_unsigned *range_set);
 149
 150 extern bt_field_class_variant_with_selector_append_option_status
 151 bt_field_class_variant_with_signed_selector_append_option(
 152                 bt_field_class *var_field_class, const char *name,
 153                 bt_field_class *field_class,
 154                 const bt_integer_range_set_signed *range_set);
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */