unittests/VMCore/MetadataTest.cpp

   1 //===- llvm/unittest/VMCore/Metadata.cpp - Metadata unit tests ------------===//
   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 "gtest/gtest.h"
  11 #include "llvm/Constants.h"
  12 #include "llvm/Instructions.h"
  13 #include "llvm/LLVMContext.h"
  14 #include "llvm/Metadata.h"
  15 #include "llvm/Module.h"
  16 #include "llvm/Type.h"
  17 #include "llvm/Support/raw_ostream.h"
  18 #include "llvm/Support/ValueHandle.h"
  19 using namespace llvm;
  20
  21 namespace {
  22
  23 LLVMContext &Context = getGlobalContext();
  24
  25 // Test that construction of MDString with different value produces different
  26 // MDString objects, even with the same string pointer and nulls in the string.
  27 TEST(MDStringTest, CreateDifferent) {
  28   char x[3] = { 'f', 0, 'A' };
  29   MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
  30   x[2] = 'B';
  31   MDString *s2 = MDString::get(Context, StringRef(&x[0], 3));
  32   EXPECT_NE(s1, s2);
  33 }
  34
  35 // Test that creation of MDStrings with the same string contents produces the
  36 // same MDString object, even with different pointers.
  37 TEST(MDStringTest, CreateSame) {
  38   char x[4] = { 'a', 'b', 'c', 'X' };
  39   char y[4] = { 'a', 'b', 'c', 'Y' };
  40
  41   MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
  42   MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
  43   EXPECT_EQ(s1, s2);
  44 }
  45
  46 // Test that MDString prints out the string we fed it.
  47 TEST(MDStringTest, PrintingSimple) {
  48   char *str = new char[13];
  49   strncpy(str, "testing 1 2 3", 13);
  50   MDString *s = MDString::get(Context, StringRef(str, 13));
  51   strncpy(str, "aaaaaaaaaaaaa", 13);
  52   delete[] str;
  53
  54   std::string Str;
  55   raw_string_ostream oss(Str);
  56   s->print(oss);
  57   EXPECT_STREQ("metadata !\"testing 1 2 3\"", oss.str().c_str());
  58 }
  59
  60 // Test printing of MDString with non-printable characters.
  61 TEST(MDStringTest, PrintingComplex) {
  62   char str[5] = {0, '\n', '"', '\\', -1};
  63   MDString *s = MDString::get(Context, StringRef(str+0, 5));
  64   std::string Str;
  65   raw_string_ostream oss(Str);
  66   s->print(oss);
  67   EXPECT_STREQ("metadata !\"\\00\\0A\\22\\5C\\FF\"", oss.str().c_str());
  68 }
  69
  70 // Test the two constructors, and containing other Constants.
  71 TEST(MDNodeTest, Simple) {
  72   char x[3] = { 'a', 'b', 'c' };
  73   char y[3] = { '1', '2', '3' };
  74
  75   MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
  76   MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
  77   ConstantInt *CI = ConstantInt::get(getGlobalContext(), APInt(8, 0));
  78
  79   std::vector<Value *> V;
  80   V.push_back(s1);
  81   V.push_back(CI);
  82   V.push_back(s2);
  83
  84   MDNode *n1 = MDNode::get(Context, &V[0], 3);
  85   Value *const c1 = n1;
  86   MDNode *n2 = MDNode::get(Context, &c1, 1);
  87   MDNode *n3 = MDNode::get(Context, &V[0], 3);
  88   EXPECT_NE(n1, n2);
  89 #ifdef ENABLE_MDNODE_UNIQUING
  90   EXPECT_EQ(n1, n3);
  91 #else
  92   (void) n3;
  93 #endif
  94
  95   EXPECT_EQ(3u, n1->getNumOperands());
  96   EXPECT_EQ(s1, n1->getOperand(0));
  97   EXPECT_EQ(CI, n1->getOperand(1));
  98   EXPECT_EQ(s2, n1->getOperand(2));
  99
 100   EXPECT_EQ(1u, n2->getNumOperands());
 101   EXPECT_EQ(n1, n2->getOperand(0));
 102
 103   std::string Str;
 104   raw_string_ostream oss(Str);
 105   n1->print(oss);
 106   EXPECT_STREQ("!0 = metadata !{metadata !\"abc\", i8 0, metadata !\"123\"}\n",
 107                oss.str().c_str());
 108   Str.clear();
 109   n2->print(oss);
 110   EXPECT_STREQ("!0 = metadata !{metadata !1}\n"
 111                "!1 = metadata !{metadata !\"abc\", i8 0, metadata !\"123\"}\n",
 112                oss.str().c_str());
 113 }
 114
 115 TEST(MDNodeTest, Delete) {
 116   Constant *C = ConstantInt::get(Type::getInt32Ty(getGlobalContext()), 1);
 117   Instruction *I = new BitCastInst(C, Type::getInt32Ty(getGlobalContext()));
 118
 119   Value *const V = I;
 120   MDNode *n = MDNode::get(Context, &V, 1);
 121   WeakVH wvh = n;
 122
 123   EXPECT_EQ(n, wvh);
 124
 125   delete I;
 126
 127   std::string Str;
 128   raw_string_ostream oss(Str);
 129   wvh->print(oss);
 130   EXPECT_STREQ("!0 = metadata !{null}\n", oss.str().c_str());
 131 }
 132
 133 TEST(NamedMDNodeTest, Search) {
 134   Constant *C = ConstantInt::get(Type::getInt32Ty(getGlobalContext()), 1);
 135   Constant *C2 = ConstantInt::get(Type::getInt32Ty(getGlobalContext()), 2);
 136
 137   Value *const V = C;
 138   Value *const V2 = C2;
 139   MDNode *n = MDNode::get(Context, &V, 1);
 140   MDNode *n2 = MDNode::get(Context, &V2, 1);
 141
 142   MetadataBase *Nodes[2] = { n, n2 };
 143
 144   Module *M = new Module("MyModule", getGlobalContext());
 145   const char *Name = "llvm.NMD1";
 146   NamedMDNode *NMD = NamedMDNode::Create(getGlobalContext(), Name, &Nodes[0], 2, M);
 147   std::string Str;
 148   raw_string_ostream oss(Str);
 149   NMD->print(oss);
 150   EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n!0 = metadata !{i32 1}\n"
 151                "!1 = metadata !{i32 2}\n",
 152                oss.str().c_str());
 153 }
 154 }