unittests/Transforms/Utils/SpecialCaseList.cpp

   1 //===- SpecialCaseList.cpp - Unit tests for SpecialCaseList ---------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/IR/Function.h"
  11 #include "llvm/IR/LLVMContext.h"
  12 #include "llvm/IR/Module.h"
  13 #include "llvm/Support/MemoryBuffer.h"
  14 #include "llvm/Transforms/Utils/SpecialCaseList.h"
  15 #include "gtest/gtest.h"
  16
  17 using namespace llvm;
  18
  19 namespace {
  20
  21 class SpecialCaseListTest : public ::testing::Test {
  22 protected:
  23   Function *makeFunction(StringRef Name, Module &M) {
  24     return Function::Create(FunctionType::get(Type::getVoidTy(Ctx), false),
  25                             GlobalValue::ExternalLinkage,
  26                             Name,
  27                             &M);
  28   }
  29
  30   GlobalVariable *makeGlobal(StringRef Name, StringRef StructName, Module &M) {
  31     StructType *ST =
  32         StructType::create(StructName, Type::getInt32Ty(Ctx), (Type*)0);
  33     return new GlobalVariable(
  34         M, ST, false, GlobalValue::ExternalLinkage, 0, Name);
  35   }
  36
  37   GlobalAlias *makeAlias(StringRef Name, GlobalValue *Aliasee) {
  38     return new GlobalAlias(Aliasee->getType(), GlobalValue::ExternalLinkage,
  39                            Name, Aliasee, Aliasee->getParent());
  40   }
  41
  42   SpecialCaseList *makeSpecialCaseList(StringRef List, std::string &Error) {
  43     OwningPtr<MemoryBuffer> MB(MemoryBuffer::getMemBuffer(List));
  44     return SpecialCaseList::create(MB.get(), Error);
  45   }
  46
  47   SpecialCaseList *makeSpecialCaseList(StringRef List) {
  48     std::string Error;
  49     SpecialCaseList *SCL = makeSpecialCaseList(List, Error);
  50     assert(SCL);
  51     assert(Error == "");
  52     return SCL;
  53   }
  54
  55   LLVMContext Ctx;
  56 };
  57
  58 TEST_F(SpecialCaseListTest, ModuleIsIn) {
  59   Module M("hello", Ctx);
  60   Function *F = makeFunction("foo", M);
  61   GlobalVariable *GV = makeGlobal("bar", "t", M);
  62
  63   OwningPtr<SpecialCaseList> SCL(makeSpecialCaseList("# This is a comment.\n"
  64                                                      "\n"
  65                                                      "src:hello\n"));
  66   EXPECT_TRUE(SCL->isIn(M));
  67   EXPECT_TRUE(SCL->isIn(*F));
  68   EXPECT_TRUE(SCL->isIn(*GV));
  69
  70   SCL.reset(makeSpecialCaseList("src:he*o\n"));
  71   EXPECT_TRUE(SCL->isIn(M));
  72   EXPECT_TRUE(SCL->isIn(*F));
  73   EXPECT_TRUE(SCL->isIn(*GV));
  74
  75   SCL.reset(makeSpecialCaseList("src:hi\n"));
  76   EXPECT_FALSE(SCL->isIn(M));
  77   EXPECT_FALSE(SCL->isIn(*F));
  78   EXPECT_FALSE(SCL->isIn(*GV));
  79 }
  80
  81 TEST_F(SpecialCaseListTest, FunctionIsIn) {
  82   Module M("hello", Ctx);
  83   Function *Foo = makeFunction("foo", M);
  84   Function *Bar = makeFunction("bar", M);
  85
  86   OwningPtr<SpecialCaseList> SCL(makeSpecialCaseList("fun:foo\n"));
  87   EXPECT_TRUE(SCL->isIn(*Foo));
  88   EXPECT_FALSE(SCL->isIn(*Bar));
  89
  90   SCL.reset(makeSpecialCaseList("fun:b*\n"));
  91   EXPECT_FALSE(SCL->isIn(*Foo));
  92   EXPECT_TRUE(SCL->isIn(*Bar));
  93
  94   SCL.reset(makeSpecialCaseList("fun:f*\n"
  95                                 "fun:bar\n"));
  96   EXPECT_TRUE(SCL->isIn(*Foo));
  97   EXPECT_TRUE(SCL->isIn(*Bar));
  98
  99   SCL.reset(makeSpecialCaseList("fun:foo=functional\n"));
 100   EXPECT_TRUE(SCL->isIn(*Foo, "functional"));
 101   StringRef Category;
 102   EXPECT_FALSE(SCL->isIn(*Bar, "functional"));
 103 }
 104
 105 TEST_F(SpecialCaseListTest, GlobalIsIn) {
 106   Module M("hello", Ctx);
 107   GlobalVariable *Foo = makeGlobal("foo", "t1", M);
 108   GlobalVariable *Bar = makeGlobal("bar", "t2", M);
 109
 110   OwningPtr<SpecialCaseList> SCL(makeSpecialCaseList("global:foo\n"));
 111   EXPECT_TRUE(SCL->isIn(*Foo));
 112   EXPECT_FALSE(SCL->isIn(*Bar));
 113   EXPECT_FALSE(SCL->isIn(*Foo, "init"));
 114   EXPECT_FALSE(SCL->isIn(*Bar, "init"));
 115
 116   SCL.reset(makeSpecialCaseList("global:foo=init\n"));
 117   EXPECT_FALSE(SCL->isIn(*Foo));
 118   EXPECT_FALSE(SCL->isIn(*Bar));
 119   EXPECT_TRUE(SCL->isIn(*Foo, "init"));
 120   EXPECT_FALSE(SCL->isIn(*Bar, "init"));
 121
 122   SCL.reset(makeSpecialCaseList("global-init:foo\n"));
 123   EXPECT_FALSE(SCL->isIn(*Foo));
 124   EXPECT_FALSE(SCL->isIn(*Bar));
 125   EXPECT_TRUE(SCL->isIn(*Foo, "init"));
 126   EXPECT_FALSE(SCL->isIn(*Bar, "init"));
 127
 128   SCL.reset(makeSpecialCaseList("type:t2=init\n"));
 129   EXPECT_FALSE(SCL->isIn(*Foo));
 130   EXPECT_FALSE(SCL->isIn(*Bar));
 131   EXPECT_FALSE(SCL->isIn(*Foo, "init"));
 132   EXPECT_TRUE(SCL->isIn(*Bar, "init"));
 133
 134   SCL.reset(makeSpecialCaseList("global-init-type:t2\n"));
 135   EXPECT_FALSE(SCL->isIn(*Foo));
 136   EXPECT_FALSE(SCL->isIn(*Bar));
 137   EXPECT_FALSE(SCL->isIn(*Foo, "init"));
 138   EXPECT_TRUE(SCL->isIn(*Bar, "init"));
 139
 140   SCL.reset(makeSpecialCaseList("src:hello=init\n"));
 141   EXPECT_FALSE(SCL->isIn(*Foo));
 142   EXPECT_FALSE(SCL->isIn(*Bar));
 143   EXPECT_TRUE(SCL->isIn(*Foo, "init"));
 144   EXPECT_TRUE(SCL->isIn(*Bar, "init"));
 145
 146   SCL.reset(makeSpecialCaseList("global-init-src:hello\n"));
 147   EXPECT_FALSE(SCL->isIn(*Foo));
 148   EXPECT_FALSE(SCL->isIn(*Bar));
 149   EXPECT_TRUE(SCL->isIn(*Foo, "init"));
 150   EXPECT_TRUE(SCL->isIn(*Bar, "init"));
 151 }
 152
 153 TEST_F(SpecialCaseListTest, AliasIsIn) {
 154   Module M("hello", Ctx);
 155   Function *Foo = makeFunction("foo", M);
 156   GlobalVariable *Bar = makeGlobal("bar", "t", M);
 157   GlobalAlias *FooAlias = makeAlias("fooalias", Foo);
 158   GlobalAlias *BarAlias = makeAlias("baralias", Bar);
 159
 160   OwningPtr<SpecialCaseList> SCL(makeSpecialCaseList("fun:foo\n"));
 161   EXPECT_FALSE(SCL->isIn(*FooAlias));
 162   EXPECT_FALSE(SCL->isIn(*BarAlias));
 163
 164   SCL.reset(makeSpecialCaseList("global:bar\n"));
 165   EXPECT_FALSE(SCL->isIn(*FooAlias));
 166   EXPECT_FALSE(SCL->isIn(*BarAlias));
 167
 168   SCL.reset(makeSpecialCaseList("global:fooalias\n"));
 169   EXPECT_FALSE(SCL->isIn(*FooAlias));
 170   EXPECT_FALSE(SCL->isIn(*BarAlias));
 171
 172   SCL.reset(makeSpecialCaseList("fun:fooalias\n"));
 173   EXPECT_TRUE(SCL->isIn(*FooAlias));
 174   EXPECT_FALSE(SCL->isIn(*BarAlias));
 175
 176   SCL.reset(makeSpecialCaseList("global:baralias=init\n"));
 177   EXPECT_FALSE(SCL->isIn(*FooAlias, "init"));
 178   EXPECT_TRUE(SCL->isIn(*BarAlias, "init"));
 179
 180   SCL.reset(makeSpecialCaseList("type:t=init\n"));
 181   EXPECT_FALSE(SCL->isIn(*FooAlias, "init"));
 182   EXPECT_TRUE(SCL->isIn(*BarAlias, "init"));
 183
 184   SCL.reset(makeSpecialCaseList("fun:baralias=init\n"));
 185   EXPECT_FALSE(SCL->isIn(*FooAlias, "init"));
 186   EXPECT_FALSE(SCL->isIn(*BarAlias, "init"));
 187 }
 188
 189 TEST_F(SpecialCaseListTest, Substring) {
 190   Module M("othello", Ctx);
 191   Function *F = makeFunction("tomfoolery", M);
 192   GlobalVariable *GV = makeGlobal("bartender", "t", M);
 193   GlobalAlias *GA1 = makeAlias("buffoonery", F);
 194   GlobalAlias *GA2 = makeAlias("foobar", GV);
 195
 196   OwningPtr<SpecialCaseList> SCL(makeSpecialCaseList("src:hello\n"
 197                                                      "fun:foo\n"
 198                                                      "global:bar\n"));
 199   EXPECT_FALSE(SCL->isIn(M));
 200   EXPECT_FALSE(SCL->isIn(*F));
 201   EXPECT_FALSE(SCL->isIn(*GV));
 202   EXPECT_FALSE(SCL->isIn(*GA1));
 203   EXPECT_FALSE(SCL->isIn(*GA2));
 204
 205   SCL.reset(makeSpecialCaseList("fun:*foo*\n"));
 206   EXPECT_TRUE(SCL->isIn(*F));
 207   EXPECT_TRUE(SCL->isIn(*GA1));
 208 }
 209
 210 TEST_F(SpecialCaseListTest, InvalidSpecialCaseList) {
 211   std::string Error;
 212   EXPECT_EQ(0, makeSpecialCaseList("badline", Error));
 213   EXPECT_EQ("Malformed line 1: 'badline'", Error);
 214   EXPECT_EQ(0, makeSpecialCaseList("src:bad[a-", Error));
 215   EXPECT_EQ("Malformed regex in line 1: 'bad[a-': invalid character range",
 216             Error);
 217   EXPECT_EQ(0, makeSpecialCaseList("src:a.c\n"
 218                                    "fun:fun(a\n",
 219                                    Error));
 220   EXPECT_EQ("Malformed regex in line 2: 'fun(a': parentheses not balanced",
 221             Error);
 222   EXPECT_EQ(0, SpecialCaseList::create("unexisting", Error));
 223   EXPECT_EQ(0U, Error.find("Can't open file 'unexisting':"));
 224 }
 225
 226 TEST_F(SpecialCaseListTest, EmptySpecialCaseList) {
 227   OwningPtr<SpecialCaseList> SCL(makeSpecialCaseList(""));
 228   Module M("foo", Ctx);
 229   EXPECT_FALSE(SCL->isIn(M));
 230 }
 231
 232 }