diagnostics/common/mojo_type_utils.cc

// Copyright 2021 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "diagnostics/common/mojo_type_utils.h"

#include <base/check.h>
#include <base/strings/string_split.h>

namespace chromeos {
namespace cros_healthd {
namespace mojom {

bool operator<(const BusInfo& a, const BusInfo& b) {
  if (a.which() != b.which())
    return a.which() < b.which();
  switch (a.which()) {
    case BusInfo::Tag::PCI_BUS_INFO:
      return a.get_pci_bus_info() < b.get_pci_bus_info();
    case BusInfo::Tag::USB_BUS_INFO:
      return a.get_usb_bus_info() < b.get_usb_bus_info();
  }
}
}  // namespace mojom
}  // namespace cros_healthd
}  // namespace chromeos

namespace diagnostics {
namespace internal {
// For each line, adds a 2-space-indent at the beginning.
std::string Indent(const std::string& s) {
  const auto prefix = "  ";
  std::string res;
  for (const auto& line :
       SplitString(s, "\n", base::KEEP_WHITESPACE, base::SPLIT_WANT_NONEMPTY)) {
    res += prefix + line + "\n";
  }
  return res;
}

std::string StringCompareFormat(const std::string& a, const std::string& b) {
  return "'" + a + "' vs '" + b + "'";
}
}  // namespace internal
namespace {

using internal::Indent;
using internal::kEqualStr;
using internal::kNullStr;
using internal::StringCompareFormat;

const auto kMissingMessage =
    "It is possible that some fields are missing in GetDiffString.";

namespace mojo_ipc = ::chromeos::cros_healthd::mojom;

template <typename MojoType>
class CompareHelper {
 public:
  CompareHelper(const MojoType& a, const MojoType& b) : a_(a), b_(b) {}

  template <typename Field>
  CompareHelper& AddField(const std::string& label,
                          const Field& a_field,
                          const Field& b_field) {
    if (a_field != b_field)
      res_ += label + ":\n" + Indent(GetDiffString(a_field, b_field));
    return *this;
  }

  template <typename Field>
  CompareHelper& AddUnion(const std::string& label,
                          const Field* a_field,
                          const Field* b_field) {
    if (a_field)
      a_type_ = "type[" + label + "]";
    if (b_field)
      b_type_ = "type[" + label + "]";
    if (!a_field || !b_field)
      return *this;
    return AddField(label, *a_field, *b_field);
  }

  std::string GetResult() {
    if constexpr (IsMojoUnion<MojoType>::value) {
      // Mojo union
      CHECK(a_type_ != "" && b_type_ != "")
          << "Missing type info. " << kMissingMessage;
      if (a_.which() != b_.which())
        res_ = StringCompareFormat(a_type_, b_type_);
    } else {
      // Mojo struct
      if (res_ == "") {
        CHECK(a_ == b_) << "The structs do not equal to each other, while all "
                           "the fields are "
                           "equal. "
                        << kMissingMessage;
        res_ = kEqualStr;
      }
    }
    return res_;
  }

 private:
  const MojoType& a_;
  const MojoType& b_;
  std::string res_;
  std::string a_type_;
  std::string b_type_;
};

// Helper macro for defining the |GetDiffString| of mojo structs. See below
// definitions of |GetDiffString| for the usage.
#define FIELD(label) AddField(#label, a.label, b.label)

#define UNION(label)                                              \
  AddUnion(#label, (a.is_##label() ? &a.get_##label() : nullptr), \
           (b.is_##label() ? &b.get_##label() : nullptr))
}  // namespace

template <>
std::string GetDiffString<std::string>(const std::string& a,
                                       const std::string& b) {
  if (a == b)
    return kEqualStr;
  return StringCompareFormat(a, b);
}

template <>
std::string GetDiffString<base::Optional<std::string>>(
    const base::Optional<std::string>& a,
    const base::Optional<std::string>& b) {
  if (a == b)
    return kEqualStr;
  return StringCompareFormat(a.value_or(kNullStr), b.value_or(kNullStr));
}

template <>
std::string GetDiffString<mojo_ipc::NullableUint64>(
    const mojo_ipc::NullableUint64& a, const mojo_ipc::NullableUint64& b) {
  return GetDiffString(std::to_string(a.value), std::to_string(b.value));
}

template <>
std::string GetDiffString<mojo_ipc::VpdInfo>(const mojo_ipc::VpdInfo& a,
                                             const mojo_ipc::VpdInfo& b) {
  return CompareHelper(a, b)
      .FIELD(activate_date)
      .FIELD(mfg_date)
      .FIELD(model_name)
      .FIELD(region)
      .FIELD(serial_number)
      .FIELD(sku_number)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::DmiInfo>(const mojo_ipc::DmiInfo& a,
                                             const mojo_ipc::DmiInfo& b) {
  return CompareHelper(a, b)
      .FIELD(bios_vendor)
      .FIELD(bios_version)
      .FIELD(board_name)
      .FIELD(board_vendor)
      .FIELD(board_version)
      .FIELD(chassis_vendor)
      .FIELD(chassis_type)
      .FIELD(product_family)
      .FIELD(product_name)
      .FIELD(product_version)
      .FIELD(sys_vendor)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::OsVersion>(const mojo_ipc::OsVersion& a,
                                               const mojo_ipc::OsVersion& b) {
  return CompareHelper(a, b)
      .FIELD(release_milestone)
      .FIELD(build_number)
      .FIELD(patch_number)
      .FIELD(release_channel)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::OsInfo>(const mojo_ipc::OsInfo& a,
                                            const mojo_ipc::OsInfo& b) {
  return CompareHelper(a, b)
      .FIELD(code_name)
      .FIELD(marketing_name)
      .FIELD(boot_mode)
      .FIELD(os_version)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::SystemInfoV2>(
    const mojo_ipc::SystemInfoV2& a, const mojo_ipc::SystemInfoV2& b) {
  return CompareHelper(a, b)
      .FIELD(vpd_info)
      .FIELD(dmi_info)
      .FIELD(os_info)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::BusDevice>(const mojo_ipc::BusDevice& a,
                                               const mojo_ipc::BusDevice& b) {
  return CompareHelper(a, b)
      .FIELD(vendor_name)
      .FIELD(product_name)
      .FIELD(device_class)
      .FIELD(bus_info)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::BusInfo>(const mojo_ipc::BusInfo& a,
                                             const mojo_ipc::BusInfo& b) {
  return CompareHelper(a, b)
      .UNION(pci_bus_info)
      .UNION(usb_bus_info)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::PciBusInfo>(const mojo_ipc::PciBusInfo& a,
                                                const mojo_ipc::PciBusInfo& b) {
  return CompareHelper(a, b)
      .FIELD(class_id)
      .FIELD(subclass_id)
      .FIELD(prog_if_id)
      .FIELD(device_id)
      .FIELD(vendor_id)
      .FIELD(driver)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::UsbBusInfo>(const mojo_ipc::UsbBusInfo& a,
                                                const mojo_ipc::UsbBusInfo& b) {
  return CompareHelper(a, b)
      .FIELD(class_id)
      .FIELD(subclass_id)
      .FIELD(protocol_id)
      .FIELD(vendor_id)
      .FIELD(product_id)
      .FIELD(interfaces)
      .GetResult();
}

template <>
std::string GetDiffString<mojo_ipc::UsbBusInterfaceInfo>(
    const mojo_ipc::UsbBusInterfaceInfo& a,
    const mojo_ipc::UsbBusInterfaceInfo& b) {
  return CompareHelper(a, b)
      .FIELD(interface_number)
      .FIELD(class_id)
      .FIELD(subclass_id)
      .FIELD(protocol_id)
      .FIELD(driver)
      .GetResult();
}

}  // namespace diagnostics