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