src/plugins/ctf/common/metadata/ctf-meta-update-default-clock-classes.cpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2018 Philippe Proulx <pproulx@efficios.com>
   5  */
   6
   7 #define BT_COMP_LOG_SELF_COMP       (log_cfg->self_comp)
   8 #define BT_COMP_LOG_SELF_COMP_CLASS (log_cfg->self_comp_class)
   9 #define BT_LOG_OUTPUT_LEVEL         (log_cfg->log_level)
  10 #define BT_LOG_TAG                  "PLUGIN/CTF/META/UPDATE-DEF-CC"
  11 #include "logging/comp-logging.h"
  12
  13 #include <babeltrace2/babeltrace.h>
  14 #include "common/macros.h"
  15 #include "common/assert.h"
  16 #include <glib.h>
  17 #include <stdint.h>
  18 #include <string.h>
  19 #include <inttypes.h>
  20
  21 #include "ctf-meta-visitors.hpp"
  22 #include "logging.hpp"
  23
  24 static inline int find_mapped_clock_class(struct ctf_field_class *fc,
  25                                           struct ctf_clock_class **clock_class,
  26                                           struct meta_log_config *log_cfg)
  27 {
  28     int ret = 0;
  29     uint64_t i;
  30
  31     if (!fc) {
  32         goto end;
  33     }
  34
  35     switch (fc->type) {
  36     case CTF_FIELD_CLASS_TYPE_INT:
  37     case CTF_FIELD_CLASS_TYPE_ENUM:
  38     {
  39         struct ctf_field_class_int *int_fc = ctf_field_class_as_int(fc);
  40
  41         if (int_fc->mapped_clock_class) {
  42             if (*clock_class && *clock_class != int_fc->mapped_clock_class) {
  43                 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Stream class contains more than one "
  44                                                          "clock class: expected-cc-name=\"%s\", "
  45                                                          "other-cc-name=\"%s\"",
  46                                                          (*clock_class)->name->str,
  47                                                          int_fc->mapped_clock_class->name->str);
  48                 ret = -1;
  49                 goto end;
  50             }
  51
  52             *clock_class = int_fc->mapped_clock_class;
  53         }
  54
  55         break;
  56     }
  57     case CTF_FIELD_CLASS_TYPE_STRUCT:
  58     {
  59         struct ctf_field_class_struct *struct_fc = ctf_field_class_as_struct(fc);
  60
  61         for (i = 0; i < struct_fc->members->len; i++) {
  62             struct ctf_named_field_class *named_fc =
  63                 ctf_field_class_struct_borrow_member_by_index(struct_fc, i);
  64
  65             ret = find_mapped_clock_class(named_fc->fc, clock_class, log_cfg);
  66             if (ret) {
  67                 goto end;
  68             }
  69         }
  70
  71         break;
  72     }
  73     case CTF_FIELD_CLASS_TYPE_VARIANT:
  74     {
  75         struct ctf_field_class_variant *var_fc = ctf_field_class_as_variant(fc);
  76
  77         for (i = 0; i < var_fc->options->len; i++) {
  78             struct ctf_named_field_class *named_fc =
  79                 ctf_field_class_variant_borrow_option_by_index(var_fc, i);
  80
  81             ret = find_mapped_clock_class(named_fc->fc, clock_class, log_cfg);
  82             if (ret) {
  83                 goto end;
  84             }
  85         }
  86
  87         break;
  88     }
  89     case CTF_FIELD_CLASS_TYPE_ARRAY:
  90     case CTF_FIELD_CLASS_TYPE_SEQUENCE:
  91     {
  92         struct ctf_field_class_array_base *array_fc = ctf_field_class_as_array_base(fc);
  93
  94         ret = find_mapped_clock_class(array_fc->elem_fc, clock_class, log_cfg);
  95         if (ret) {
  96             goto end;
  97         }
  98
  99         break;
 100     }
 101     default:
 102         break;
 103     }
 104
 105 end:
 106     return ret;
 107 }
 108
 109 static inline int update_stream_class_default_clock_class(struct ctf_stream_class *stream_class,
 110                                                           struct meta_log_config *log_cfg)
 111 {
 112     int ret = 0;
 113     struct ctf_clock_class *clock_class = stream_class->default_clock_class;
 114     uint64_t i;
 115
 116     ret = find_mapped_clock_class(stream_class->packet_context_fc, &clock_class, log_cfg);
 117     if (ret) {
 118         goto end;
 119     }
 120
 121     ret = find_mapped_clock_class(stream_class->event_header_fc, &clock_class, log_cfg);
 122     if (ret) {
 123         goto end;
 124     }
 125
 126     ret = find_mapped_clock_class(stream_class->event_common_context_fc, &clock_class, log_cfg);
 127     if (ret) {
 128         goto end;
 129     }
 130
 131     for (i = 0; i < stream_class->event_classes->len; i++) {
 132         struct ctf_event_class *event_class =
 133             (ctf_event_class *) stream_class->event_classes->pdata[i];
 134
 135         ret = find_mapped_clock_class(event_class->spec_context_fc, &clock_class, log_cfg);
 136         if (ret) {
 137             goto end;
 138         }
 139
 140         ret = find_mapped_clock_class(event_class->payload_fc, &clock_class, log_cfg);
 141         if (ret) {
 142             goto end;
 143         }
 144     }
 145
 146     if (!stream_class->default_clock_class) {
 147         stream_class->default_clock_class = clock_class;
 148     }
 149
 150 end:
 151     return ret;
 152 }
 153
 154 BT_HIDDEN
 155 int ctf_trace_class_update_default_clock_classes(struct ctf_trace_class *ctf_tc,
 156                                                  struct meta_log_config *log_cfg)
 157 {
 158     uint64_t i;
 159     int ret = 0;
 160     struct ctf_clock_class *clock_class = NULL;
 161
 162     ret = find_mapped_clock_class(ctf_tc->packet_header_fc, &clock_class, log_cfg);
 163     if (ret) {
 164         goto end;
 165     }
 166
 167     if (clock_class) {
 168         ret = -1;
 169         goto end;
 170     }
 171
 172     for (i = 0; i < ctf_tc->stream_classes->len; i++) {
 173         struct ctf_stream_class *sc = (ctf_stream_class *) ctf_tc->stream_classes->pdata[i];
 174
 175         ret = update_stream_class_default_clock_class(
 176             (ctf_stream_class *) ctf_tc->stream_classes->pdata[i], log_cfg);
 177         if (ret) {
 178             _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Stream class contains more than one "
 179                                                      "clock class: stream-class-id=%" PRIu64,
 180                                                      sc->id);
 181             goto end;
 182         }
 183     }
 184
 185 end:
 186     return ret;
 187 }