mirror-llvm-project/clang/unittests/Serialization/InMemoryModuleCacheTest.cpp

//===- InMemoryModuleCacheTest.cpp - InMemoryModuleCache tests ------------===//
//
// 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/Serialization/InMemoryModuleCache.h"
#include "clang/Basic/AtomicLineLogger.h"
#include "llvm/Support/MemoryBuffer.h"
#include "gtest/gtest.h"

using namespace llvm;
using namespace clang;

namespace {

// A logger instances to satisfy InMemoryModuleCache.
AtomicLineLogger NoOpLogger;

std::unique_ptr<MemoryBuffer> getBuffer(int I) {
  SmallVector<char, 8> Bytes;
  raw_svector_ostream(Bytes) << "data:" << I;
  return MemoryBuffer::getMemBuffer(StringRef(Bytes.data(), Bytes.size()), "",
                                    /* RequiresNullTerminator = */ false);
}

TEST(InMemoryModuleCacheTest, initialState) {
  InMemoryModuleCache Cache(NoOpLogger);
  EXPECT_EQ(InMemoryModuleCache::Unknown, Cache.getPCMState("B"));
  EXPECT_FALSE(Cache.isPCMFinal("B"));
  EXPECT_FALSE(Cache.shouldBuildPCM("B"));

#if !defined(NDEBUG) && GTEST_HAS_DEATH_TEST
  EXPECT_DEATH(Cache.tryToDropPCM("B"), "PCM to remove is unknown");
  EXPECT_DEATH(Cache.finalizePCM("B"), "PCM to finalize is unknown");
#endif
}

TEST(InMemoryModuleCacheTest, addPCM) {
  auto B = getBuffer(1);
  auto *RawB = B.get();

  InMemoryModuleCache Cache(NoOpLogger);
  EXPECT_EQ(RawB, &Cache.addPCM("B", std::move(B), 0, 0));
  EXPECT_EQ(InMemoryModuleCache::Tentative, Cache.getPCMState("B"));
  off_t Size;
  time_t ModTime;
  EXPECT_EQ(RawB, Cache.lookupPCM("B", Size, ModTime));
  EXPECT_FALSE(Cache.isPCMFinal("B"));
  EXPECT_FALSE(Cache.shouldBuildPCM("B"));

#if !defined(NDEBUG) && GTEST_HAS_DEATH_TEST
  EXPECT_DEATH(Cache.addPCM("B", getBuffer(2), 0, 0), "Already has a PCM");
  EXPECT_DEATH(Cache.addBuiltPCM("B", getBuffer(2), 0, 0),
               "Trying to override tentative PCM");
#endif
}

TEST(InMemoryModuleCacheTest, addBuiltPCM) {
  auto B = getBuffer(1);
  auto *RawB = B.get();

  InMemoryModuleCache Cache(NoOpLogger);
  EXPECT_EQ(RawB, &Cache.addBuiltPCM("B", std::move(B), 0, 0));
  EXPECT_EQ(InMemoryModuleCache::Final, Cache.getPCMState("B"));
  off_t Size;
  time_t ModTime;
  EXPECT_EQ(RawB, Cache.lookupPCM("B", Size, ModTime));
  EXPECT_TRUE(Cache.isPCMFinal("B"));
  EXPECT_FALSE(Cache.shouldBuildPCM("B"));

#if !defined(NDEBUG) && GTEST_HAS_DEATH_TEST
  EXPECT_DEATH(Cache.addPCM("B", getBuffer(2), 0, 0), "Already has a PCM");
  EXPECT_DEATH(Cache.addBuiltPCM("B", getBuffer(2), 0, 0),
               "Trying to override finalized PCM");
#endif
}

TEST(InMemoryModuleCacheTest, tryToDropPCM) {
  auto B1 = getBuffer(1);
  auto B2 = getBuffer(2);
  auto *RawB1 = B1.get();
  auto *RawB2 = B2.get();
  ASSERT_NE(RawB1, RawB2);

  InMemoryModuleCache Cache(NoOpLogger);
  EXPECT_EQ(InMemoryModuleCache::Unknown, Cache.getPCMState("B"));
  EXPECT_EQ(RawB1, &Cache.addPCM("B", std::move(B1), 0, 0));
  EXPECT_FALSE(Cache.tryToDropPCM("B"));
  off_t Size1;
  time_t ModTime1;
  EXPECT_EQ(nullptr, Cache.lookupPCM("B", Size1, ModTime1));
  EXPECT_EQ(InMemoryModuleCache::ToBuild, Cache.getPCMState("B"));
  EXPECT_FALSE(Cache.isPCMFinal("B"));
  EXPECT_TRUE(Cache.shouldBuildPCM("B"));

#if !defined(NDEBUG) && GTEST_HAS_DEATH_TEST
  EXPECT_DEATH(Cache.addPCM("B", getBuffer(2), 0, 0), "Already has a PCM");
  EXPECT_DEATH(Cache.tryToDropPCM("B"),
               "PCM to remove is scheduled to be built");
  EXPECT_DEATH(Cache.finalizePCM("B"), "Trying to finalize a dropped PCM");
#endif

  // Add a new one.
  EXPECT_EQ(RawB2, &Cache.addBuiltPCM("B", std::move(B2), 0, 0));
  EXPECT_TRUE(Cache.isPCMFinal("B"));

  // Can try to drop again, but this should error and do nothing.
  EXPECT_TRUE(Cache.tryToDropPCM("B"));
  off_t Size2;
  time_t ModTime2;
  EXPECT_EQ(RawB2, Cache.lookupPCM("B", Size2, ModTime2));
}

TEST(InMemoryModuleCacheTest, finalizePCM) {
  auto B = getBuffer(1);
  auto *RawB = B.get();

  InMemoryModuleCache Cache(NoOpLogger);
  EXPECT_EQ(InMemoryModuleCache::Unknown, Cache.getPCMState("B"));
  EXPECT_EQ(RawB, &Cache.addPCM("B", std::move(B), 0, 0));

  // Call finalize.
  Cache.finalizePCM("B");
  EXPECT_EQ(InMemoryModuleCache::Final, Cache.getPCMState("B"));
  EXPECT_TRUE(Cache.isPCMFinal("B"));
}

} // namespace