TheRock/compiler/amd-llvm/clang/unittests/ScalableStaticAnalysisFramework/TUSummaryBuilderTest.cpp

//===- TUSummaryBuilderTest.cpp -------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "clang/ScalableStaticAnalysisFramework/Core/TUSummary/TUSummaryBuilder.h"
#include "FindDecl.h"
#include "TestFixture.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/BuildNamespace.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/EntityId.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/EntityLinkage.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/EntityName.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/SummaryName.h"
#include "clang/ScalableStaticAnalysisFramework/Core/TUSummary/EntitySummary.h"
#include "clang/ScalableStaticAnalysisFramework/Core/TUSummary/TUSummary.h"
#include "clang/ScalableStaticAnalysisFramework/Core/TUSummary/TUSummaryExtractor.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include <memory>
#include <type_traits>

using namespace clang;
using namespace ssaf;

using llvm::SmallVector;
using testing::Field;
using testing::Optional;
using testing::UnorderedElementsAre;

struct SummaryResult {
  EntitySummary *Summary;
  bool Inserted;
};

template <class ConcreteEntitySummary>
[[nodiscard]]
static auto addSummaryTo(TUSummaryBuilder &Builder, EntityId ID,
                         ConcreteEntitySummary Summary) {
  static_assert(std::is_base_of_v<EntitySummary, ConcreteEntitySummary>);
  auto NewSummary = std::make_unique<ConcreteEntitySummary>(std::move(Summary));
  SummaryName Name = NewSummary->getSummaryName();
  auto [Place, Inserted] = Builder.addSummary(ID, std::move(NewSummary));
  return std::pair{Name, SummaryResult{Place, Inserted}};
}

namespace {

// Mock EntitySummary classes for testing
struct MockSummaryData1 final : public EntitySummary {
  explicit MockSummaryData1(int Value) : Value(Value) {}
  SummaryName getSummaryName() const override {
    return SummaryName("MockSummary1");
  }
  int Value;
};

struct MockSummaryData2 final : public EntitySummary {
  explicit MockSummaryData2(std::string Text) : Text(std::move(Text)) {}
  SummaryName getSummaryName() const override {
    return SummaryName("MockSummary2");
  }
  std::string Text;
};

struct MockSummaryData3 final : public EntitySummary {
  explicit MockSummaryData3(bool Flag) : Flag(Flag) {}
  SummaryName getSummaryName() const override {
    return SummaryName("MockSummary3");
  }
  bool Flag;
};

void PrintTo(const MockSummaryData1 &S, std::ostream *OS) {
  *OS << "MockSummaryData1(" << S.getSummaryName().str().str() << ")";
}
void PrintTo(const MockSummaryData2 &S, std::ostream *OS) {
  *OS << "MockSummaryData2(" << S.getSummaryName().str().str() << ")";
}
void PrintTo(const MockSummaryData3 &S, std::ostream *OS) {
  *OS << "MockSummaryData3(" << S.getSummaryName().str().str() << ")";
}

struct TUSummaryBuilderTest : ssaf::TestFixture {
  TUSummary Summary{
      BuildNamespace(BuildNamespaceKind::CompilationUnit, "Mock.cpp")};
  TUSummaryBuilder Builder{Summary};
  TUSummaryExtractor Extractor{Builder};

  [[nodiscard]] EntityId addTestEntity(llvm::StringRef USR) {
    return getIdTable(Summary).getId(
        EntityName(USR, /*Suffix=*/"", /*Namespace=*/{}));
  }

  [[nodiscard]] static SmallVector<SummaryName>
  summaryNames(const TUSummary &Summary) {
    return llvm::to_vector(llvm::make_first_range(getData(Summary)));
  }

  [[nodiscard]] static SmallVector<EntityId>
  entitiesOfSummary(const TUSummary &Summary, const SummaryName &Name) {
    const auto &MappingIt = getData(Summary).find(Name);
    if (MappingIt == getData(Summary).end())
      return {};
    return llvm::to_vector(llvm::make_first_range(MappingIt->second));
  }

  template <class ConcreteSummaryData>
  [[nodiscard]] static std::optional<ConcreteSummaryData>
  getAsEntitySummary(const TUSummary &Summary, const SummaryName &Name,
                     EntityId E) {
    static_assert(std::is_base_of_v<EntitySummary, ConcreteSummaryData>);
    const auto &MappingIt = getData(Summary).find(Name);
    if (MappingIt == getData(Summary).end())
      return std::nullopt;
    auto SummaryIt = MappingIt->second.find(E);
    if (SummaryIt == MappingIt->second.end())
      return std::nullopt;
    assert(Name == SummaryIt->second->getSummaryName());
    return static_cast<const ConcreteSummaryData &>(*SummaryIt->second);
  }
};

TEST_F(TUSummaryBuilderTest, AddEntity) {
  EntityName EN1("c:@F@foo", "", /*Namespace=*/{});
  EntityName EN2("c:@F@bar", "", /*Namespace=*/{});

  EntityIdTable &IdTable = getIdTable(Summary);

  EntityId ID = IdTable.getId(EN1);
  EntityId IDAlias = IdTable.getId(EN1);
  EXPECT_EQ(ID, IDAlias); // Idenpotency

  EntityId ID2 = IdTable.getId(EN2);
  EXPECT_NE(ID, ID2);
  EXPECT_NE(IDAlias, ID2);

  EXPECT_EQ(IdTable.count(), 2U);
  EXPECT_TRUE(IdTable.contains(EN1));
  EXPECT_TRUE(IdTable.contains(EN2));
}

TEST_F(TUSummaryBuilderTest, TUSummaryBuilderAddSingleSummary) {
  EntityId ID = addTestEntity("c:@F@foo");
  auto [Name, Res] = addSummaryTo(Builder, ID, MockSummaryData1(10));
  ASSERT_TRUE(Res.Inserted);
  ASSERT_TRUE(Res.Summary);

  // Should have a summary type with an entity.
  EXPECT_THAT(summaryNames(Summary), UnorderedElementsAre(Name));
  EXPECT_THAT(entitiesOfSummary(Summary, Name), UnorderedElementsAre(ID));

  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name, ID),
              Optional(Field(&MockSummaryData1::Value, 10)));
}

TEST_F(TUSummaryBuilderTest, AddMultipleSummariesToSameEntity) {
  EntityId ID = addTestEntity("c:@F@foo");

  // Add different summary types to the same entity.
  auto [Name1, Res1] = addSummaryTo(Builder, ID, MockSummaryData1(42));
  auto [Name2, Res2] = addSummaryTo(Builder, ID, MockSummaryData2("test data"));
  auto [Name3, Res3] = addSummaryTo(Builder, ID, MockSummaryData3(true));
  ASSERT_TRUE(Res1.Inserted);
  ASSERT_TRUE(Res2.Inserted);
  ASSERT_TRUE(Res3.Inserted);
  ASSERT_TRUE(Res1.Summary);
  ASSERT_TRUE(Res2.Summary);
  ASSERT_TRUE(Res3.Summary);

  // All Names must be unique
  EXPECT_EQ((std::set<SummaryName>{Name1, Name2, Name3}.size()), 3U);

  // Should have 3 summary type with the same entity.
  EXPECT_THAT(summaryNames(Summary), UnorderedElementsAre(Name1, Name2, Name3));
  EXPECT_THAT(entitiesOfSummary(Summary, Name1), UnorderedElementsAre(ID));
  EXPECT_THAT(entitiesOfSummary(Summary, Name2), UnorderedElementsAre(ID));
  EXPECT_THAT(entitiesOfSummary(Summary, Name3), UnorderedElementsAre(ID));

  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name1, ID),
              Optional(Field(&MockSummaryData1::Value, 42)));
  EXPECT_THAT(getAsEntitySummary<MockSummaryData2>(Summary, Name2, ID),
              Optional(Field(&MockSummaryData2::Text, "test data")));
  EXPECT_THAT(getAsEntitySummary<MockSummaryData3>(Summary, Name3, ID),
              Optional(Field(&MockSummaryData3::Flag, true)));
}

TEST_F(TUSummaryBuilderTest, AddSameSummaryTypeToMultipleEntities) {
  EntityId ID1 = addTestEntity("c:@F@foo");
  EntityId ID2 = addTestEntity("c:@F@bar");
  EntityId ID3 = addTestEntity("c:@F@baz");

  // Add the same summary type to different entities.
  auto [Name1, Res1] = addSummaryTo(Builder, ID1, MockSummaryData1(1));
  auto [Name2, Res2] = addSummaryTo(Builder, ID2, MockSummaryData1(2));
  auto [Name3, Res3] = addSummaryTo(Builder, ID3, MockSummaryData1(3));
  ASSERT_TRUE(Res1.Inserted);
  ASSERT_TRUE(Res2.Inserted);
  ASSERT_TRUE(Res3.Inserted);
  ASSERT_TRUE(Res1.Summary);
  ASSERT_TRUE(Res2.Summary);
  ASSERT_TRUE(Res3.Summary);

  // All 3 should be the same summary type.
  EXPECT_THAT((llvm::ArrayRef{Name1, Name2, Name3}), testing::Each(Name1));

  // Should have only 1 summary type with 3 entities.
  EXPECT_THAT(summaryNames(Summary), UnorderedElementsAre(Name1));
  EXPECT_THAT(entitiesOfSummary(Summary, Name1),
              UnorderedElementsAre(ID1, ID2, ID3));

  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name1, ID1),
              Optional(Field(&MockSummaryData1::Value, 1)));
  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name2, ID2),
              Optional(Field(&MockSummaryData1::Value, 2)));
  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name3, ID3),
              Optional(Field(&MockSummaryData1::Value, 3)));
}

TEST_F(TUSummaryBuilderTest, AddConflictingSummaryToSameEntity) {
  EntityId ID = addTestEntity("c:@F@foo");

  auto [Name, Res] = addSummaryTo(Builder, ID, MockSummaryData1(10));
  ASSERT_TRUE(Res.Inserted);
  ASSERT_TRUE(Res.Summary);

  // Check the initial value.
  EXPECT_THAT(summaryNames(Summary), UnorderedElementsAre(Name));
  EXPECT_THAT(entitiesOfSummary(Summary, Name), UnorderedElementsAre(ID));
  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name, ID),
              Optional(Field(&MockSummaryData1::Value, 10)));

  // This is a different summary of the same kind.
  auto NewSummary = std::make_unique<MockSummaryData1>(20);
  ASSERT_EQ(NewSummary->getSummaryName(), Name);

  // Let's add this different summary.
  // This should keep the map intact and give us the existing entity summary.
  auto [Slot, Inserted] = Builder.addSummary(ID, std::move(NewSummary));
  ASSERT_FALSE(Inserted);
  ASSERT_TRUE(Slot);

  // Check that the summary object is not consumed and remained the same.
  ASSERT_TRUE(NewSummary);
  ASSERT_EQ(static_cast<MockSummaryData1 *>(NewSummary.get())->Value, 20);

  // Check that the Slot refers to the existing entity summary.
  ASSERT_EQ(Slot->getSummaryName(), Name);
  ASSERT_EQ(static_cast<MockSummaryData1 *>(Slot)->Value, 10);

  // Check that the values remained the same.
  EXPECT_THAT(summaryNames(Summary), UnorderedElementsAre(Name));
  EXPECT_THAT(entitiesOfSummary(Summary, Name), UnorderedElementsAre(ID));
  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name, ID),
              Optional(Field(&MockSummaryData1::Value, 10)));

  // We can update the existing summary.
  static_cast<MockSummaryData1 *>(Res.Summary)->Value = 30;

  // Check that the values remained the same except what we updated.
  EXPECT_THAT(summaryNames(Summary), UnorderedElementsAre(Name));
  EXPECT_THAT(entitiesOfSummary(Summary, Name), UnorderedElementsAre(ID));
  EXPECT_THAT(getAsEntitySummary<MockSummaryData1>(Summary, Name, ID),
              Optional(Field(&MockSummaryData1::Value, 30)));
}

struct TUSummaryBuilderLinkageTest : TUSummaryBuilderTest {
  std::unique_ptr<ASTUnit> AST;
  static constexpr auto Internal = EntityLinkageType::Internal;
  static constexpr auto External = EntityLinkageType::External;

  const FunctionDecl *findFnByName(StringRef Name) {
    return ssaf::findFnByName(Name, AST->getASTContext());
  }

  std::optional<EntityLinkageType> getLinkageFor(std::optional<EntityId> ID) {
    if (!ID)
      return std::nullopt;
    if (auto It = getLinkageTable(Summary).find(*ID);
        It != getLinkageTable(Summary).end())
      return It->second.getLinkage();
    return std::nullopt;
  }
};

TEST_F(TUSummaryBuilderLinkageTest, HasInternalLinkage) {
  AST = tooling::buildASTFromCode("static void target() {}");
  const FunctionDecl *Fn = findFnByName("target");
  ASSERT_TRUE(Fn);
  EXPECT_EQ(getLinkageFor(Extractor.addEntity(Fn)), Internal);
}

TEST_F(TUSummaryBuilderLinkageTest, HasExternalLinkage) {
  AST = tooling::buildASTFromCode("void target() {}");
  const FunctionDecl *Fn = findFnByName("target");
  ASSERT_TRUE(Fn);
  EXPECT_EQ(getLinkageFor(Extractor.addEntity(Fn)), External);
}

TEST_F(TUSummaryBuilderLinkageTest, HasExternalLinkageWithInline) {
  AST = tooling::buildASTFromCode("inline void target() {}");
  const FunctionDecl *Fn = findFnByName("target");
  ASSERT_TRUE(Fn);
  EXPECT_EQ(getLinkageFor(Extractor.addEntity(Fn)), External);
}

TEST_F(TUSummaryBuilderLinkageTest, HasInternalLinkageWithStaticInline) {
  AST = tooling::buildASTFromCode("static inline void target() {}");
  const FunctionDecl *Fn = findFnByName("target");
  ASSERT_TRUE(Fn);
  EXPECT_EQ(getLinkageFor(Extractor.addEntity(Fn)), Internal);
}

TEST_F(TUSummaryBuilderLinkageTest, ConstVolatileGlobalHasExternalLinkage) {
  AST = tooling::buildASTFromCode("namespace ns {\n"
                                  "  const volatile int glob = 0;\n"
                                  "}");
  const auto *VD = findDeclByName<VarDecl>("glob", AST->getASTContext());
  ASSERT_TRUE(VD);
  EXPECT_EQ(getLinkageFor(Extractor.addEntity(VD)), External);
}

TEST_F(TUSummaryBuilderLinkageTest, ConstGlobalHasInternalLinkage) {
  AST = tooling::buildASTFromCode("namespace ns {\n"
                                  "  const int glob = 0;\n"
                                  "}");
  const auto *VD = findDeclByName<VarDecl>("glob", AST->getASTContext());
  ASSERT_TRUE(VD);
  EXPECT_EQ(getLinkageFor(Extractor.addEntity(VD)), Internal);
}

} // namespace