[ModuleUtils] NFC: Add unit tests for appendToUsedList

[rksharma]

Summary

This patch adds initial unit tests for appendToUsedList in the ModuleUtils. It specifically tests changes from https://reviews.llvm.org/D101363 which intent to allow insertion of globals in non-zero address spaces into the llvm used lists.

[rksharma]

clang-format changes

[rksharma]

Again clang-format changes, the last clang-format patch failed silently.

[dblaikie]

Could you include some context in the patch description/commit message about this being intended to test https://reviews.llvm.org/D101363 ?
And can you confirm this test fails before D101363 and passes after it?

[rksharma]

I can confirm that the test case is working and fails before https://reviews.llvm.org/D101363

[dblaikie]

Great, thanks!

llvm/unittests/Transforms/Utils/CMakeLists.txt

add_llvm_unittest(UtilsTests
   CodeExtractorTest.cpp
   CodeMoverUtilsTest.cpp
   DebugifyTest.cpp
   FunctionComparatorTest.cpp
   IntegerDivisionTest.cpp
   LocalTest.cpp
   LoopRotationUtilsTest.cpp
   LoopUtilsTest.cpp
+  ModuleUtilsTest.cpp
   ScalarEvolutionExpanderTest.cpp
   SizeOptsTest.cpp
   SSAUpdaterBulkTest.cpp
   UnrollLoopTest.cpp
   ValueMapperTest.cpp
   VFABIUtils.cpp
   )

llvm/unittests/Transforms/Utils/ModuleUtilsTest.cpp

+//===- ModuleUtilsTest.cpp - Unit tests for Module utility ----===//
+//
+// 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 "llvm/Transforms/Utils/ModuleUtils.h"
+#include "llvm/ADT/StringRef.h"
+#include "llvm/AsmParser/Parser.h"
+#include "llvm/IR/LLVMContext.h"
+#include "llvm/IR/Module.h"
+#include "llvm/Support/SourceMgr.h"
+#include "gtest/gtest.h"
+
+using namespace llvm;
+
+static std::unique_ptr<Module> parseIR(LLVMContext &C, const char *IR) {
+  SMDiagnostic Err;
+  std::unique_ptr<Module> Mod = parseAssemblyString(IR, Err, C);
+  if (!Mod)
+    Err.print("ModuleUtilsTest", errs());
+  return Mod;
+}
+
+static int getUsedListSize(Module &M, StringRef Name) {
+  auto *UsedList = M.getGlobalVariable(Name);
+  if (!UsedList)
+    return 0;
+  auto *UsedListBaseArrayType =
+      cast<ArrayType>(UsedList->getType()->getElementType());
+  return UsedListBaseArrayType->getNumElements();
+}
+
+TEST(ModuleUtils, AppendToUsedList1) {
+  LLVMContext C;
+
+  std::unique_ptr<Module> M = parseIR(
+      C, R"(@x = addrspace(4) global [2 x i32] zeroinitializer, align 4)");
+  SmallVector<GlobalValue *, 2> Globals;
+  for (auto &G : M->globals()) {
+    Globals.push_back(&G);
+  }
+  EXPECT_EQ(0, getUsedListSize(*M, "llvm.compiler.used"));
+  appendToCompilerUsed(*M, Globals);
+  EXPECT_EQ(1, getUsedListSize(*M, "llvm.compiler.used"));
+
+  EXPECT_EQ(0, getUsedListSize(*M, "llvm.used"));
+  appendToUsed(*M, Globals);
+  EXPECT_EQ(1, getUsedListSize(*M, "llvm.used"));
+}
+
+TEST(ModuleUtils, AppendToUsedList2) {
+  LLVMContext C;
+
+  std::unique_ptr<Module> M =
+      parseIR(C, R"(@x = global [2 x i32] zeroinitializer, align 4)");
+  SmallVector<GlobalValue *, 2> Globals;
+  for (auto &G : M->globals()) {
+    Globals.push_back(&G);
+  }
+  EXPECT_EQ(0, getUsedListSize(*M, "llvm.compiler.used"));
+  appendToCompilerUsed(*M, Globals);
+  EXPECT_EQ(1, getUsedListSize(*M, "llvm.compiler.used"));
+
+  EXPECT_EQ(0, getUsedListSize(*M, "llvm.used"));
+  appendToUsed(*M, Globals);
+  EXPECT_EQ(1, getUsedListSize(*M, "llvm.used"));
+}