unittests/IR/MetadataTest.cpp

   1 //===- llvm/unittest/IR/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 "llvm/ADT/STLExtras.h"
  11 #include "llvm/IR/Constants.h"
  12 #include "llvm/IR/Instructions.h"
  13 #include "llvm/IR/LLVMContext.h"
  14 #include "llvm/IR/Metadata.h"
  15 #include "llvm/IR/Module.h"
  16 #include "llvm/IR/Type.h"
  17 #include "llvm/Support/raw_ostream.h"
  18 #include "gtest/gtest.h"
  19 using namespace llvm;
  20
  21 namespace {
  22
  23 TEST(ContextAndReplaceableUsesTest, FromContext) {
  24   LLVMContext Context;
  25   ContextAndReplaceableUses CRU(Context);
  26   EXPECT_EQ(&Context, &CRU.getContext());
  27   EXPECT_FALSE(CRU.hasReplaceableUses());
  28   EXPECT_FALSE(CRU.getReplaceableUses());
  29 }
  30
  31 TEST(ContextAndReplaceableUsesTest, FromReplaceableUses) {
  32   LLVMContext Context;
  33   ContextAndReplaceableUses CRU(make_unique<ReplaceableMetadataImpl>(Context));
  34   EXPECT_EQ(&Context, &CRU.getContext());
  35   EXPECT_TRUE(CRU.hasReplaceableUses());
  36   EXPECT_TRUE(CRU.getReplaceableUses());
  37 }
  38
  39 TEST(ContextAndReplaceableUsesTest, makeReplaceable) {
  40   LLVMContext Context;
  41   ContextAndReplaceableUses CRU(Context);
  42   CRU.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context));
  43   EXPECT_EQ(&Context, &CRU.getContext());
  44   EXPECT_TRUE(CRU.hasReplaceableUses());
  45   EXPECT_TRUE(CRU.getReplaceableUses());
  46 }
  47
  48 TEST(ContextAndReplaceableUsesTest, takeReplaceableUses) {
  49   LLVMContext Context;
  50   auto ReplaceableUses = make_unique<ReplaceableMetadataImpl>(Context);
  51   auto *Ptr = ReplaceableUses.get();
  52   ContextAndReplaceableUses CRU(std::move(ReplaceableUses));
  53   ReplaceableUses = CRU.takeReplaceableUses();
  54   EXPECT_EQ(&Context, &CRU.getContext());
  55   EXPECT_FALSE(CRU.hasReplaceableUses());
  56   EXPECT_FALSE(CRU.getReplaceableUses());
  57   EXPECT_EQ(Ptr, ReplaceableUses.get());
  58 }
  59
  60 class MetadataTest : public testing::Test {
  61 protected:
  62   LLVMContext Context;
  63   MDNode *getNode() { return MDNode::get(Context, None); }
  64   MDNode *getNode(Metadata *MD) { return MDNode::get(Context, MD); }
  65   MDNode *getNode(Metadata *MD1, Metadata *MD2) {
  66     Metadata *MDs[] = {MD1, MD2};
  67     return MDNode::get(Context, MDs);
  68   }
  69 };
  70 typedef MetadataTest MDStringTest;
  71
  72 // Test that construction of MDString with different value produces different
  73 // MDString objects, even with the same string pointer and nulls in the string.
  74 TEST_F(MDStringTest, CreateDifferent) {
  75   char x[3] = { 'f', 0, 'A' };
  76   MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
  77   x[2] = 'B';
  78   MDString *s2 = MDString::get(Context, StringRef(&x[0], 3));
  79   EXPECT_NE(s1, s2);
  80 }
  81
  82 // Test that creation of MDStrings with the same string contents produces the
  83 // same MDString object, even with different pointers.
  84 TEST_F(MDStringTest, CreateSame) {
  85   char x[4] = { 'a', 'b', 'c', 'X' };
  86   char y[4] = { 'a', 'b', 'c', 'Y' };
  87
  88   MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
  89   MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
  90   EXPECT_EQ(s1, s2);
  91 }
  92
  93 // Test that MDString prints out the string we fed it.
  94 TEST_F(MDStringTest, PrintingSimple) {
  95   char *str = new char[13];
  96   strncpy(str, "testing 1 2 3", 13);
  97   MDString *s = MDString::get(Context, StringRef(str, 13));
  98   strncpy(str, "aaaaaaaaaaaaa", 13);
  99   delete[] str;
 100
 101   std::string Str;
 102   raw_string_ostream oss(Str);
 103   s->print(oss);
 104   EXPECT_STREQ("!\"testing 1 2 3\"", oss.str().c_str());
 105 }
 106
 107 // Test printing of MDString with non-printable characters.
 108 TEST_F(MDStringTest, PrintingComplex) {
 109   char str[5] = {0, '\n', '"', '\\', (char)-1};
 110   MDString *s = MDString::get(Context, StringRef(str+0, 5));
 111   std::string Str;
 112   raw_string_ostream oss(Str);
 113   s->print(oss);
 114   EXPECT_STREQ("!\"\\00\\0A\\22\\5C\\FF\"", oss.str().c_str());
 115 }
 116
 117 typedef MetadataTest MDNodeTest;
 118
 119 // Test the two constructors, and containing other Constants.
 120 TEST_F(MDNodeTest, Simple) {
 121   char x[3] = { 'a', 'b', 'c' };
 122   char y[3] = { '1', '2', '3' };
 123
 124   MDString *s1 = MDString::get(Context, StringRef(&x[0], 3));
 125   MDString *s2 = MDString::get(Context, StringRef(&y[0], 3));
 126   ConstantAsMetadata *CI = ConstantAsMetadata::get(
 127       ConstantInt::get(getGlobalContext(), APInt(8, 0)));
 128
 129   std::vector<Metadata *> V;
 130   V.push_back(s1);
 131   V.push_back(CI);
 132   V.push_back(s2);
 133
 134   MDNode *n1 = MDNode::get(Context, V);
 135   Metadata *const c1 = n1;
 136   MDNode *n2 = MDNode::get(Context, c1);
 137   Metadata *const c2 = n2;
 138   MDNode *n3 = MDNode::get(Context, V);
 139   MDNode *n4 = MDNode::getIfExists(Context, V);
 140   MDNode *n5 = MDNode::getIfExists(Context, c1);
 141   MDNode *n6 = MDNode::getIfExists(Context, c2);
 142   EXPECT_NE(n1, n2);
 143   EXPECT_EQ(n1, n3);
 144   EXPECT_EQ(n4, n1);
 145   EXPECT_EQ(n5, n2);
 146   EXPECT_EQ(n6, (Metadata *)nullptr);
 147
 148   EXPECT_EQ(3u, n1->getNumOperands());
 149   EXPECT_EQ(s1, n1->getOperand(0));
 150   EXPECT_EQ(CI, n1->getOperand(1));
 151   EXPECT_EQ(s2, n1->getOperand(2));
 152
 153   EXPECT_EQ(1u, n2->getNumOperands());
 154   EXPECT_EQ(n1, n2->getOperand(0));
 155 }
 156
 157 TEST_F(MDNodeTest, Delete) {
 158   Constant *C = ConstantInt::get(Type::getInt32Ty(getGlobalContext()), 1);
 159   Instruction *I = new BitCastInst(C, Type::getInt32Ty(getGlobalContext()));
 160
 161   Metadata *const V = LocalAsMetadata::get(I);
 162   MDNode *n = MDNode::get(Context, V);
 163   TrackingMDRef wvh(n);
 164
 165   EXPECT_EQ(n, wvh);
 166
 167   delete I;
 168 }
 169
 170 TEST_F(MDNodeTest, SelfReference) {
 171   // !0 = !{!0}
 172   // !1 = !{!0}
 173   {
 174     auto Temp = MDNode::getTemporary(Context, None);
 175     Metadata *Args[] = {Temp.get()};
 176     MDNode *Self = MDNode::get(Context, Args);
 177     Self->replaceOperandWith(0, Self);
 178     ASSERT_EQ(Self, Self->getOperand(0));
 179
 180     // Self-references should be distinct, so MDNode::get() should grab a
 181     // uniqued node that references Self, not Self.
 182     Args[0] = Self;
 183     MDNode *Ref1 = MDNode::get(Context, Args);
 184     MDNode *Ref2 = MDNode::get(Context, Args);
 185     EXPECT_NE(Self, Ref1);
 186     EXPECT_EQ(Ref1, Ref2);
 187   }
 188
 189   // !0 = !{!0, !{}}
 190   // !1 = !{!0, !{}}
 191   {
 192     auto Temp = MDNode::getTemporary(Context, None);
 193     Metadata *Args[] = {Temp.get(), MDNode::get(Context, None)};
 194     MDNode *Self = MDNode::get(Context, Args);
 195     Self->replaceOperandWith(0, Self);
 196     ASSERT_EQ(Self, Self->getOperand(0));
 197
 198     // Self-references should be distinct, so MDNode::get() should grab a
 199     // uniqued node that references Self, not Self itself.
 200     Args[0] = Self;
 201     MDNode *Ref1 = MDNode::get(Context, Args);
 202     MDNode *Ref2 = MDNode::get(Context, Args);
 203     EXPECT_NE(Self, Ref1);
 204     EXPECT_EQ(Ref1, Ref2);
 205   }
 206 }
 207
 208 TEST_F(MDNodeTest, Print) {
 209   Constant *C = ConstantInt::get(Type::getInt32Ty(Context), 7);
 210   MDString *S = MDString::get(Context, "foo");
 211   MDNode *N0 = getNode();
 212   MDNode *N1 = getNode(N0);
 213   MDNode *N2 = getNode(N0, N1);
 214
 215   Metadata *Args[] = {ConstantAsMetadata::get(C), S, nullptr, N0, N1, N2};
 216   MDNode *N = MDNode::get(Context, Args);
 217
 218   std::string Expected;
 219   {
 220     raw_string_ostream OS(Expected);
 221     OS << "!{";
 222     C->printAsOperand(OS);
 223     OS << ", ";
 224     S->printAsOperand(OS);
 225     OS << ", null";
 226     MDNode *Nodes[] = {N0, N1, N2};
 227     for (auto *Node : Nodes)
 228       OS << ", <" << (void *)Node << ">";
 229     OS << "}\n";
 230   }
 231
 232   std::string Actual;
 233   {
 234     raw_string_ostream OS(Actual);
 235     N->print(OS);
 236   }
 237
 238   EXPECT_EQ(Expected, Actual);
 239 }
 240
 241 TEST_F(MDNodeTest, NullOperand) {
 242   // metadata !{}
 243   MDNode *Empty = MDNode::get(Context, None);
 244
 245   // metadata !{metadata !{}}
 246   Metadata *Ops[] = {Empty};
 247   MDNode *N = MDNode::get(Context, Ops);
 248   ASSERT_EQ(Empty, N->getOperand(0));
 249
 250   // metadata !{metadata !{}} => metadata !{null}
 251   N->replaceOperandWith(0, nullptr);
 252   ASSERT_EQ(nullptr, N->getOperand(0));
 253
 254   // metadata !{null}
 255   Ops[0] = nullptr;
 256   MDNode *NullOp = MDNode::get(Context, Ops);
 257   ASSERT_EQ(nullptr, NullOp->getOperand(0));
 258   EXPECT_EQ(N, NullOp);
 259 }
 260
 261 TEST_F(MDNodeTest, DistinctOnUniquingCollision) {
 262   // !{}
 263   MDNode *Empty = MDNode::get(Context, None);
 264   ASSERT_TRUE(Empty->isResolved());
 265   EXPECT_FALSE(Empty->isDistinct());
 266
 267   // !{!{}}
 268   Metadata *Wrapped1Ops[] = {Empty};
 269   MDNode *Wrapped1 = MDNode::get(Context, Wrapped1Ops);
 270   ASSERT_EQ(Empty, Wrapped1->getOperand(0));
 271   ASSERT_TRUE(Wrapped1->isResolved());
 272   EXPECT_FALSE(Wrapped1->isDistinct());
 273
 274   // !{!{!{}}}
 275   Metadata *Wrapped2Ops[] = {Wrapped1};
 276   MDNode *Wrapped2 = MDNode::get(Context, Wrapped2Ops);
 277   ASSERT_EQ(Wrapped1, Wrapped2->getOperand(0));
 278   ASSERT_TRUE(Wrapped2->isResolved());
 279   EXPECT_FALSE(Wrapped2->isDistinct());
 280
 281   // !{!{!{}}} => !{!{}}
 282   Wrapped2->replaceOperandWith(0, Empty);
 283   ASSERT_EQ(Empty, Wrapped2->getOperand(0));
 284   EXPECT_TRUE(Wrapped2->isDistinct());
 285   EXPECT_FALSE(Wrapped1->isDistinct());
 286 }
 287
 288 TEST_F(MDNodeTest, getDistinct) {
 289   // !{}
 290   MDNode *Empty = MDNode::get(Context, None);
 291   ASSERT_TRUE(Empty->isResolved());
 292   ASSERT_FALSE(Empty->isDistinct());
 293   ASSERT_EQ(Empty, MDNode::get(Context, None));
 294
 295   // distinct !{}
 296   MDNode *Distinct1 = MDNode::getDistinct(Context, None);
 297   MDNode *Distinct2 = MDNode::getDistinct(Context, None);
 298   EXPECT_TRUE(Distinct1->isResolved());
 299   EXPECT_TRUE(Distinct2->isDistinct());
 300   EXPECT_NE(Empty, Distinct1);
 301   EXPECT_NE(Empty, Distinct2);
 302   EXPECT_NE(Distinct1, Distinct2);
 303
 304   // !{}
 305   ASSERT_EQ(Empty, MDNode::get(Context, None));
 306 }
 307
 308 TEST_F(MDNodeTest, isUniqued) {
 309   MDNode *U = MDTuple::get(Context, None);
 310   MDNode *D = MDTuple::getDistinct(Context, None);
 311   auto T = MDTuple::getTemporary(Context, None);
 312   EXPECT_TRUE(U->isUniqued());
 313   EXPECT_FALSE(D->isUniqued());
 314   EXPECT_FALSE(T->isUniqued());
 315 }
 316
 317 TEST_F(MDNodeTest, isDistinct) {
 318   MDNode *U = MDTuple::get(Context, None);
 319   MDNode *D = MDTuple::getDistinct(Context, None);
 320   auto T = MDTuple::getTemporary(Context, None);
 321   EXPECT_FALSE(U->isDistinct());
 322   EXPECT_TRUE(D->isDistinct());
 323   EXPECT_FALSE(T->isDistinct());
 324 }
 325
 326 TEST_F(MDNodeTest, isTemporary) {
 327   MDNode *U = MDTuple::get(Context, None);
 328   MDNode *D = MDTuple::getDistinct(Context, None);
 329   auto T = MDTuple::getTemporary(Context, None);
 330   EXPECT_FALSE(U->isTemporary());
 331   EXPECT_FALSE(D->isTemporary());
 332   EXPECT_TRUE(T->isTemporary());
 333 }
 334
 335 TEST_F(MDNodeTest, getDistinctWithUnresolvedOperands) {
 336   // temporary !{}
 337   auto Temp = MDTuple::getTemporary(Context, None);
 338   ASSERT_FALSE(Temp->isResolved());
 339
 340   // distinct !{temporary !{}}
 341   Metadata *Ops[] = {Temp.get()};
 342   MDNode *Distinct = MDNode::getDistinct(Context, Ops);
 343   EXPECT_TRUE(Distinct->isResolved());
 344   EXPECT_EQ(Temp.get(), Distinct->getOperand(0));
 345
 346   // temporary !{} => !{}
 347   MDNode *Empty = MDNode::get(Context, None);
 348   Temp->replaceAllUsesWith(Empty);
 349   EXPECT_EQ(Empty, Distinct->getOperand(0));
 350 }
 351
 352 TEST_F(MDNodeTest, handleChangedOperandRecursion) {
 353   // !0 = !{}
 354   MDNode *N0 = MDNode::get(Context, None);
 355
 356   // !1 = !{!3, null}
 357   auto Temp3 = MDTuple::getTemporary(Context, None);
 358   Metadata *Ops1[] = {Temp3.get(), nullptr};
 359   MDNode *N1 = MDNode::get(Context, Ops1);
 360
 361   // !2 = !{!3, !0}
 362   Metadata *Ops2[] = {Temp3.get(), N0};
 363   MDNode *N2 = MDNode::get(Context, Ops2);
 364
 365   // !3 = !{!2}
 366   Metadata *Ops3[] = {N2};
 367   MDNode *N3 = MDNode::get(Context, Ops3);
 368   Temp3->replaceAllUsesWith(N3);
 369
 370   // !4 = !{!1}
 371   Metadata *Ops4[] = {N1};
 372   MDNode *N4 = MDNode::get(Context, Ops4);
 373
 374   // Confirm that the cycle prevented RAUW from getting dropped.
 375   EXPECT_TRUE(N0->isResolved());
 376   EXPECT_FALSE(N1->isResolved());
 377   EXPECT_FALSE(N2->isResolved());
 378   EXPECT_FALSE(N3->isResolved());
 379   EXPECT_FALSE(N4->isResolved());
 380
 381   // Create a couple of distinct nodes to observe what's going on.
 382   //
 383   // !5 = distinct !{!2}
 384   // !6 = distinct !{!3}
 385   Metadata *Ops5[] = {N2};
 386   MDNode *N5 = MDNode::getDistinct(Context, Ops5);
 387   Metadata *Ops6[] = {N3};
 388   MDNode *N6 = MDNode::getDistinct(Context, Ops6);
 389
 390   // Mutate !2 to look like !1, causing a uniquing collision (and an RAUW).
 391   // This will ripple up, with !3 colliding with !4, and RAUWing.  Since !2
 392   // references !3, this can cause a re-entry of handleChangedOperand() when !3
 393   // is not ready for it.
 394   //
 395   // !2->replaceOperandWith(1, nullptr)
 396   // !2: !{!3, !0} => !{!3, null}
 397   // !2->replaceAllUsesWith(!1)
 398   // !3: !{!2] => !{!1}
 399   // !3->replaceAllUsesWith(!4)
 400   N2->replaceOperandWith(1, nullptr);
 401
 402   // If all has gone well, N2 and N3 will have been RAUW'ed and deleted from
 403   // under us.  Just check that the other nodes are sane.
 404   //
 405   // !1 = !{!4, null}
 406   // !4 = !{!1}
 407   // !5 = distinct !{!1}
 408   // !6 = distinct !{!4}
 409   EXPECT_EQ(N4, N1->getOperand(0));
 410   EXPECT_EQ(N1, N4->getOperand(0));
 411   EXPECT_EQ(N1, N5->getOperand(0));
 412   EXPECT_EQ(N4, N6->getOperand(0));
 413 }
 414
 415 TEST_F(MDNodeTest, replaceResolvedOperand) {
 416   // Check code for replacing one resolved operand with another.  If doing this
 417   // directly (via replaceOperandWith()) becomes illegal, change the operand to
 418   // a global value that gets RAUW'ed.
 419   //
 420   // Use a temporary node to keep N from being resolved.
 421   auto Temp = MDTuple::getTemporary(Context, None);
 422   Metadata *Ops[] = {nullptr, Temp.get()};
 423
 424   MDNode *Empty = MDTuple::get(Context, ArrayRef<Metadata *>());
 425   MDNode *N = MDTuple::get(Context, Ops);
 426   EXPECT_EQ(nullptr, N->getOperand(0));
 427   ASSERT_FALSE(N->isResolved());
 428
 429   // Check code for replacing resolved nodes.
 430   N->replaceOperandWith(0, Empty);
 431   EXPECT_EQ(Empty, N->getOperand(0));
 432
 433   // Check code for adding another unresolved operand.
 434   N->replaceOperandWith(0, Temp.get());
 435   EXPECT_EQ(Temp.get(), N->getOperand(0));
 436
 437   // Remove the references to Temp; required for teardown.
 438   Temp->replaceAllUsesWith(nullptr);
 439 }
 440
 441 TEST_F(MDNodeTest, replaceWithUniqued) {
 442   auto *Empty = MDTuple::get(Context, None);
 443   MDTuple *FirstUniqued;
 444   {
 445     Metadata *Ops[] = {Empty};
 446     auto Temp = MDTuple::getTemporary(Context, Ops);
 447     EXPECT_TRUE(Temp->isTemporary());
 448
 449     // Don't expect a collision.
 450     auto *Current = Temp.get();
 451     FirstUniqued = MDNode::replaceWithUniqued(std::move(Temp));
 452     EXPECT_TRUE(FirstUniqued->isUniqued());
 453     EXPECT_TRUE(FirstUniqued->isResolved());
 454     EXPECT_EQ(Current, FirstUniqued);
 455   }
 456   {
 457     Metadata *Ops[] = {Empty};
 458     auto Temp = MDTuple::getTemporary(Context, Ops);
 459     EXPECT_TRUE(Temp->isTemporary());
 460
 461     // Should collide with Uniqued above this time.
 462     auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
 463     EXPECT_TRUE(Uniqued->isUniqued());
 464     EXPECT_TRUE(Uniqued->isResolved());
 465     EXPECT_EQ(FirstUniqued, Uniqued);
 466   }
 467   {
 468     auto Unresolved = MDTuple::getTemporary(Context, None);
 469     Metadata *Ops[] = {Unresolved.get()};
 470     auto Temp = MDTuple::getTemporary(Context, Ops);
 471     EXPECT_TRUE(Temp->isTemporary());
 472
 473     // Shouldn't be resolved.
 474     auto *Uniqued = MDNode::replaceWithUniqued(std::move(Temp));
 475     EXPECT_TRUE(Uniqued->isUniqued());
 476     EXPECT_FALSE(Uniqued->isResolved());
 477
 478     // Should be a different node.
 479     EXPECT_NE(FirstUniqued, Uniqued);
 480
 481     // Should resolve when we update its node (note: be careful to avoid a
 482     // collision with any other nodes above).
 483     Uniqued->replaceOperandWith(0, nullptr);
 484     EXPECT_TRUE(Uniqued->isResolved());
 485   }
 486 }
 487
 488 TEST_F(MDNodeTest, replaceWithDistinct) {
 489   {
 490     auto *Empty = MDTuple::get(Context, None);
 491     Metadata *Ops[] = {Empty};
 492     auto Temp = MDTuple::getTemporary(Context, Ops);
 493     EXPECT_TRUE(Temp->isTemporary());
 494
 495     // Don't expect a collision.
 496     auto *Current = Temp.get();
 497     auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
 498     EXPECT_TRUE(Distinct->isDistinct());
 499     EXPECT_TRUE(Distinct->isResolved());
 500     EXPECT_EQ(Current, Distinct);
 501   }
 502   {
 503     auto Unresolved = MDTuple::getTemporary(Context, None);
 504     Metadata *Ops[] = {Unresolved.get()};
 505     auto Temp = MDTuple::getTemporary(Context, Ops);
 506     EXPECT_TRUE(Temp->isTemporary());
 507
 508     // Don't expect a collision.
 509     auto *Current = Temp.get();
 510     auto *Distinct = MDNode::replaceWithDistinct(std::move(Temp));
 511     EXPECT_TRUE(Distinct->isDistinct());
 512     EXPECT_TRUE(Distinct->isResolved());
 513     EXPECT_EQ(Current, Distinct);
 514
 515     // Cleanup; required for teardown.
 516     Unresolved->replaceAllUsesWith(nullptr);
 517   }
 518 }
 519
 520 TEST_F(MDNodeTest, deleteTemporaryWithTrackingRef) {
 521   TrackingMDRef Ref;
 522   EXPECT_EQ(nullptr, Ref.get());
 523   {
 524     auto Temp = MDTuple::getTemporary(Context, None);
 525     Ref.reset(Temp.get());
 526     EXPECT_EQ(Temp.get(), Ref.get());
 527   }
 528   EXPECT_EQ(nullptr, Ref.get());
 529 }
 530
 531 typedef MetadataTest MDLocationTest;
 532
 533 TEST_F(MDLocationTest, Overflow) {
 534   MDNode *N = MDNode::get(Context, None);
 535   {
 536     MDLocation *L = MDLocation::get(Context, 2, 7, N);
 537     EXPECT_EQ(2u, L->getLine());
 538     EXPECT_EQ(7u, L->getColumn());
 539   }
 540   unsigned U24 = 1u << 24;
 541   unsigned U16 = 1u << 16;
 542   {
 543     MDLocation *L = MDLocation::get(Context, U24 - 1, U16 - 1, N);
 544     EXPECT_EQ(U24 - 1, L->getLine());
 545     EXPECT_EQ(U16 - 1, L->getColumn());
 546   }
 547   {
 548     MDLocation *L = MDLocation::get(Context, U24, U16, N);
 549     EXPECT_EQ(0u, L->getLine());
 550     EXPECT_EQ(0u, L->getColumn());
 551   }
 552   {
 553     MDLocation *L = MDLocation::get(Context, U24 + 1, U16 + 1, N);
 554     EXPECT_EQ(0u, L->getLine());
 555     EXPECT_EQ(0u, L->getColumn());
 556   }
 557 }
 558
 559 TEST_F(MDLocationTest, getDistinct) {
 560   MDNode *N = MDNode::get(Context, None);
 561   MDLocation *L0 = MDLocation::getDistinct(Context, 2, 7, N);
 562   EXPECT_TRUE(L0->isDistinct());
 563   MDLocation *L1 = MDLocation::get(Context, 2, 7, N);
 564   EXPECT_FALSE(L1->isDistinct());
 565   EXPECT_EQ(L1, MDLocation::get(Context, 2, 7, N));
 566 }
 567
 568 TEST_F(MDLocationTest, getTemporary) {
 569   MDNode *N = MDNode::get(Context, None);
 570   auto L = MDLocation::getTemporary(Context, 2, 7, N);
 571   EXPECT_TRUE(L->isTemporary());
 572   EXPECT_FALSE(L->isResolved());
 573 }
 574
 575 typedef MetadataTest GenericDwarfNodeTest;
 576
 577 TEST_F(GenericDwarfNodeTest, get) {
 578   auto *Header = MDString::get(Context, "header");
 579   auto *Empty = MDNode::get(Context, None);
 580   Metadata *Ops1[] = {Empty};
 581   auto *N = GenericDwarfNode::get(Context, 15, Header, Ops1);
 582   EXPECT_EQ(15u, N->getTag());
 583   EXPECT_EQ(2u, N->getNumOperands());
 584   EXPECT_EQ(Header, N->getHeader());
 585   EXPECT_EQ(Header, N->getOperand(0));
 586   EXPECT_EQ(1u, N->getNumDwarfOperands());
 587   EXPECT_EQ(Empty, N->getDwarfOperand(0));
 588   EXPECT_EQ(Empty, N->getOperand(1));
 589   ASSERT_TRUE(N->isUniqued());
 590
 591   EXPECT_EQ(N, GenericDwarfNode::get(Context, 15, Header, Ops1));
 592
 593   N->replaceOperandWith(1, nullptr);
 594   EXPECT_EQ(15u, N->getTag());
 595   EXPECT_EQ(Header, N->getHeader());
 596   EXPECT_EQ(nullptr, N->getDwarfOperand(0));
 597   ASSERT_TRUE(N->isUniqued());
 598
 599   Metadata *Ops2[] = {nullptr};
 600   EXPECT_EQ(N, GenericDwarfNode::get(Context, 15, Header, Ops2));
 601
 602   N->replaceDwarfOperandWith(0, Empty);
 603   EXPECT_EQ(15u, N->getTag());
 604   EXPECT_EQ(Header, N->getHeader());
 605   EXPECT_EQ(Empty, N->getDwarfOperand(0));
 606   ASSERT_TRUE(N->isUniqued());
 607   EXPECT_EQ(N, GenericDwarfNode::get(Context, 15, Header, Ops1));
 608 }
 609
 610 TEST_F(GenericDwarfNodeTest, getEmptyHeader) {
 611   // Canonicalize !"" to null.
 612   auto *Header = MDString::get(Context, "");
 613   EXPECT_NE(nullptr, Header);
 614   auto *N = GenericDwarfNode::get(Context, 15, Header, None);
 615   EXPECT_EQ(nullptr, N->getHeader());
 616 }
 617
 618 typedef MetadataTest MetadataAsValueTest;
 619
 620 TEST_F(MetadataAsValueTest, MDNode) {
 621   MDNode *N = MDNode::get(Context, None);
 622   auto *V = MetadataAsValue::get(Context, N);
 623   EXPECT_TRUE(V->getType()->isMetadataTy());
 624   EXPECT_EQ(N, V->getMetadata());
 625
 626   auto *V2 = MetadataAsValue::get(Context, N);
 627   EXPECT_EQ(V, V2);
 628 }
 629
 630 TEST_F(MetadataAsValueTest, MDNodeMDNode) {
 631   MDNode *N = MDNode::get(Context, None);
 632   Metadata *Ops[] = {N};
 633   MDNode *N2 = MDNode::get(Context, Ops);
 634   auto *V = MetadataAsValue::get(Context, N2);
 635   EXPECT_TRUE(V->getType()->isMetadataTy());
 636   EXPECT_EQ(N2, V->getMetadata());
 637
 638   auto *V2 = MetadataAsValue::get(Context, N2);
 639   EXPECT_EQ(V, V2);
 640
 641   auto *V3 = MetadataAsValue::get(Context, N);
 642   EXPECT_TRUE(V3->getType()->isMetadataTy());
 643   EXPECT_NE(V, V3);
 644   EXPECT_EQ(N, V3->getMetadata());
 645 }
 646
 647 TEST_F(MetadataAsValueTest, MDNodeConstant) {
 648   auto *C = ConstantInt::getTrue(Context);
 649   auto *MD = ConstantAsMetadata::get(C);
 650   Metadata *Ops[] = {MD};
 651   auto *N = MDNode::get(Context, Ops);
 652
 653   auto *V = MetadataAsValue::get(Context, MD);
 654   EXPECT_TRUE(V->getType()->isMetadataTy());
 655   EXPECT_EQ(MD, V->getMetadata());
 656
 657   auto *V2 = MetadataAsValue::get(Context, N);
 658   EXPECT_EQ(MD, V2->getMetadata());
 659   EXPECT_EQ(V, V2);
 660 }
 661
 662 typedef MetadataTest ValueAsMetadataTest;
 663
 664 TEST_F(ValueAsMetadataTest, UpdatesOnRAUW) {
 665   Type *Ty = Type::getInt1PtrTy(Context);
 666   std::unique_ptr<GlobalVariable> GV0(
 667       new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
 668   auto *MD = ValueAsMetadata::get(GV0.get());
 669   EXPECT_TRUE(MD->getValue() == GV0.get());
 670   ASSERT_TRUE(GV0->use_empty());
 671
 672   std::unique_ptr<GlobalVariable> GV1(
 673       new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
 674   GV0->replaceAllUsesWith(GV1.get());
 675   EXPECT_TRUE(MD->getValue() == GV1.get());
 676 }
 677
 678 TEST_F(ValueAsMetadataTest, CollidingDoubleUpdates) {
 679   // Create a constant.
 680   ConstantAsMetadata *CI = ConstantAsMetadata::get(
 681       ConstantInt::get(getGlobalContext(), APInt(8, 0)));
 682
 683   // Create a temporary to prevent nodes from resolving.
 684   auto Temp = MDTuple::getTemporary(Context, None);
 685
 686   // When the first operand of N1 gets reset to nullptr, it'll collide with N2.
 687   Metadata *Ops1[] = {CI, CI, Temp.get()};
 688   Metadata *Ops2[] = {nullptr, CI, Temp.get()};
 689
 690   auto *N1 = MDTuple::get(Context, Ops1);
 691   auto *N2 = MDTuple::get(Context, Ops2);
 692   ASSERT_NE(N1, N2);
 693
 694   // Tell metadata that the constant is getting deleted.
 695   //
 696   // After this, N1 will be invalid, so don't touch it.
 697   ValueAsMetadata::handleDeletion(CI->getValue());
 698   EXPECT_EQ(nullptr, N2->getOperand(0));
 699   EXPECT_EQ(nullptr, N2->getOperand(1));
 700   EXPECT_EQ(Temp.get(), N2->getOperand(2));
 701
 702   // Clean up Temp for teardown.
 703   Temp->replaceAllUsesWith(nullptr);
 704 }
 705
 706 typedef MetadataTest TrackingMDRefTest;
 707
 708 TEST_F(TrackingMDRefTest, UpdatesOnRAUW) {
 709   Type *Ty = Type::getInt1PtrTy(Context);
 710   std::unique_ptr<GlobalVariable> GV0(
 711       new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
 712   TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV0.get()));
 713   EXPECT_TRUE(MD->getValue() == GV0.get());
 714   ASSERT_TRUE(GV0->use_empty());
 715
 716   std::unique_ptr<GlobalVariable> GV1(
 717       new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
 718   GV0->replaceAllUsesWith(GV1.get());
 719   EXPECT_TRUE(MD->getValue() == GV1.get());
 720
 721   // Reset it, so we don't inadvertently test deletion.
 722   MD.reset();
 723 }
 724
 725 TEST_F(TrackingMDRefTest, UpdatesOnDeletion) {
 726   Type *Ty = Type::getInt1PtrTy(Context);
 727   std::unique_ptr<GlobalVariable> GV(
 728       new GlobalVariable(Ty, false, GlobalValue::ExternalLinkage));
 729   TypedTrackingMDRef<ValueAsMetadata> MD(ValueAsMetadata::get(GV.get()));
 730   EXPECT_TRUE(MD->getValue() == GV.get());
 731   ASSERT_TRUE(GV->use_empty());
 732
 733   GV.reset();
 734   EXPECT_TRUE(!MD);
 735 }
 736
 737 TEST(NamedMDNodeTest, Search) {
 738   LLVMContext Context;
 739   ConstantAsMetadata *C =
 740       ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 1));
 741   ConstantAsMetadata *C2 =
 742       ConstantAsMetadata::get(ConstantInt::get(Type::getInt32Ty(Context), 2));
 743
 744   Metadata *const V = C;
 745   Metadata *const V2 = C2;
 746   MDNode *n = MDNode::get(Context, V);
 747   MDNode *n2 = MDNode::get(Context, V2);
 748
 749   Module M("MyModule", Context);
 750   const char *Name = "llvm.NMD1";
 751   NamedMDNode *NMD = M.getOrInsertNamedMetadata(Name);
 752   NMD->addOperand(n);
 753   NMD->addOperand(n2);
 754
 755   std::string Str;
 756   raw_string_ostream oss(Str);
 757   NMD->print(oss);
 758   EXPECT_STREQ("!llvm.NMD1 = !{!0, !1}\n",
 759                oss.str().c_str());
 760 }
 761 }