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