lib/Transforms/IPO/LowerBitSets.cpp

   1 //===-- LowerBitSets.cpp - Bitset lowering pass ---------------------------===//
   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 // This pass lowers bitset metadata and calls to the llvm.bitset.test intrinsic.
  11 // See http://llvm.org/docs/LangRef.html#bitsets for more information.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Transforms/IPO/LowerBitSets.h"
  16 #include "llvm/Transforms/IPO.h"
  17 #include "llvm/ADT/EquivalenceClasses.h"
  18 #include "llvm/ADT/Statistic.h"
  19 #include "llvm/ADT/Triple.h"
  20 #include "llvm/IR/Constant.h"
  21 #include "llvm/IR/Constants.h"
  22 #include "llvm/IR/GlobalVariable.h"
  23 #include "llvm/IR/IRBuilder.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/IR/Intrinsics.h"
  26 #include "llvm/IR/Module.h"
  27 #include "llvm/IR/Operator.h"
  28 #include "llvm/Pass.h"
  29 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  30
  31 using namespace llvm;
  32
  33 #define DEBUG_TYPE "lowerbitsets"
  34
  35 STATISTIC(ByteArraySizeBits, "Byte array size in bits");
  36 STATISTIC(ByteArraySizeBytes, "Byte array size in bytes");
  37 STATISTIC(NumByteArraysCreated, "Number of byte arrays created");
  38 STATISTIC(NumBitSetCallsLowered, "Number of bitset calls lowered");
  39 STATISTIC(NumBitSetDisjointSets, "Number of disjoint sets of bitsets");
  40
  41 static cl::opt<bool> AvoidReuse(
  42     "lowerbitsets-avoid-reuse",
  43     cl::desc("Try to avoid reuse of byte array addresses using aliases"),
  44     cl::Hidden, cl::init(true));
  45
  46 bool BitSetInfo::containsGlobalOffset(uint64_t Offset) const {
  47   if (Offset < ByteOffset)
  48     return false;
  49
  50   if ((Offset - ByteOffset) % (uint64_t(1) << AlignLog2) != 0)
  51     return false;
  52
  53   uint64_t BitOffset = (Offset - ByteOffset) >> AlignLog2;
  54   if (BitOffset >= BitSize)
  55     return false;
  56
  57   return Bits.count(BitOffset);
  58 }
  59
  60 bool BitSetInfo::containsValue(
  61     const DataLayout &DL,
  62     const DenseMap<GlobalVariable *, uint64_t> &GlobalLayout, Value *V,
  63     uint64_t COffset) const {
  64   if (auto GV = dyn_cast<GlobalVariable>(V)) {
  65     auto I = GlobalLayout.find(GV);
  66     if (I == GlobalLayout.end())
  67       return false;
  68     return containsGlobalOffset(I->second + COffset);
  69   }
  70
  71   if (auto GEP = dyn_cast<GEPOperator>(V)) {
  72     APInt APOffset(DL.getPointerSizeInBits(0), 0);
  73     bool Result = GEP->accumulateConstantOffset(DL, APOffset);
  74     if (!Result)
  75       return false;
  76     COffset += APOffset.getZExtValue();
  77     return containsValue(DL, GlobalLayout, GEP->getPointerOperand(),
  78                          COffset);
  79   }
  80
  81   if (auto Op = dyn_cast<Operator>(V)) {
  82     if (Op->getOpcode() == Instruction::BitCast)
  83       return containsValue(DL, GlobalLayout, Op->getOperand(0), COffset);
  84
  85     if (Op->getOpcode() == Instruction::Select)
  86       return containsValue(DL, GlobalLayout, Op->getOperand(1), COffset) &&
  87              containsValue(DL, GlobalLayout, Op->getOperand(2), COffset);
  88   }
  89
  90   return false;
  91 }
  92
  93 BitSetInfo BitSetBuilder::build() {
  94   if (Min > Max)
  95     Min = 0;
  96
  97   // Normalize each offset against the minimum observed offset, and compute
  98   // the bitwise OR of each of the offsets. The number of trailing zeros
  99   // in the mask gives us the log2 of the alignment of all offsets, which
 100   // allows us to compress the bitset by only storing one bit per aligned
 101   // address.
 102   uint64_t Mask = 0;
 103   for (uint64_t &Offset : Offsets) {
 104     Offset -= Min;
 105     Mask |= Offset;
 106   }
 107
 108   BitSetInfo BSI;
 109   BSI.ByteOffset = Min;
 110
 111   BSI.AlignLog2 = 0;
 112   if (Mask != 0)
 113     BSI.AlignLog2 = countTrailingZeros(Mask, ZB_Undefined);
 114
 115   // Build the compressed bitset while normalizing the offsets against the
 116   // computed alignment.
 117   BSI.BitSize = ((Max - Min) >> BSI.AlignLog2) + 1;
 118   for (uint64_t Offset : Offsets) {
 119     Offset >>= BSI.AlignLog2;
 120     BSI.Bits.insert(Offset);
 121   }
 122
 123   return BSI;
 124 }
 125
 126 void GlobalLayoutBuilder::addFragment(const std::set<uint64_t> &F) {
 127   // Create a new fragment to hold the layout for F.
 128   Fragments.emplace_back();
 129   std::vector<uint64_t> &Fragment = Fragments.back();
 130   uint64_t FragmentIndex = Fragments.size() - 1;
 131
 132   for (auto ObjIndex : F) {
 133     uint64_t OldFragmentIndex = FragmentMap[ObjIndex];
 134     if (OldFragmentIndex == 0) {
 135       // We haven't seen this object index before, so just add it to the current
 136       // fragment.
 137       Fragment.push_back(ObjIndex);
 138     } else {
 139       // This index belongs to an existing fragment. Copy the elements of the
 140       // old fragment into this one and clear the old fragment. We don't update
 141       // the fragment map just yet, this ensures that any further references to
 142       // indices from the old fragment in this fragment do not insert any more
 143       // indices.
 144       std::vector<uint64_t> &OldFragment = Fragments[OldFragmentIndex];
 145       Fragment.insert(Fragment.end(), OldFragment.begin(), OldFragment.end());
 146       OldFragment.clear();
 147     }
 148   }
 149
 150   // Update the fragment map to point our object indices to this fragment.
 151   for (uint64_t ObjIndex : Fragment)
 152     FragmentMap[ObjIndex] = FragmentIndex;
 153 }
 154
 155 void ByteArrayBuilder::allocate(const std::set<uint64_t> &Bits,
 156                                 uint64_t BitSize, uint64_t &AllocByteOffset,
 157                                 uint8_t &AllocMask) {
 158   // Find the smallest current allocation.
 159   unsigned Bit = 0;
 160   for (unsigned I = 1; I != BitsPerByte; ++I)
 161     if (BitAllocs[I] < BitAllocs[Bit])
 162       Bit = I;
 163
 164   AllocByteOffset = BitAllocs[Bit];
 165
 166   // Add our size to it.
 167   unsigned ReqSize = AllocByteOffset + BitSize;
 168   BitAllocs[Bit] = ReqSize;
 169   if (Bytes.size() < ReqSize)
 170     Bytes.resize(ReqSize);
 171
 172   // Set our bits.
 173   AllocMask = 1 << Bit;
 174   for (uint64_t B : Bits)
 175     Bytes[AllocByteOffset + B] |= AllocMask;
 176 }
 177
 178 namespace {
 179
 180 struct ByteArrayInfo {
 181   std::set<uint64_t> Bits;
 182   uint64_t BitSize;
 183   GlobalVariable *ByteArray;
 184   Constant *Mask;
 185 };
 186
 187 struct LowerBitSets : public ModulePass {
 188   static char ID;
 189   LowerBitSets() : ModulePass(ID) {
 190     initializeLowerBitSetsPass(*PassRegistry::getPassRegistry());
 191   }
 192
 193   Module *M;
 194
 195   bool LinkerSubsectionsViaSymbols;
 196   IntegerType *Int1Ty;
 197   IntegerType *Int8Ty;
 198   IntegerType *Int32Ty;
 199   Type *Int32PtrTy;
 200   IntegerType *Int64Ty;
 201   Type *IntPtrTy;
 202
 203   // The llvm.bitsets named metadata.
 204   NamedMDNode *BitSetNM;
 205
 206   // Mapping from bitset mdstrings to the call sites that test them.
 207   DenseMap<MDString *, std::vector<CallInst *>> BitSetTestCallSites;
 208
 209   std::vector<ByteArrayInfo> ByteArrayInfos;
 210
 211   BitSetInfo
 212   buildBitSet(MDString *BitSet,
 213               const DenseMap<GlobalVariable *, uint64_t> &GlobalLayout);
 214   ByteArrayInfo *createByteArray(BitSetInfo &BSI);
 215   void allocateByteArrays();
 216   Value *createBitSetTest(IRBuilder<> &B, BitSetInfo &BSI, ByteArrayInfo *&BAI,
 217                           Value *BitOffset);
 218   Value *
 219   lowerBitSetCall(CallInst *CI, BitSetInfo &BSI, ByteArrayInfo *&BAI,
 220                   GlobalVariable *CombinedGlobal,
 221                   const DenseMap<GlobalVariable *, uint64_t> &GlobalLayout);
 222   void buildBitSetsFromGlobals(const std::vector<MDString *> &BitSets,
 223                                const std::vector<GlobalVariable *> &Globals);
 224   bool buildBitSets();
 225   bool eraseBitSetMetadata();
 226
 227   bool doInitialization(Module &M) override;
 228   bool runOnModule(Module &M) override;
 229 };
 230
 231 } // namespace
 232
 233 INITIALIZE_PASS_BEGIN(LowerBitSets, "lowerbitsets",
 234                 "Lower bitset metadata", false, false)
 235 INITIALIZE_PASS_END(LowerBitSets, "lowerbitsets",
 236                 "Lower bitset metadata", false, false)
 237 char LowerBitSets::ID = 0;
 238
 239 ModulePass *llvm::createLowerBitSetsPass() { return new LowerBitSets; }
 240
 241 bool LowerBitSets::doInitialization(Module &Mod) {
 242   M = &Mod;
 243   const DataLayout &DL = Mod.getDataLayout();
 244
 245   Triple TargetTriple(M->getTargetTriple());
 246   LinkerSubsectionsViaSymbols = TargetTriple.isMacOSX();
 247
 248   Int1Ty = Type::getInt1Ty(M->getContext());
 249   Int8Ty = Type::getInt8Ty(M->getContext());
 250   Int32Ty = Type::getInt32Ty(M->getContext());
 251   Int32PtrTy = PointerType::getUnqual(Int32Ty);
 252   Int64Ty = Type::getInt64Ty(M->getContext());
 253   IntPtrTy = DL.getIntPtrType(M->getContext(), 0);
 254
 255   BitSetNM = M->getNamedMetadata("llvm.bitsets");
 256
 257   BitSetTestCallSites.clear();
 258
 259   return false;
 260 }
 261
 262 /// Build a bit set for BitSet using the object layouts in
 263 /// GlobalLayout.
 264 BitSetInfo LowerBitSets::buildBitSet(
 265     MDString *BitSet,
 266     const DenseMap<GlobalVariable *, uint64_t> &GlobalLayout) {
 267   BitSetBuilder BSB;
 268
 269   // Compute the byte offset of each element of this bitset.
 270   if (BitSetNM) {
 271     for (MDNode *Op : BitSetNM->operands()) {
 272       if (Op->getOperand(0) != BitSet || !Op->getOperand(1))
 273         continue;
 274       auto OpGlobal = cast<GlobalVariable>(
 275           cast<ConstantAsMetadata>(Op->getOperand(1))->getValue());
 276       uint64_t Offset =
 277           cast<ConstantInt>(cast<ConstantAsMetadata>(Op->getOperand(2))
 278                                 ->getValue())->getZExtValue();
 279
 280       Offset += GlobalLayout.find(OpGlobal)->second;
 281
 282       BSB.addOffset(Offset);
 283     }
 284   }
 285
 286   return BSB.build();
 287 }
 288
 289 /// Build a test that bit BitOffset mod sizeof(Bits)*8 is set in
 290 /// Bits. This pattern matches to the bt instruction on x86.
 291 static Value *createMaskedBitTest(IRBuilder<> &B, Value *Bits,
 292                                   Value *BitOffset) {
 293   auto BitsType = cast<IntegerType>(Bits->getType());
 294   unsigned BitWidth = BitsType->getBitWidth();
 295
 296   BitOffset = B.CreateZExtOrTrunc(BitOffset, BitsType);
 297   Value *BitIndex =
 298       B.CreateAnd(BitOffset, ConstantInt::get(BitsType, BitWidth - 1));
 299   Value *BitMask = B.CreateShl(ConstantInt::get(BitsType, 1), BitIndex);
 300   Value *MaskedBits = B.CreateAnd(Bits, BitMask);
 301   return B.CreateICmpNE(MaskedBits, ConstantInt::get(BitsType, 0));
 302 }
 303
 304 ByteArrayInfo *LowerBitSets::createByteArray(BitSetInfo &BSI) {
 305   // Create globals to stand in for byte arrays and masks. These never actually
 306   // get initialized, we RAUW and erase them later in allocateByteArrays() once
 307   // we know the offset and mask to use.
 308   auto ByteArrayGlobal = new GlobalVariable(
 309       *M, Int8Ty, /*isConstant=*/true, GlobalValue::PrivateLinkage, nullptr);
 310   auto MaskGlobal = new GlobalVariable(
 311       *M, Int8Ty, /*isConstant=*/true, GlobalValue::PrivateLinkage, nullptr);
 312
 313   ByteArrayInfos.emplace_back();
 314   ByteArrayInfo *BAI = &ByteArrayInfos.back();
 315
 316   BAI->Bits = BSI.Bits;
 317   BAI->BitSize = BSI.BitSize;
 318   BAI->ByteArray = ByteArrayGlobal;
 319   BAI->Mask = ConstantExpr::getPtrToInt(MaskGlobal, Int8Ty);
 320   return BAI;
 321 }
 322
 323 void LowerBitSets::allocateByteArrays() {
 324   std::stable_sort(ByteArrayInfos.begin(), ByteArrayInfos.end(),
 325                    [](const ByteArrayInfo &BAI1, const ByteArrayInfo &BAI2) {
 326                      return BAI1.BitSize > BAI2.BitSize;
 327                    });
 328
 329   std::vector<uint64_t> ByteArrayOffsets(ByteArrayInfos.size());
 330
 331   ByteArrayBuilder BAB;
 332   for (unsigned I = 0; I != ByteArrayInfos.size(); ++I) {
 333     ByteArrayInfo *BAI = &ByteArrayInfos[I];
 334
 335     uint8_t Mask;
 336     BAB.allocate(BAI->Bits, BAI->BitSize, ByteArrayOffsets[I], Mask);
 337
 338     BAI->Mask->replaceAllUsesWith(ConstantInt::get(Int8Ty, Mask));
 339     cast<GlobalVariable>(BAI->Mask->getOperand(0))->eraseFromParent();
 340   }
 341
 342   Constant *ByteArrayConst = ConstantDataArray::get(M->getContext(), BAB.Bytes);
 343   auto ByteArray =
 344       new GlobalVariable(*M, ByteArrayConst->getType(), /*isConstant=*/true,
 345                          GlobalValue::PrivateLinkage, ByteArrayConst);
 346
 347   for (unsigned I = 0; I != ByteArrayInfos.size(); ++I) {
 348     ByteArrayInfo *BAI = &ByteArrayInfos[I];
 349
 350     Constant *Idxs[] = {ConstantInt::get(IntPtrTy, 0),
 351                         ConstantInt::get(IntPtrTy, ByteArrayOffsets[I])};
 352     Constant *GEP = ConstantExpr::getInBoundsGetElementPtr(
 353         ByteArrayConst->getType(), ByteArray, Idxs);
 354
 355     // Create an alias instead of RAUW'ing the gep directly. On x86 this ensures
 356     // that the pc-relative displacement is folded into the lea instead of the
 357     // test instruction getting another displacement.
 358     if (LinkerSubsectionsViaSymbols) {
 359       BAI->ByteArray->replaceAllUsesWith(GEP);
 360     } else {
 361       GlobalAlias *Alias =
 362           GlobalAlias::create(PointerType::getUnqual(Int8Ty),
 363                               GlobalValue::PrivateLinkage, "bits", GEP, M);
 364       BAI->ByteArray->replaceAllUsesWith(Alias);
 365     }
 366     BAI->ByteArray->eraseFromParent();
 367   }
 368
 369   ByteArraySizeBits = BAB.BitAllocs[0] + BAB.BitAllocs[1] + BAB.BitAllocs[2] +
 370                       BAB.BitAllocs[3] + BAB.BitAllocs[4] + BAB.BitAllocs[5] +
 371                       BAB.BitAllocs[6] + BAB.BitAllocs[7];
 372   ByteArraySizeBytes = BAB.Bytes.size();
 373 }
 374
 375 /// Build a test that bit BitOffset is set in BSI, where
 376 /// BitSetGlobal is a global containing the bits in BSI.
 377 Value *LowerBitSets::createBitSetTest(IRBuilder<> &B, BitSetInfo &BSI,
 378                                       ByteArrayInfo *&BAI, Value *BitOffset) {
 379   if (BSI.BitSize <= 64) {
 380     // If the bit set is sufficiently small, we can avoid a load by bit testing
 381     // a constant.
 382     IntegerType *BitsTy;
 383     if (BSI.BitSize <= 32)
 384       BitsTy = Int32Ty;
 385     else
 386       BitsTy = Int64Ty;
 387
 388     uint64_t Bits = 0;
 389     for (auto Bit : BSI.Bits)
 390       Bits |= uint64_t(1) << Bit;
 391     Constant *BitsConst = ConstantInt::get(BitsTy, Bits);
 392     return createMaskedBitTest(B, BitsConst, BitOffset);
 393   } else {
 394     if (!BAI) {
 395       ++NumByteArraysCreated;
 396       BAI = createByteArray(BSI);
 397     }
 398
 399     Constant *ByteArray = BAI->ByteArray;
 400     Type *Ty = BAI->ByteArray->getValueType();
 401     if (!LinkerSubsectionsViaSymbols && AvoidReuse) {
 402       // Each use of the byte array uses a different alias. This makes the
 403       // backend less likely to reuse previously computed byte array addresses,
 404       // improving the security of the CFI mechanism based on this pass.
 405       ByteArray = GlobalAlias::create(BAI->ByteArray->getType(),
 406                                       GlobalValue::PrivateLinkage, "bits_use",
 407                                       ByteArray, M);
 408     }
 409
 410     Value *ByteAddr = B.CreateGEP(Ty, ByteArray, BitOffset);
 411     Value *Byte = B.CreateLoad(ByteAddr);
 412
 413     Value *ByteAndMask = B.CreateAnd(Byte, BAI->Mask);
 414     return B.CreateICmpNE(ByteAndMask, ConstantInt::get(Int8Ty, 0));
 415   }
 416 }
 417
 418 /// Lower a llvm.bitset.test call to its implementation. Returns the value to
 419 /// replace the call with.
 420 Value *LowerBitSets::lowerBitSetCall(
 421     CallInst *CI, BitSetInfo &BSI, ByteArrayInfo *&BAI,
 422     GlobalVariable *CombinedGlobal,
 423     const DenseMap<GlobalVariable *, uint64_t> &GlobalLayout) {
 424   Value *Ptr = CI->getArgOperand(0);
 425   const DataLayout &DL = M->getDataLayout();
 426
 427   if (BSI.containsValue(DL, GlobalLayout, Ptr))
 428     return ConstantInt::getTrue(CombinedGlobal->getParent()->getContext());
 429
 430   Constant *GlobalAsInt = ConstantExpr::getPtrToInt(CombinedGlobal, IntPtrTy);
 431   Constant *OffsetedGlobalAsInt = ConstantExpr::getAdd(
 432       GlobalAsInt, ConstantInt::get(IntPtrTy, BSI.ByteOffset));
 433
 434   BasicBlock *InitialBB = CI->getParent();
 435
 436   IRBuilder<> B(CI);
 437
 438   Value *PtrAsInt = B.CreatePtrToInt(Ptr, IntPtrTy);
 439
 440   if (BSI.isSingleOffset())
 441     return B.CreateICmpEQ(PtrAsInt, OffsetedGlobalAsInt);
 442
 443   Value *PtrOffset = B.CreateSub(PtrAsInt, OffsetedGlobalAsInt);
 444
 445   Value *BitOffset;
 446   if (BSI.AlignLog2 == 0) {
 447     BitOffset = PtrOffset;
 448   } else {
 449     // We need to check that the offset both falls within our range and is
 450     // suitably aligned. We can check both properties at the same time by
 451     // performing a right rotate by log2(alignment) followed by an integer
 452     // comparison against the bitset size. The rotate will move the lower
 453     // order bits that need to be zero into the higher order bits of the
 454     // result, causing the comparison to fail if they are nonzero. The rotate
 455     // also conveniently gives us a bit offset to use during the load from
 456     // the bitset.
 457     Value *OffsetSHR =
 458         B.CreateLShr(PtrOffset, ConstantInt::get(IntPtrTy, BSI.AlignLog2));
 459     Value *OffsetSHL = B.CreateShl(
 460         PtrOffset,
 461         ConstantInt::get(IntPtrTy, DL.getPointerSizeInBits(0) - BSI.AlignLog2));
 462     BitOffset = B.CreateOr(OffsetSHR, OffsetSHL);
 463   }
 464
 465   Constant *BitSizeConst = ConstantInt::get(IntPtrTy, BSI.BitSize);
 466   Value *OffsetInRange = B.CreateICmpULT(BitOffset, BitSizeConst);
 467
 468   // If the bit set is all ones, testing against it is unnecessary.
 469   if (BSI.isAllOnes())
 470     return OffsetInRange;
 471
 472   TerminatorInst *Term = SplitBlockAndInsertIfThen(OffsetInRange, CI, false);
 473   IRBuilder<> ThenB(Term);
 474
 475   // Now that we know that the offset is in range and aligned, load the
 476   // appropriate bit from the bitset.
 477   Value *Bit = createBitSetTest(ThenB, BSI, BAI, BitOffset);
 478
 479   // The value we want is 0 if we came directly from the initial block
 480   // (having failed the range or alignment checks), or the loaded bit if
 481   // we came from the block in which we loaded it.
 482   B.SetInsertPoint(CI);
 483   PHINode *P = B.CreatePHI(Int1Ty, 2);
 484   P->addIncoming(ConstantInt::get(Int1Ty, 0), InitialBB);
 485   P->addIncoming(Bit, ThenB.GetInsertBlock());
 486   return P;
 487 }
 488
 489 /// Given a disjoint set of bitsets and globals, layout the globals, build the
 490 /// bit sets and lower the llvm.bitset.test calls.
 491 void LowerBitSets::buildBitSetsFromGlobals(
 492     const std::vector<MDString *> &BitSets,
 493     const std::vector<GlobalVariable *> &Globals) {
 494   // Build a new global with the combined contents of the referenced globals.
 495   std::vector<Constant *> GlobalInits;
 496   const DataLayout &DL = M->getDataLayout();
 497   for (GlobalVariable *G : Globals) {
 498     GlobalInits.push_back(G->getInitializer());
 499     uint64_t InitSize = DL.getTypeAllocSize(G->getInitializer()->getType());
 500
 501     // Compute the amount of padding required to align the next element to the
 502     // next power of 2.
 503     uint64_t Padding = NextPowerOf2(InitSize - 1) - InitSize;
 504
 505     // Cap at 128 was found experimentally to have a good data/instruction
 506     // overhead tradeoff.
 507     if (Padding > 128)
 508       Padding = RoundUpToAlignment(InitSize, 128) - InitSize;
 509
 510     GlobalInits.push_back(
 511         ConstantAggregateZero::get(ArrayType::get(Int8Ty, Padding)));
 512   }
 513   if (!GlobalInits.empty())
 514     GlobalInits.pop_back();
 515   Constant *NewInit = ConstantStruct::getAnon(M->getContext(), GlobalInits);
 516   auto CombinedGlobal =
 517       new GlobalVariable(*M, NewInit->getType(), /*isConstant=*/true,
 518                          GlobalValue::PrivateLinkage, NewInit);
 519
 520   const StructLayout *CombinedGlobalLayout =
 521       DL.getStructLayout(cast<StructType>(NewInit->getType()));
 522
 523   // Compute the offsets of the original globals within the new global.
 524   DenseMap<GlobalVariable *, uint64_t> GlobalLayout;
 525   for (unsigned I = 0; I != Globals.size(); ++I)
 526     // Multiply by 2 to account for padding elements.
 527     GlobalLayout[Globals[I]] = CombinedGlobalLayout->getElementOffset(I * 2);
 528
 529   // For each bitset in this disjoint set...
 530   for (MDString *BS : BitSets) {
 531     // Build the bitset.
 532     BitSetInfo BSI = buildBitSet(BS, GlobalLayout);
 533
 534     ByteArrayInfo *BAI = 0;
 535
 536     // Lower each call to llvm.bitset.test for this bitset.
 537     for (CallInst *CI : BitSetTestCallSites[BS]) {
 538       ++NumBitSetCallsLowered;
 539       Value *Lowered = lowerBitSetCall(CI, BSI, BAI, CombinedGlobal, GlobalLayout);
 540       CI->replaceAllUsesWith(Lowered);
 541       CI->eraseFromParent();
 542     }
 543   }
 544
 545   // Build aliases pointing to offsets into the combined global for each
 546   // global from which we built the combined global, and replace references
 547   // to the original globals with references to the aliases.
 548   for (unsigned I = 0; I != Globals.size(); ++I) {
 549     // Multiply by 2 to account for padding elements.
 550     Constant *CombinedGlobalIdxs[] = {ConstantInt::get(Int32Ty, 0),
 551                                       ConstantInt::get(Int32Ty, I * 2)};
 552     Constant *CombinedGlobalElemPtr = ConstantExpr::getGetElementPtr(
 553         NewInit->getType(), CombinedGlobal, CombinedGlobalIdxs);
 554     if (LinkerSubsectionsViaSymbols) {
 555       Globals[I]->replaceAllUsesWith(CombinedGlobalElemPtr);
 556     } else {
 557       GlobalAlias *GAlias =
 558           GlobalAlias::create(Globals[I]->getType(), Globals[I]->getLinkage(),
 559                               "data", CombinedGlobalElemPtr, M);
 560       if (Globals[I]->hasName())
 561         GAlias->takeName(Globals[I]);
 562       Globals[I]->replaceAllUsesWith(GAlias);
 563     }
 564     Globals[I]->eraseFromParent();
 565   }
 566 }
 567
 568 /// Lower all bit sets in this module.
 569 bool LowerBitSets::buildBitSets() {
 570   Function *BitSetTestFunc =
 571       M->getFunction(Intrinsic::getName(Intrinsic::bitset_test));
 572   if (!BitSetTestFunc)
 573     return false;
 574
 575   // Equivalence class set containing bitsets and the globals they reference.
 576   // This is used to partition the set of bitsets in the module into disjoint
 577   // sets.
 578   typedef EquivalenceClasses<PointerUnion<GlobalVariable *, MDString *>>
 579       GlobalClassesTy;
 580   GlobalClassesTy GlobalClasses;
 581
 582   for (const Use &U : BitSetTestFunc->uses()) {
 583     auto CI = cast<CallInst>(U.getUser());
 584
 585     auto BitSetMDVal = dyn_cast<MetadataAsValue>(CI->getArgOperand(1));
 586     if (!BitSetMDVal || !isa<MDString>(BitSetMDVal->getMetadata()))
 587       report_fatal_error(
 588           "Second argument of llvm.bitset.test must be metadata string");
 589     auto BitSet = cast<MDString>(BitSetMDVal->getMetadata());
 590
 591     // Add the call site to the list of call sites for this bit set. We also use
 592     // BitSetTestCallSites to keep track of whether we have seen this bit set
 593     // before. If we have, we don't need to re-add the referenced globals to the
 594     // equivalence class.
 595     std::pair<DenseMap<MDString *, std::vector<CallInst *>>::iterator,
 596               bool> Ins =
 597         BitSetTestCallSites.insert(
 598             std::make_pair(BitSet, std::vector<CallInst *>()));
 599     Ins.first->second.push_back(CI);
 600     if (!Ins.second)
 601       continue;
 602
 603     // Add the bitset to the equivalence class.
 604     GlobalClassesTy::iterator GCI = GlobalClasses.insert(BitSet);
 605     GlobalClassesTy::member_iterator CurSet = GlobalClasses.findLeader(GCI);
 606
 607     if (!BitSetNM)
 608       continue;
 609
 610     // Verify the bitset metadata and add the referenced globals to the bitset's
 611     // equivalence class.
 612     for (MDNode *Op : BitSetNM->operands()) {
 613       if (Op->getNumOperands() != 3)
 614         report_fatal_error(
 615             "All operands of llvm.bitsets metadata must have 3 elements");
 616
 617       if (Op->getOperand(0) != BitSet || !Op->getOperand(1))
 618         continue;
 619
 620       auto OpConstMD = dyn_cast<ConstantAsMetadata>(Op->getOperand(1));
 621       if (!OpConstMD)
 622         report_fatal_error("Bit set element must be a constant");
 623       auto OpGlobal = dyn_cast<GlobalVariable>(OpConstMD->getValue());
 624       if (!OpGlobal)
 625         report_fatal_error("Bit set element must refer to global");
 626
 627       auto OffsetConstMD = dyn_cast<ConstantAsMetadata>(Op->getOperand(2));
 628       if (!OffsetConstMD)
 629         report_fatal_error("Bit set element offset must be a constant");
 630       auto OffsetInt = dyn_cast<ConstantInt>(OffsetConstMD->getValue());
 631       if (!OffsetInt)
 632         report_fatal_error(
 633             "Bit set element offset must be an integer constant");
 634
 635       CurSet = GlobalClasses.unionSets(
 636           CurSet, GlobalClasses.findLeader(GlobalClasses.insert(OpGlobal)));
 637     }
 638   }
 639
 640   if (GlobalClasses.empty())
 641     return false;
 642
 643   // For each disjoint set we found...
 644   for (GlobalClassesTy::iterator I = GlobalClasses.begin(),
 645                                  E = GlobalClasses.end();
 646        I != E; ++I) {
 647     if (!I->isLeader()) continue;
 648
 649     ++NumBitSetDisjointSets;
 650
 651     // Build the list of bitsets and referenced globals in this disjoint set.
 652     std::vector<MDString *> BitSets;
 653     std::vector<GlobalVariable *> Globals;
 654     llvm::DenseMap<MDString *, uint64_t> BitSetIndices;
 655     llvm::DenseMap<GlobalVariable *, uint64_t> GlobalIndices;
 656     for (GlobalClassesTy::member_iterator MI = GlobalClasses.member_begin(I);
 657          MI != GlobalClasses.member_end(); ++MI) {
 658       if ((*MI).is<MDString *>()) {
 659         BitSetIndices[MI->get<MDString *>()] = BitSets.size();
 660         BitSets.push_back(MI->get<MDString *>());
 661       } else {
 662         GlobalIndices[MI->get<GlobalVariable *>()] = Globals.size();
 663         Globals.push_back(MI->get<GlobalVariable *>());
 664       }
 665     }
 666
 667     // For each bitset, build a set of indices that refer to globals referenced
 668     // by the bitset.
 669     std::vector<std::set<uint64_t>> BitSetMembers(BitSets.size());
 670     if (BitSetNM) {
 671       for (MDNode *Op : BitSetNM->operands()) {
 672         // Op = { bitset name, global, offset }
 673         if (!Op->getOperand(1))
 674           continue;
 675         auto I = BitSetIndices.find(cast<MDString>(Op->getOperand(0)));
 676         if (I == BitSetIndices.end())
 677           continue;
 678
 679         auto OpGlobal = cast<GlobalVariable>(
 680             cast<ConstantAsMetadata>(Op->getOperand(1))->getValue());
 681         BitSetMembers[I->second].insert(GlobalIndices[OpGlobal]);
 682       }
 683     }
 684
 685     // Order the sets of indices by size. The GlobalLayoutBuilder works best
 686     // when given small index sets first.
 687     std::stable_sort(
 688         BitSetMembers.begin(), BitSetMembers.end(),
 689         [](const std::set<uint64_t> &O1, const std::set<uint64_t> &O2) {
 690           return O1.size() < O2.size();
 691         });
 692
 693     // Create a GlobalLayoutBuilder and provide it with index sets as layout
 694     // fragments. The GlobalLayoutBuilder tries to lay out members of fragments
 695     // as close together as possible.
 696     GlobalLayoutBuilder GLB(Globals.size());
 697     for (auto &&MemSet : BitSetMembers)
 698       GLB.addFragment(MemSet);
 699
 700     // Build a vector of globals with the computed layout.
 701     std::vector<GlobalVariable *> OrderedGlobals(Globals.size());
 702     auto OGI = OrderedGlobals.begin();
 703     for (auto &&F : GLB.Fragments)
 704       for (auto &&Offset : F)
 705         *OGI++ = Globals[Offset];
 706
 707     // Order bitsets by name for determinism.
 708     std::sort(BitSets.begin(), BitSets.end(), [](MDString *S1, MDString *S2) {
 709       return S1->getString() < S2->getString();
 710     });
 711
 712     // Build the bitsets from this disjoint set.
 713     buildBitSetsFromGlobals(BitSets, OrderedGlobals);
 714   }
 715
 716   allocateByteArrays();
 717
 718   return true;
 719 }
 720
 721 bool LowerBitSets::eraseBitSetMetadata() {
 722   if (!BitSetNM)
 723     return false;
 724
 725   M->eraseNamedMetadata(BitSetNM);
 726   return true;
 727 }
 728
 729 bool LowerBitSets::runOnModule(Module &M) {
 730   bool Changed = buildBitSets();
 731   Changed |= eraseBitSetMetadata();
 732   return Changed;
 733 }