src/plugins/lttng-utils/debug-info/trace-ir-data-copy.c

   1 /*
   2  * Babeltrace - Trace IR data object copy
   3  *
   4  * Copyright (c) 2015-2019 EfficiOS Inc. and Linux Foundation
   5  * Copyright (c) 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
   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 #define BT_COMP_LOG_SELF_COMP self_comp
  27 #define BT_LOG_OUTPUT_LEVEL log_level
  28 #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO/TRACE-IR-DATA-COPY"
  29 #include "logging/comp-logging.h"
  30
  31 #include <inttypes.h>
  32 #include <stdint.h>
  33
  34 #include "common/assert.h"
  35
  36 #include "trace-ir-data-copy.h"
  37
  38 BT_HIDDEN
  39 void copy_trace_content(const bt_trace *in_trace, bt_trace *out_trace,
  40                 bt_logging_level log_level, bt_self_component *self_comp)
  41 {
  42         bt_trace_set_name_status status;
  43         const char *trace_name;
  44         uint64_t i, env_field_count;
  45
  46         BT_COMP_LOGD("Copying content of trace: in-t-addr=%p, out-t-addr=%p",
  47                         in_trace, out_trace);
  48         trace_name = bt_trace_get_name(in_trace);
  49         /* Copy the trace name. */
  50         if (trace_name) {
  51                 status = bt_trace_set_name(out_trace, trace_name);
  52                 if (status != BT_TRACE_SET_NAME_STATUS_OK) {
  53                         BT_COMP_LOGE("Cannot set trace's name: trace-addr=%p, name=\"%s\"",
  54                                 out_trace, trace_name);
  55                         bt_current_thread_clear_error();
  56                         goto end;
  57                 }
  58         }
  59
  60         /*
  61          * Do not copy the trace UUID as it may be modified and should
  62          * no longer have the same UUID.
  63          */
  64
  65         /*
  66          * Go over all the entries in the environment section of the
  67          * trace and copy the content to the new trace.
  68          */
  69         env_field_count = bt_trace_get_environment_entry_count(in_trace);
  70         for (i = 0; i < env_field_count; i++) {
  71                 const char *value_name;
  72                 const bt_value *value = NULL;
  73                 bt_trace_set_environment_entry_status set_env_status;
  74
  75                 bt_trace_borrow_environment_entry_by_index_const(
  76                         in_trace, i, &value_name, &value);
  77
  78                 BT_COMP_LOGD("Copying trace environnement entry: "
  79                         "index=%" PRId64 ", value-addr=%p, value-name=%s",
  80                         i, value, value_name);
  81
  82                 BT_ASSERT(value_name);
  83                 BT_ASSERT(value);
  84
  85                 if (bt_value_is_signed_integer(value)) {
  86                         set_env_status =
  87                                 bt_trace_set_environment_entry_integer(
  88                                                 out_trace, value_name,
  89                                                 bt_value_integer_signed_get(
  90                                                         value));
  91                 } else if (bt_value_is_string(value)) {
  92                         set_env_status =
  93                                 bt_trace_set_environment_entry_string(
  94                                         out_trace, value_name,
  95                                         bt_value_string_get(value));
  96                 } else {
  97                         abort();
  98                 }
  99
 100                 if (set_env_status !=
 101                                 BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_OK) {
 102                         BT_COMP_LOGE("Cannot copy trace's environment: "
 103                                 "trace-addr=%p, name=\"%s\"",
 104                                 out_trace, trace_name);
 105                         bt_current_thread_clear_error();
 106                         goto end;
 107                 }
 108         }
 109
 110         BT_COMP_LOGD("Copied content of trace: in-t-addr=%p, out-t-addr=%p",
 111                         in_trace, out_trace);
 112 end:
 113         return;
 114 }
 115
 116 BT_HIDDEN
 117 void copy_stream_content(const bt_stream *in_stream, bt_stream *out_stream,
 118                 bt_logging_level log_level, bt_self_component *self_comp)
 119 {
 120         const char *stream_name;
 121         bt_stream_set_name_status status;
 122
 123         BT_COMP_LOGD("Copying content of stream: in-s-addr=%p, out-s-addr=%p",
 124                         in_stream, out_stream);
 125
 126         stream_name = bt_stream_get_name(in_stream);
 127         if (stream_name) {
 128                 status = bt_stream_set_name(out_stream, stream_name);
 129                 if (status != BT_STREAM_SET_NAME_STATUS_OK) {
 130                         BT_COMP_LOGE("Cannot set stream's name: stream-addr=%p, "
 131                                 "name=%s", out_stream, stream_name);
 132                         goto end;
 133                 }
 134         }
 135
 136         BT_COMP_LOGD("Copied content of stream: in-s-addr=%p, out-s-addr=%p",
 137                         in_stream, out_stream);
 138 end:
 139         return;
 140 }
 141
 142 BT_HIDDEN
 143 void copy_packet_content(const bt_packet *in_packet, bt_packet *out_packet,
 144                 bt_logging_level log_level, bt_self_component *self_comp)
 145 {
 146         const bt_field *in_context_field;
 147         bt_field *out_context_field;
 148
 149         BT_COMP_LOGD("Copying content of packet: in-p-addr=%p, out-p-addr=%p",
 150                         in_packet, out_packet);
 151
 152         /* Copy context field. */
 153         in_context_field = bt_packet_borrow_context_field_const(in_packet);
 154         if (in_context_field) {
 155                 out_context_field = bt_packet_borrow_context_field(out_packet);
 156                 BT_ASSERT(out_context_field);
 157                 copy_field_content(in_context_field, out_context_field,
 158                         log_level, self_comp);
 159         }
 160
 161         BT_COMP_LOGD("Copied content of packet: in-p-addr=%p, out-p-addr=%p",
 162                         in_packet, out_packet);
 163         return;
 164 }
 165
 166 BT_HIDDEN
 167 void copy_event_content(const bt_event *in_event, bt_event *out_event,
 168                 bt_logging_level log_level, bt_self_component *self_comp)
 169 {
 170         const bt_field *in_common_ctx_field, *in_specific_ctx_field,
 171               *in_payload_field;
 172         bt_field *out_common_ctx_field, *out_specific_ctx_field,
 173                  *out_payload_field;
 174
 175         BT_COMP_LOGD("Copying content of event: in-e-addr=%p, out-e-addr=%p",
 176                         in_event, out_event);
 177         in_common_ctx_field =
 178                 bt_event_borrow_common_context_field_const(in_event);
 179         if (in_common_ctx_field) {
 180                 out_common_ctx_field =
 181                         bt_event_borrow_common_context_field(out_event);
 182                 BT_ASSERT(out_common_ctx_field);
 183                 copy_field_content(in_common_ctx_field,
 184                         out_common_ctx_field, log_level, self_comp);
 185         }
 186
 187         in_specific_ctx_field =
 188                 bt_event_borrow_specific_context_field_const(in_event);
 189         if (in_specific_ctx_field) {
 190                 out_specific_ctx_field =
 191                         bt_event_borrow_specific_context_field(out_event);
 192                 BT_ASSERT(out_specific_ctx_field);
 193                 copy_field_content(in_specific_ctx_field,
 194                         out_specific_ctx_field, log_level, self_comp);
 195         }
 196
 197         in_payload_field = bt_event_borrow_payload_field_const(in_event);
 198         if (in_payload_field) {
 199                 out_payload_field = bt_event_borrow_payload_field(out_event);
 200                 BT_ASSERT(out_payload_field);
 201                 copy_field_content(in_payload_field,
 202                         out_payload_field, log_level, self_comp);
 203         }
 204
 205         BT_COMP_LOGD("Copied content of event: in-e-addr=%p, out-e-addr=%p",
 206                         in_event, out_event);
 207 }
 208
 209 BT_HIDDEN
 210 void copy_field_content(const bt_field *in_field, bt_field *out_field,
 211                 bt_logging_level log_level, bt_self_component *self_comp)
 212 {
 213         bt_field_class_type in_fc_type, out_fc_type;
 214
 215         in_fc_type = bt_field_get_class_type(in_field);
 216         out_fc_type = bt_field_get_class_type(out_field);
 217         BT_ASSERT(in_fc_type == out_fc_type);
 218
 219         BT_COMP_LOGT("Copying content of field: in-f-addr=%p, out-f-addr=%p",
 220                         in_field, out_field);
 221         switch (in_fc_type) {
 222         case BT_FIELD_CLASS_TYPE_BOOL:
 223                 bt_field_bool_set_value(out_field,
 224                         bt_field_bool_get_value(in_field));
 225                 break;
 226         case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
 227                 bt_field_bit_array_set_value_as_integer(out_field,
 228                         bt_field_bit_array_get_value_as_integer(in_field));
 229                 break;
 230         case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
 231         case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
 232                 bt_field_integer_unsigned_set_value(out_field,
 233                                 bt_field_integer_unsigned_get_value(in_field));
 234                 break;
 235         case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
 236         case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
 237                 bt_field_integer_signed_set_value(out_field,
 238                                 bt_field_integer_signed_get_value(in_field));
 239                 break;
 240         case BT_FIELD_CLASS_TYPE_REAL:
 241                 bt_field_real_set_value(out_field,
 242                                 bt_field_real_get_value(in_field));
 243                 break;
 244         case BT_FIELD_CLASS_TYPE_STRING:
 245         {
 246                 const char *str = bt_field_string_get_value(in_field);
 247                 bt_field_string_set_value_status status =
 248                         bt_field_string_set_value(out_field, str);
 249                 if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) {
 250                         BT_COMP_LOGE("Cannot set string field's value: "
 251                                 "str-field-addr=%p, str=%s" PRId64,
 252                                 out_field, str);
 253                         bt_current_thread_clear_error();
 254
 255                 }
 256                 break;
 257         }
 258         case BT_FIELD_CLASS_TYPE_STRUCTURE:
 259         {
 260                 uint64_t i, nb_member_struct;
 261                 const bt_field *in_member_field;
 262                 bt_field *out_member_field;
 263                 const bt_field_class *in_field_class;
 264                 const char *in_member_name;
 265
 266                 in_field_class = bt_field_borrow_class_const(in_field);
 267                 nb_member_struct = bt_field_class_structure_get_member_count(
 268                                 in_field_class);
 269
 270                 /*
 271                  * Iterate over the fields by names in the input field to avoid
 272                  * problem if the struct fields are not in the same order after
 273                  * the debug-info was added.
 274                  */
 275                 for (i = 0; i < nb_member_struct; i++) {
 276                         const bt_field_class_structure_member *member =
 277                                 bt_field_class_structure_borrow_member_by_index_const(
 278                                         in_field_class, i);
 279
 280                         in_member_name =
 281                                 bt_field_class_structure_member_get_name(
 282                                         member);
 283                         in_member_field =
 284                                 bt_field_structure_borrow_member_field_by_name_const(
 285                                                 in_field, in_member_name);
 286                         out_member_field =
 287                                 bt_field_structure_borrow_member_field_by_name(
 288                                                 out_field, in_member_name);
 289
 290                         copy_field_content(in_member_field,
 291                                 out_member_field, log_level, self_comp);
 292                 }
 293                 break;
 294         }
 295         case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
 296                 /* fall through */
 297         case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
 298         {
 299                 const bt_field *in_element_field;
 300                 bt_field *out_element_field;
 301                 uint64_t i, array_len;
 302                 bt_field_array_dynamic_set_length_status set_len_status;
 303
 304                 array_len = bt_field_array_get_length(in_field);
 305
 306                 if (in_fc_type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY) {
 307                         set_len_status = bt_field_array_dynamic_set_length(
 308                                 out_field, array_len);
 309                         if (set_len_status !=
 310                                         BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_OK) {
 311                                 BT_COMP_LOGE("Cannot set dynamic array field's "
 312                                         "length field: field-addr=%p, "
 313                                         "length=%" PRIu64, out_field, array_len);
 314                                 bt_current_thread_clear_error();
 315                         }
 316                 }
 317
 318                 for (i = 0; i < array_len; i++) {
 319                         in_element_field =
 320                                 bt_field_array_borrow_element_field_by_index_const(
 321                                         in_field, i);
 322                         out_element_field =
 323                                 bt_field_array_borrow_element_field_by_index(
 324                                         out_field, i);
 325                         copy_field_content(in_element_field, out_element_field,
 326                                 log_level, self_comp);
 327                 }
 328                 break;
 329         }
 330         case BT_FIELD_CLASS_TYPE_OPTION:
 331         {
 332                 const bt_field *in_option_field;
 333                 bt_field *out_option_field;
 334
 335                 in_option_field = bt_field_option_borrow_field_const(in_field);
 336
 337                 if (in_option_field) {
 338                         bt_field_option_set_has_field(out_field, BT_TRUE);
 339                         out_option_field = bt_field_option_borrow_field(
 340                                 out_field);
 341                         BT_ASSERT(out_option_field);
 342                         copy_field_content(in_option_field, out_option_field,
 343                                 log_level, self_comp);
 344                 } else {
 345                         bt_field_option_set_has_field(out_field, BT_FALSE);
 346                 }
 347
 348                 break;
 349         }
 350         case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
 351         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR:
 352         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR:
 353         {
 354                 bt_field_variant_select_option_field_by_index_status sel_opt_status;
 355                 uint64_t in_selected_option_idx;
 356                 const bt_field *in_option_field;
 357                 bt_field *out_option_field;
 358
 359                 in_selected_option_idx =
 360                         bt_field_variant_get_selected_option_field_index(
 361                                         in_field);
 362                 sel_opt_status = bt_field_variant_select_option_field_by_index(out_field,
 363                                 in_selected_option_idx);
 364                 if (sel_opt_status !=
 365                                 BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK) {
 366                         BT_COMP_LOGE("Cannot select variant field's option field: "
 367                                 "var-field-addr=%p, opt-index=%" PRId64,
 368                                 out_field, in_selected_option_idx);
 369                         bt_current_thread_clear_error();
 370                 }
 371
 372                 in_option_field = bt_field_variant_borrow_selected_option_field_const(in_field);
 373                 out_option_field = bt_field_variant_borrow_selected_option_field(out_field);
 374
 375                 copy_field_content(in_option_field, out_option_field,
 376                         log_level, self_comp);
 377
 378                 break;
 379         }
 380         default:
 381                 abort();
 382         }
 383         BT_COMP_LOGT("Copied content of field: in-f-addr=%p, out-f-addr=%p",
 384                         in_field, out_field);
 385 }