src/plugins/lttng-utils/debug-info/trace-ir-mapping.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2019 Francis Deslauriers francis.deslauriers@efficios.com>
   5  */
   6
   7 #ifndef BABELTRACE_PLUGIN_DEBUG_INFO_TRACE_IR_MAPPING_H
   8 #define BABELTRACE_PLUGIN_DEBUG_INFO_TRACE_IR_MAPPING_H
   9
  10 #include <glib.h>
  11
  12 #include "common/assert.h"
  13 #include "common/macros.h"
  14 #include <babeltrace2/babeltrace.h>
  15
  16 #include "debug-info.h"
  17
  18 enum debug_info_trace_ir_mapping_status {
  19         DEBUG_INFO_TRACE_IR_MAPPING_STATUS_OK = 0,
  20         DEBUG_INFO_TRACE_IR_MAPPING_STATUS_MEMORY_ERROR = -12,
  21 };
  22
  23 /* Used to resolve field paths for dynamic arrays and variant field classes. */
  24 struct field_class_resolving_context {
  25         /* Weak reference. Owned by input stream class. */
  26         const bt_field_class *packet_context;
  27         /* Weak reference. Owned by input stream class. */
  28         const bt_field_class *event_common_context;
  29         /* Weak reference. Owned by input event class. */
  30         const bt_field_class *event_specific_context;
  31         /* Weak reference. Owned by input event class. */
  32         const bt_field_class *event_payload;
  33 };
  34
  35 struct trace_ir_metadata_maps {
  36         bt_logging_level log_level;
  37         bt_self_component *self_comp;
  38         const bt_trace_class *input_trace_class;
  39         bt_trace_class *output_trace_class;
  40
  41         /*
  42          * Map between input stream class and its corresponding output stream
  43          * class.
  44          * input stream class: weak reference. Owned by an upstream
  45          * component.
  46          * output stream class: owned by this structure.
  47          */
  48         GHashTable *stream_class_map;
  49
  50         /*
  51          * Map between input event class and its corresponding output event
  52          * class.
  53          * input event class: weak reference. Owned by an upstream component.
  54          * output event class: owned by this structure.
  55          */
  56         GHashTable *event_class_map;
  57
  58         /*
  59          * Map between input field class and its corresponding output field
  60          * class.
  61          * input field class: weak reference. Owned by an upstream component.
  62          * output field class: owned by this structure.
  63          */
  64         GHashTable *field_class_map;
  65
  66         /*
  67          * Map between input clock class and its corresponding output clock
  68          * class.
  69          * input clock class: weak reference. Owned by an upstream component.
  70          * output clock class: owned by this structure.
  71          */
  72         GHashTable *clock_class_map;
  73
  74         struct field_class_resolving_context *fc_resolving_ctx;
  75
  76         bt_listener_id destruction_listener_id;
  77 };
  78
  79 struct trace_ir_data_maps {
  80         bt_logging_level log_level;
  81         bt_self_component *self_comp;
  82         const bt_trace *input_trace;
  83         bt_trace *output_trace;
  84
  85         /*
  86          * Map between input stream its corresponding output stream.
  87          * input stream: weak reference. Owned by an upstream component.
  88          * output stream: owned by this structure.
  89          */
  90         GHashTable *stream_map;
  91
  92         /*
  93          * Map between input packet its corresponding output packet.
  94          * input packet: weak reference. Owned by an upstream packet component.
  95          * output packet: owned by this structure.
  96          */
  97         GHashTable *packet_map;
  98
  99         bt_listener_id destruction_listener_id;
 100 };
 101
 102 struct trace_ir_maps {
 103         bt_logging_level log_level;
 104
 105         /*
 106          * input trace -> trace_ir_data_maps.
 107          * input trace: weak reference. Owned by an upstream component.
 108          * trace_ir_data_maps: Owned by this structure.
 109          */
 110         GHashTable *data_maps;
 111
 112         /*
 113          * input trace class -> trace_ir_metadata_maps.
 114          * input trace class: weak reference. Owned by an upstream component.
 115          * trace_ir_metadata_maps: Owned by this structure.
 116          */
 117         GHashTable *metadata_maps;
 118
 119         char *debug_info_field_class_name;
 120
 121         bt_self_component *self_comp;
 122 };
 123
 124 struct trace_ir_maps *trace_ir_maps_create(bt_self_component *self_comp,
 125                 const char *debug_info_field_name, bt_logging_level log_level);
 126
 127 void trace_ir_maps_clear(struct trace_ir_maps *maps);
 128
 129 void trace_ir_maps_destroy(struct trace_ir_maps *maps);
 130
 131 struct trace_ir_data_maps *trace_ir_data_maps_create(
 132                 struct trace_ir_maps *ir_maps,
 133                 const bt_trace *in_trace);
 134
 135 void trace_ir_data_maps_destroy(struct trace_ir_data_maps *d_maps);
 136
 137 struct trace_ir_metadata_maps *trace_ir_metadata_maps_create(
 138                 struct trace_ir_maps *ir_maps,
 139                 const bt_trace_class *in_trace_class);
 140
 141 void trace_ir_metadata_maps_destroy(struct trace_ir_metadata_maps *md_maps);
 142
 143 bt_stream_class *trace_ir_mapping_create_new_mapped_stream_class(
 144                 struct trace_ir_maps *ir_maps,
 145                 const bt_stream_class *in_stream_class);
 146
 147 bt_stream_class *trace_ir_mapping_borrow_mapped_stream_class(
 148                 struct trace_ir_maps *ir_maps,
 149                 const bt_stream_class *in_stream_class);
 150
 151 bt_stream *trace_ir_mapping_create_new_mapped_stream(
 152                 struct trace_ir_maps *ir_maps,
 153                 const bt_stream *in_stream);
 154
 155 bt_stream *trace_ir_mapping_borrow_mapped_stream(
 156                 struct trace_ir_maps *ir_maps,
 157                 const bt_stream *in_stream);
 158
 159 void trace_ir_mapping_remove_mapped_stream(
 160                 struct trace_ir_maps *ir_maps,
 161                 const bt_stream *in_stream);
 162
 163 bt_event_class *trace_ir_mapping_create_new_mapped_event_class(
 164                 struct trace_ir_maps *ir_maps,
 165                 const bt_event_class *in_event_class);
 166
 167 bt_event_class *trace_ir_mapping_borrow_mapped_event_class(
 168                 struct trace_ir_maps *ir_maps,
 169                 const bt_event_class *in_event_class);
 170
 171 bt_packet *trace_ir_mapping_create_new_mapped_packet(
 172                 struct trace_ir_maps *ir_maps,
 173                 const bt_packet *in_packet);
 174
 175 bt_packet *trace_ir_mapping_borrow_mapped_packet(
 176                 struct trace_ir_maps *ir_maps,
 177                 const bt_packet *in_packet);
 178
 179 void trace_ir_mapping_remove_mapped_packet(
 180                 struct trace_ir_maps *ir_maps,
 181                 const bt_packet *in_packet);
 182
 183 static inline
 184 struct trace_ir_data_maps *borrow_data_maps_from_input_trace(
 185                 struct trace_ir_maps *ir_maps, const bt_trace *in_trace)
 186 {
 187         BT_ASSERT(ir_maps);
 188         BT_ASSERT(in_trace);
 189
 190         struct trace_ir_data_maps *d_maps =
 191                 g_hash_table_lookup(ir_maps->data_maps, (gpointer) in_trace);
 192         if (!d_maps) {
 193                 d_maps = trace_ir_data_maps_create(ir_maps, in_trace);
 194                 g_hash_table_insert(ir_maps->data_maps, (gpointer) in_trace, d_maps);
 195         }
 196
 197         return d_maps;
 198 }
 199
 200 static inline
 201 struct trace_ir_data_maps *borrow_data_maps_from_input_stream(
 202                 struct trace_ir_maps *ir_maps, const bt_stream *in_stream)
 203 {
 204         BT_ASSERT(ir_maps);
 205         BT_ASSERT(in_stream);
 206
 207         return borrow_data_maps_from_input_trace(ir_maps,
 208                         bt_stream_borrow_trace_const(in_stream));
 209 }
 210
 211 static inline
 212 struct trace_ir_data_maps *borrow_data_maps_from_input_packet(
 213                 struct trace_ir_maps *ir_maps, const bt_packet *in_packet)
 214 {
 215         BT_ASSERT(ir_maps);
 216         BT_ASSERT(in_packet);
 217
 218         return borrow_data_maps_from_input_stream(ir_maps,
 219                         bt_packet_borrow_stream_const(in_packet));
 220 }
 221
 222 static inline
 223 struct trace_ir_metadata_maps *borrow_metadata_maps_from_input_trace_class(
 224                 struct trace_ir_maps *ir_maps,
 225                 const bt_trace_class *in_trace_class)
 226 {
 227         BT_ASSERT(ir_maps);
 228         BT_ASSERT(in_trace_class);
 229
 230         struct trace_ir_metadata_maps *md_maps =
 231                 g_hash_table_lookup(ir_maps->metadata_maps,
 232                                 (gpointer) in_trace_class);
 233         if (!md_maps) {
 234                 md_maps = trace_ir_metadata_maps_create(ir_maps, in_trace_class);
 235                 g_hash_table_insert(ir_maps->metadata_maps,
 236                                 (gpointer) in_trace_class, md_maps);
 237         }
 238
 239         return md_maps;
 240 }
 241
 242 static inline
 243 struct trace_ir_metadata_maps *borrow_metadata_maps_from_input_stream_class(
 244                 struct trace_ir_maps *ir_maps,
 245                 const bt_stream_class *in_stream_class) {
 246
 247         BT_ASSERT(in_stream_class);
 248
 249         return borrow_metadata_maps_from_input_trace_class(ir_maps,
 250                         bt_stream_class_borrow_trace_class_const(in_stream_class));
 251 }
 252
 253 static inline
 254 struct trace_ir_metadata_maps *borrow_metadata_maps_from_input_event_class(
 255                 struct trace_ir_maps *ir_maps,
 256                 const bt_event_class *in_event_class) {
 257
 258         BT_ASSERT(in_event_class);
 259
 260         return borrow_metadata_maps_from_input_stream_class(ir_maps,
 261                         bt_event_class_borrow_stream_class_const(in_event_class));
 262 }
 263
 264 #endif /* BABELTRACE_PLUGIN_DEBUG_INFO_TRACE_IR_MAPPING_H */