plugins/ctf/common/metadata/ctf-meta-update-text-array-sequence.c

   1 /*
   2  * Copyright 2018 - Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  */
  14
  15 #define BT_LOG_TAG "PLUGIN-CTF-METADATA-META-UPDATE-TEXT-ARRAY-SEQ"
  16 #include "logging.h"
  17
  18 #include <babeltrace/babeltrace.h>
  19 #include <babeltrace/babeltrace-internal.h>
  20 #include <babeltrace/assert-internal.h>
  21 #include <glib.h>
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include <inttypes.h>
  25
  26 #include "ctf-meta-visitors.h"
  27
  28 static inline
  29 int set_text_array_sequence_field_type(struct ctf_field_type *ft)
  30 {
  31         int ret = 0;
  32         uint64_t i;
  33
  34         if (!ft) {
  35                 goto end;
  36         }
  37
  38         switch (ft->id) {
  39         case CTF_FIELD_TYPE_ID_STRUCT:
  40         {
  41                 struct ctf_field_type_struct *struct_ft = (void *) ft;
  42
  43                 for (i = 0; i < struct_ft->members->len; i++) {
  44                         struct ctf_named_field_type *named_ft =
  45                                 ctf_field_type_struct_borrow_member_by_index(
  46                                         struct_ft, i);
  47
  48                         ret = set_text_array_sequence_field_type(named_ft->ft);
  49                         if (ret) {
  50                                 goto end;
  51                         }
  52                 }
  53
  54                 break;
  55         }
  56         case CTF_FIELD_TYPE_ID_VARIANT:
  57         {
  58                 struct ctf_field_type_variant *var_ft = (void *) ft;
  59
  60                 for (i = 0; i < var_ft->options->len; i++) {
  61                         struct ctf_named_field_type *named_ft =
  62                                 ctf_field_type_variant_borrow_option_by_index(
  63                                         var_ft, i);
  64
  65                         ret = set_text_array_sequence_field_type(named_ft->ft);
  66                         if (ret) {
  67                                 goto end;
  68                         }
  69                 }
  70
  71                 break;
  72         }
  73         case CTF_FIELD_TYPE_ID_ARRAY:
  74         case CTF_FIELD_TYPE_ID_SEQUENCE:
  75         {
  76                 struct ctf_field_type_array_base *array_ft = (void *) ft;
  77
  78                 if (array_ft->elem_ft->id == CTF_FIELD_TYPE_ID_INT ||
  79                                 array_ft->elem_ft->id == CTF_FIELD_TYPE_ID_ENUM) {
  80                         struct ctf_field_type_int *int_ft =
  81                                 (void *) array_ft->elem_ft;
  82
  83                         if (int_ft->base.base.alignment == 8 &&
  84                                         int_ft->base.size == 8 &&
  85                                         int_ft->encoding == CTF_ENCODING_UTF8) {
  86                                 array_ft->is_text = true;
  87
  88                                 /*
  89                                  * Force integer element to be unsigned;
  90                                  * this makes the decoder enter a single
  91                                  * path when reading a text
  92                                  * array/sequence and we can safely
  93                                  * decode bytes as characters anyway.
  94                                  */
  95                                 int_ft->is_signed = false;
  96                         }
  97                 }
  98
  99                 ret = set_text_array_sequence_field_type(array_ft->elem_ft);
 100                 if (ret) {
 101                         goto end;
 102                 }
 103
 104                 break;
 105         }
 106         default:
 107                 break;
 108         }
 109
 110 end:
 111         return ret;
 112 }
 113
 114 BT_HIDDEN
 115 int ctf_trace_class_update_text_array_sequence(struct ctf_trace_class *ctf_tc)
 116 {
 117         int ret = 0;
 118         uint64_t i;
 119
 120         if (!ctf_tc->is_translated) {
 121                 ret = set_text_array_sequence_field_type(
 122                         ctf_tc->packet_header_ft);
 123                 if (ret) {
 124                         goto end;
 125                 }
 126         }
 127
 128         for (i = 0; i < ctf_tc->stream_classes->len; i++) {
 129                 struct ctf_stream_class *sc = ctf_tc->stream_classes->pdata[i];
 130                 uint64_t j;
 131
 132                 if (!sc->is_translated) {
 133                         ret = set_text_array_sequence_field_type(
 134                                 sc->packet_context_ft);
 135                         if (ret) {
 136                                 goto end;
 137                         }
 138
 139                         ret = set_text_array_sequence_field_type(
 140                                 sc->event_header_ft);
 141                         if (ret) {
 142                                 goto end;
 143                         }
 144
 145                         ret = set_text_array_sequence_field_type(
 146                                 sc->event_common_context_ft);
 147                         if (ret) {
 148                                 goto end;
 149                         }
 150                 }
 151
 152                 for (j = 0; j < sc->event_classes->len; j++) {
 153                         struct ctf_event_class *ec =
 154                                 sc->event_classes->pdata[j];
 155
 156                         if (ec->is_translated) {
 157                                 continue;
 158                         }
 159
 160                         ret = set_text_array_sequence_field_type(
 161                                 ec->spec_context_ft);
 162                         if (ret) {
 163                                 goto end;
 164                         }
 165
 166                         ret = set_text_array_sequence_field_type(
 167                                 ec->payload_ft);
 168                         if (ret) {
 169                                 goto end;
 170                         }
 171                 }
 172         }
 173
 174 end:
 175         return ret;
 176 }