[OpenMPOpt][WIP] Structure for unittests

[hamax97]

Summary

Basic structure for adding new unittests to the OpenMPOpt optimizations.

[jdoerfert]

Should we merge the test header into the test cpp?

We need an actual unit test that runs :)

[hamax97]

In D83316#2140024, @jdoerfert wrote:

Should we merge the test header into the test cpp?

We need an actual unit test that runs :)

Sure sure, I had an external problem and couldn't finish uploading the patches.

[hamax97]

Unit test for getValuesInOfflArrays working.

[jdoerfert]

Wow, this required more machinery than I expected.. thanks!

Should we merge this with the MemoryTransfer logic so we can test it?

llvm/unittests/Transforms/IPO/OpenMPOpt/HideMemTransferLatencyTest.cpp

127

Don't compare the names. Go through the module and locate the value you want and compare it against the llvm::Value.

[hamax97]

In D83316#2160625, @jdoerfert wrote:

Wow, this required more machinery than I expected.. thanks!

Should we merge this with the MemoryTransfer logic so we can test it?

I already tested it. When we agree on D82719, we should commit that first and then this I guess. Or do you mean adding this patch to that one before commiting?

[jdoerfert]

In D83316#2160742, @hamax97 wrote:

In D83316#2160625, @jdoerfert wrote:

Wow, this required more machinery than I expected.. thanks!

Should we merge this with the MemoryTransfer logic so we can test it?

I already tested it. When we agree on D82719, we should commit that first and then this I guess. Or do you mean adding this patch to that one before commiting?

I mean merging them into one and commiting them together.

[JonChesterfield]

I'm not totally sure about this. There's a lot of test setup relative to the test case itself, and I can't work out by reading the test itself what it's checking. What are all the mock classes for?

I'm wondering if we would be better off refactoring the code it intends to test so that it needs less setup.

[hamax97]

In D83316#2184765, @JonChesterfield wrote:

I'm not totally sure about this. There's a lot of test setup relative to the test case itself, and I can't work out by reading the test itself what it's checking. What are all the mock classes for?

I'm wondering if we would be better off refactoring the code it intends to test so that it needs less setup.

Regarding the mock classes. I forgot to remove MockFunctionPass and MockModulePass. But MockSCCPass is used for later using EXPECT_CALL inside the unit test itself.

Regarding refactoring the code, I think it can be done. We would have to traverse manually the function until reaching the runtime call needed. But, don't you think that all this setup might be useful for other OpenMP optimizations?, or perhaps we should wait until we have them, idk.

llvm/unittests/Transforms/IPO/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   Core
   Support
   IPO
   )
 
 add_llvm_unittest(IPOTests
   LowerTypeTests.cpp
   WholeProgramDevirt.cpp
   )
+
+add_subdirectory(OpenMPOpt)

llvm/unittests/Transforms/IPO/OpenMPOpt/CMakeLists.txt

+set(LLVM_LINK_COMPONENTS
+  ipo
+  Core
+  Analysis
+  AsmParser
+  FrontendOpenMP
+  )
+
+add_llvm_unittest(OpenMPOptUnitTests
+  HideMemTransferLatencyTest.cpp
+  )
 No newline at end of file

llvm/unittests/Transforms/IPO/OpenMPOpt/HideMemTransferLatencyTest.cpp

+//===- HideMemTransferLatencyTest.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 "OpenMPOptTest.h"
+
+namespace {
+
+class HideMemTransferLatencyTest : public OpenMPOptTest {
+protected:
+  /// This stores the runtime calls for further use within each test.
+  SmallVector<CallBase *, 16> MemTransferCalls;
+
+  void getCallSites(const char *ModuleString) {
+    auto M = parseModuleString(ModuleString);
+    initializeOMPInfoCache(*M);
+
+    auto &RFI = OMPInfoCache->RFIs[OMPRTL___tgt_target_data_begin];
+    auto GetCallSites = [&](Use &U, Function &Decl) {
+      auto *RTCall = OMPInformationCache::getCallIfRegularCall(U, &RFI);
+      if (!RTCall)
+        return false;
+      MemTransferCalls.push_back(RTCall);
+      return false;
+    };
+    RFI.foreachUse(GetCallSites);
+    EXPECT_FALSE(MemTransferCalls.empty());
+  }
+};
+
+TEST_F(HideMemTransferLatencyTest, GetValuesInOfflArrays) {
+// TODO: Update this ModuleString.
+const char *ModuleString = "";
+getCallSites(ModuleString);
+
+EXPECT_TRUE(true);
+}
+
+} // end anonymous namespace
 No newline at end of file

llvm/unittests/Transforms/IPO/OpenMPOpt/OpenMPOptTest.h

+//===- OpenMPOptTest.h - Base file for OpenMPOpt unittests ----------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_UNITTESTS_TRANSFORMS_IPO_OPENMPOPT_H
+#define LLVM_UNITTESTS_TRANSFORMS_IPO_OPENMPOPT_H
+
+#include "../../../../lib/Transforms/IPO/OpenMPOptPriv.h"
+#include "llvm/AsmParser/Parser.h"
+#include "gtest/gtest.h"
+
+using namespace llvm;
+
+namespace {
+
+class OpenMPOptTest : public ::testing::Test {
+protected:
+  std::unique_ptr<OMPInformationCache> OMPInfoCache;
+  std::unique_ptr<LLVMContext> Ctx;
+
+  OpenMPOptTest() : Ctx(new LLVMContext) {}
+
+  /// Initializes OMPInfoCache attribute cache given a module \p M.
+  /// This must be called before using OMPInfoCache.
+  void initializeOMPInfoCache(Module &M) {
+    CallGraph CG(M);
+    scc_iterator<CallGraph *> CGI = scc_begin(&CG);
+    CallGraphSCC CGSCC(CG, &CGI);
+
+    SmallPtrSet<Function *, 16> ModuleSlice;
+    SmallVector<Function *, 16> SCC;
+    for (CallGraphNode *CGN : CGSCC)
+      if (Function *Fn = CGN->getFunction())
+        if (!Fn->isDeclaration()) {
+          SCC.push_back(Fn);
+          ModuleSlice.insert(Fn);
+        }
+
+    EXPECT_FALSE(SCC.empty());
+
+    AnalysisGetter AG;
+    SetVector<Function *> Functions(SCC.begin(), SCC.end());
+    BumpPtrAllocator Allocator;
+    OMPInfoCache = std::make_unique<OMPInformationCache>(
+        *(Functions.back()->getParent()), AG, Allocator, /*CGSCC*/ &Functions,
+        ModuleSlice);
+  }
+
+  std::unique_ptr<Module> parseModuleString(const char *ModuleString) {
+    SMDiagnostic Err;
+    auto M = parseAssemblyString(ModuleString, Err, *Ctx);
+    EXPECT_TRUE(M);
+    return M;
+  }
+};
+
+} // end anonymous namespace
+
+#endif // LLVM_UNITTESTS_TRANSFORMS_IPO_OPENMPOPT_H
 No newline at end of file