lib/Bitcode/Writer/ValueEnumerator.cpp

   1 //===-- ValueEnumerator.cpp - Number values and types for bitcode writer --===//
   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 file implements the ValueEnumerator class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "ValueEnumerator.h"
  15 #include "llvm/ADT/STLExtras.h"
  16 #include "llvm/ADT/SmallPtrSet.h"
  17 #include "llvm/IR/Constants.h"
  18 #include "llvm/IR/DerivedTypes.h"
  19 #include "llvm/IR/Instructions.h"
  20 #include "llvm/IR/Module.h"
  21 #include "llvm/IR/UseListOrder.h"
  22 #include "llvm/IR/ValueSymbolTable.h"
  23 #include "llvm/Support/Debug.h"
  24 #include "llvm/Support/raw_ostream.h"
  25 #include <algorithm>
  26 using namespace llvm;
  27
  28 namespace {
  29 struct OrderMap {
  30   DenseMap<const Value *, std::pair<unsigned, bool>> IDs;
  31   unsigned LastGlobalConstantID;
  32   unsigned LastGlobalValueID;
  33
  34   OrderMap() : LastGlobalConstantID(0), LastGlobalValueID(0) {}
  35
  36   bool isGlobalConstant(unsigned ID) const {
  37     return ID <= LastGlobalConstantID;
  38   }
  39   bool isGlobalValue(unsigned ID) const {
  40     return ID <= LastGlobalValueID && !isGlobalConstant(ID);
  41   }
  42
  43   unsigned size() const { return IDs.size(); }
  44   std::pair<unsigned, bool> &operator[](const Value *V) { return IDs[V]; }
  45   std::pair<unsigned, bool> lookup(const Value *V) const {
  46     return IDs.lookup(V);
  47   }
  48   void index(const Value *V) {
  49     // Explicitly sequence get-size and insert-value operations to avoid UB.
  50     unsigned ID = IDs.size() + 1;
  51     IDs[V].first = ID;
  52   }
  53 };
  54 }
  55
  56 static void orderValue(const Value *V, OrderMap &OM) {
  57   if (OM.lookup(V).first)
  58     return;
  59
  60   if (const Constant *C = dyn_cast<Constant>(V))
  61     if (C->getNumOperands() && !isa<GlobalValue>(C))
  62       for (const Value *Op : C->operands())
  63         if (!isa<BasicBlock>(Op) && !isa<GlobalValue>(Op))
  64           orderValue(Op, OM);
  65
  66   // Note: we cannot cache this lookup above, since inserting into the map
  67   // changes the map's size, and thus affects the other IDs.
  68   OM.index(V);
  69 }
  70
  71 static OrderMap orderModule(const Module *M) {
  72   // This needs to match the order used by ValueEnumerator::ValueEnumerator()
  73   // and ValueEnumerator::incorporateFunction().
  74   OrderMap OM;
  75
  76   // In the reader, initializers of GlobalValues are set *after* all the
  77   // globals have been read.  Rather than awkwardly modeling this behaviour
  78   // directly in predictValueUseListOrderImpl(), just assign IDs to
  79   // initializers of GlobalValues before GlobalValues themselves to model this
  80   // implicitly.
  81   for (const GlobalVariable &G : M->globals())
  82     if (G.hasInitializer())
  83       orderValue(G.getInitializer(), OM);
  84   for (const GlobalAlias &A : M->aliases())
  85     orderValue(A.getAliasee(), OM);
  86   for (const Function &F : *M)
  87     if (F.hasPrefixData())
  88       orderValue(F.getPrefixData(), OM);
  89   OM.LastGlobalConstantID = OM.size();
  90
  91   // Initializers of GlobalValues are processed in
  92   // BitcodeReader::ResolveGlobalAndAliasInits().  Match the order there rather
  93   // than ValueEnumerator, and match the code in predictValueUseListOrderImpl()
  94   // by giving IDs in reverse order.
  95   //
  96   // Since GlobalValues never reference each other directly (just through
  97   // initializers), their relative IDs only matter for determining order of
  98   // uses in their initializers.
  99   for (const Function &F : *M)
 100     orderValue(&F, OM);
 101   for (const GlobalAlias &A : M->aliases())
 102     orderValue(&A, OM);
 103   for (const GlobalVariable &G : M->globals())
 104     orderValue(&G, OM);
 105   OM.LastGlobalValueID = OM.size();
 106
 107   for (const Function &F : *M) {
 108     if (F.isDeclaration())
 109       continue;
 110     // Here we need to match the union of ValueEnumerator::incorporateFunction()
 111     // and WriteFunction().  Basic blocks are implicitly declared before
 112     // anything else (by declaring their size).
 113     for (const BasicBlock &BB : F)
 114       orderValue(&BB, OM);
 115     for (const Argument &A : F.args())
 116       orderValue(&A, OM);
 117     for (const BasicBlock &BB : F)
 118       for (const Instruction &I : BB)
 119         for (const Value *Op : I.operands())
 120           if ((isa<Constant>(*Op) && !isa<GlobalValue>(*Op)) ||
 121               isa<InlineAsm>(*Op))
 122             orderValue(Op, OM);
 123     for (const BasicBlock &BB : F)
 124       for (const Instruction &I : BB)
 125         orderValue(&I, OM);
 126   }
 127   return OM;
 128 }
 129
 130 static void predictValueUseListOrderImpl(const Value *V, const Function *F,
 131                                          unsigned ID, const OrderMap &OM,
 132                                          UseListOrderStack &Stack) {
 133   // Predict use-list order for this one.
 134   typedef std::pair<const Use *, unsigned> Entry;
 135   SmallVector<Entry, 64> List;
 136   for (const Use &U : V->uses())
 137     // Check if this user will be serialized.
 138     if (OM.lookup(U.getUser()).first)
 139       List.push_back(std::make_pair(&U, List.size()));
 140
 141   if (List.size() < 2)
 142     // We may have lost some users.
 143     return;
 144
 145   bool IsGlobalValue = OM.isGlobalValue(ID);
 146   std::sort(List.begin(), List.end(), [&](const Entry &L, const Entry &R) {
 147     const Use *LU = L.first;
 148     const Use *RU = R.first;
 149     if (LU == RU)
 150       return false;
 151
 152     auto LID = OM.lookup(LU->getUser()).first;
 153     auto RID = OM.lookup(RU->getUser()).first;
 154
 155     // Global values are processed in reverse order.
 156     //
 157     // Moreover, initializers of GlobalValues are set *after* all the globals
 158     // have been read (despite having earlier IDs).  Rather than awkwardly
 159     // modeling this behaviour here, orderModule() has assigned IDs to
 160     // initializers of GlobalValues before GlobalValues themselves.
 161     if (OM.isGlobalValue(LID) && OM.isGlobalValue(RID))
 162       return LID < RID;
 163
 164     // If ID is 4, then expect: 7 6 5 1 2 3.
 165     if (LID < RID) {
 166       if (RID < ID)
 167         if (!IsGlobalValue) // GlobalValue uses don't get reversed.
 168           return true;
 169       return false;
 170     }
 171     if (RID < LID) {
 172       if (LID < ID)
 173         if (!IsGlobalValue) // GlobalValue uses don't get reversed.
 174           return false;
 175       return true;
 176     }
 177
 178     // LID and RID are equal, so we have different operands of the same user.
 179     // Assume operands are added in order for all instructions.
 180     if (LID < ID)
 181       if (!IsGlobalValue) // GlobalValue uses don't get reversed.
 182         return LU->getOperandNo() < RU->getOperandNo();
 183     return LU->getOperandNo() > RU->getOperandNo();
 184   });
 185
 186   if (std::is_sorted(
 187           List.begin(), List.end(),
 188           [](const Entry &L, const Entry &R) { return L.second < R.second; }))
 189     // Order is already correct.
 190     return;
 191
 192   // Store the shuffle.
 193   Stack.emplace_back(V, F, List.size());
 194   assert(List.size() == Stack.back().Shuffle.size() && "Wrong size");
 195   for (size_t I = 0, E = List.size(); I != E; ++I)
 196     Stack.back().Shuffle[I] = List[I].second;
 197 }
 198
 199 static void predictValueUseListOrder(const Value *V, const Function *F,
 200                                      OrderMap &OM, UseListOrderStack &Stack) {
 201   auto &IDPair = OM[V];
 202   assert(IDPair.first && "Unmapped value");
 203   if (IDPair.second)
 204     // Already predicted.
 205     return;
 206
 207   // Do the actual prediction.
 208   IDPair.second = true;
 209   if (!V->use_empty() && std::next(V->use_begin()) != V->use_end())
 210     predictValueUseListOrderImpl(V, F, IDPair.first, OM, Stack);
 211
 212   // Recursive descent into constants.
 213   if (const Constant *C = dyn_cast<Constant>(V))
 214     if (C->getNumOperands()) // Visit GlobalValues.
 215       for (const Value *Op : C->operands())
 216         if (isa<Constant>(Op)) // Visit GlobalValues.
 217           predictValueUseListOrder(Op, F, OM, Stack);
 218 }
 219
 220 static UseListOrderStack predictUseListOrder(const Module *M) {
 221   OrderMap OM = orderModule(M);
 222
 223   // Use-list orders need to be serialized after all the users have been added
 224   // to a value, or else the shuffles will be incomplete.  Store them per
 225   // function in a stack.
 226   //
 227   // Aside from function order, the order of values doesn't matter much here.
 228   UseListOrderStack Stack;
 229
 230   // We want to visit the functions backward now so we can list function-local
 231   // constants in the last Function they're used in.  Module-level constants
 232   // have already been visited above.
 233   for (auto I = M->rbegin(), E = M->rend(); I != E; ++I) {
 234     const Function &F = *I;
 235     if (F.isDeclaration())
 236       continue;
 237     for (const BasicBlock &BB : F)
 238       predictValueUseListOrder(&BB, &F, OM, Stack);
 239     for (const Argument &A : F.args())
 240       predictValueUseListOrder(&A, &F, OM, Stack);
 241     for (const BasicBlock &BB : F)
 242       for (const Instruction &I : BB)
 243         for (const Value *Op : I.operands())
 244           if (isa<Constant>(*Op) || isa<InlineAsm>(*Op)) // Visit GlobalValues.
 245             predictValueUseListOrder(Op, &F, OM, Stack);
 246     for (const BasicBlock &BB : F)
 247       for (const Instruction &I : BB)
 248         predictValueUseListOrder(&I, &F, OM, Stack);
 249   }
 250
 251   // Visit globals last, since the module-level use-list block will be seen
 252   // before the function bodies are processed.
 253   for (const GlobalVariable &G : M->globals())
 254     predictValueUseListOrder(&G, nullptr, OM, Stack);
 255   for (const Function &F : *M)
 256     predictValueUseListOrder(&F, nullptr, OM, Stack);
 257   for (const GlobalAlias &A : M->aliases())
 258     predictValueUseListOrder(&A, nullptr, OM, Stack);
 259   for (const GlobalVariable &G : M->globals())
 260     if (G.hasInitializer())
 261       predictValueUseListOrder(G.getInitializer(), nullptr, OM, Stack);
 262   for (const GlobalAlias &A : M->aliases())
 263     predictValueUseListOrder(A.getAliasee(), nullptr, OM, Stack);
 264   for (const Function &F : *M)
 265     if (F.hasPrefixData())
 266       predictValueUseListOrder(F.getPrefixData(), nullptr, OM, Stack);
 267
 268   return Stack;
 269 }
 270
 271 static bool isIntOrIntVectorValue(const std::pair<const Value*, unsigned> &V) {
 272   return V.first->getType()->isIntOrIntVectorTy();
 273 }
 274
 275 /// ValueEnumerator - Enumerate module-level information.
 276 ValueEnumerator::ValueEnumerator(const Module *M) {
 277   if (shouldPreserveBitcodeUseListOrder())
 278     UseListOrders = predictUseListOrder(M);
 279
 280   // Enumerate the global variables.
 281   for (Module::const_global_iterator I = M->global_begin(),
 282
 283          E = M->global_end(); I != E; ++I)
 284     EnumerateValue(I);
 285
 286   // Enumerate the functions.
 287   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I) {
 288     EnumerateValue(I);
 289     EnumerateAttributes(cast<Function>(I)->getAttributes());
 290   }
 291
 292   // Enumerate the aliases.
 293   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
 294        I != E; ++I)
 295     EnumerateValue(I);
 296
 297   // Remember what is the cutoff between globalvalue's and other constants.
 298   unsigned FirstConstant = Values.size();
 299
 300   // Enumerate the global variable initializers.
 301   for (Module::const_global_iterator I = M->global_begin(),
 302          E = M->global_end(); I != E; ++I)
 303     if (I->hasInitializer())
 304       EnumerateValue(I->getInitializer());
 305
 306   // Enumerate the aliasees.
 307   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
 308        I != E; ++I)
 309     EnumerateValue(I->getAliasee());
 310
 311   // Enumerate the prefix data constants.
 312   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 313     if (I->hasPrefixData())
 314       EnumerateValue(I->getPrefixData());
 315
 316   // Insert constants and metadata that are named at module level into the slot
 317   // pool so that the module symbol table can refer to them...
 318   EnumerateValueSymbolTable(M->getValueSymbolTable());
 319   EnumerateNamedMetadata(M);
 320
 321   SmallVector<std::pair<unsigned, MDNode*>, 8> MDs;
 322
 323   // Enumerate types used by function bodies and argument lists.
 324   for (const Function &F : *M) {
 325     for (const Argument &A : F.args())
 326       EnumerateType(A.getType());
 327
 328     for (const BasicBlock &BB : F)
 329       for (const Instruction &I : BB) {
 330         for (const Use &Op : I.operands()) {
 331           if (MDNode *MD = dyn_cast<MDNode>(&Op))
 332             if (MD->isFunctionLocal() && MD->getFunction())
 333               // These will get enumerated during function-incorporation.
 334               continue;
 335           EnumerateOperandType(Op);
 336         }
 337         EnumerateType(I.getType());
 338         if (const CallInst *CI = dyn_cast<CallInst>(&I))
 339           EnumerateAttributes(CI->getAttributes());
 340         else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I))
 341           EnumerateAttributes(II->getAttributes());
 342
 343         // Enumerate metadata attached with this instruction.
 344         MDs.clear();
 345         I.getAllMetadataOtherThanDebugLoc(MDs);
 346         for (unsigned i = 0, e = MDs.size(); i != e; ++i)
 347           EnumerateMetadata(MDs[i].second);
 348
 349         if (!I.getDebugLoc().isUnknown()) {
 350           MDNode *Scope, *IA;
 351           I.getDebugLoc().getScopeAndInlinedAt(Scope, IA, I.getContext());
 352           if (Scope) EnumerateMetadata(Scope);
 353           if (IA) EnumerateMetadata(IA);
 354         }
 355       }
 356   }
 357
 358   // Optimize constant ordering.
 359   OptimizeConstants(FirstConstant, Values.size());
 360 }
 361
 362 unsigned ValueEnumerator::getInstructionID(const Instruction *Inst) const {
 363   InstructionMapType::const_iterator I = InstructionMap.find(Inst);
 364   assert(I != InstructionMap.end() && "Instruction is not mapped!");
 365   return I->second;
 366 }
 367
 368 unsigned ValueEnumerator::getComdatID(const Comdat *C) const {
 369   unsigned ComdatID = Comdats.idFor(C);
 370   assert(ComdatID && "Comdat not found!");
 371   return ComdatID;
 372 }
 373
 374 void ValueEnumerator::setInstructionID(const Instruction *I) {
 375   InstructionMap[I] = InstructionCount++;
 376 }
 377
 378 unsigned ValueEnumerator::getValueID(const Value *V) const {
 379   if (isa<MDNode>(V) || isa<MDString>(V)) {
 380     ValueMapType::const_iterator I = MDValueMap.find(V);
 381     assert(I != MDValueMap.end() && "Value not in slotcalculator!");
 382     return I->second-1;
 383   }
 384
 385   ValueMapType::const_iterator I = ValueMap.find(V);
 386   assert(I != ValueMap.end() && "Value not in slotcalculator!");
 387   return I->second-1;
 388 }
 389
 390 void ValueEnumerator::dump() const {
 391   print(dbgs(), ValueMap, "Default");
 392   dbgs() << '\n';
 393   print(dbgs(), MDValueMap, "MetaData");
 394   dbgs() << '\n';
 395 }
 396
 397 void ValueEnumerator::print(raw_ostream &OS, const ValueMapType &Map,
 398                             const char *Name) const {
 399
 400   OS << "Map Name: " << Name << "\n";
 401   OS << "Size: " << Map.size() << "\n";
 402   for (ValueMapType::const_iterator I = Map.begin(),
 403          E = Map.end(); I != E; ++I) {
 404
 405     const Value *V = I->first;
 406     if (V->hasName())
 407       OS << "Value: " << V->getName();
 408     else
 409       OS << "Value: [null]\n";
 410     V->dump();
 411
 412     OS << " Uses(" << std::distance(V->use_begin(),V->use_end()) << "):";
 413     for (const Use &U : V->uses()) {
 414       if (&U != &*V->use_begin())
 415         OS << ",";
 416       if(U->hasName())
 417         OS << " " << U->getName();
 418       else
 419         OS << " [null]";
 420
 421     }
 422     OS <<  "\n\n";
 423   }
 424 }
 425
 426 /// OptimizeConstants - Reorder constant pool for denser encoding.
 427 void ValueEnumerator::OptimizeConstants(unsigned CstStart, unsigned CstEnd) {
 428   if (CstStart == CstEnd || CstStart+1 == CstEnd) return;
 429
 430   if (shouldPreserveBitcodeUseListOrder())
 431     // Optimizing constants makes the use-list order difficult to predict.
 432     // Disable it for now when trying to preserve the order.
 433     return;
 434
 435   std::stable_sort(Values.begin() + CstStart, Values.begin() + CstEnd,
 436                    [this](const std::pair<const Value *, unsigned> &LHS,
 437                           const std::pair<const Value *, unsigned> &RHS) {
 438     // Sort by plane.
 439     if (LHS.first->getType() != RHS.first->getType())
 440       return getTypeID(LHS.first->getType()) < getTypeID(RHS.first->getType());
 441     // Then by frequency.
 442     return LHS.second > RHS.second;
 443   });
 444
 445   // Ensure that integer and vector of integer constants are at the start of the
 446   // constant pool.  This is important so that GEP structure indices come before
 447   // gep constant exprs.
 448   std::partition(Values.begin()+CstStart, Values.begin()+CstEnd,
 449                  isIntOrIntVectorValue);
 450
 451   // Rebuild the modified portion of ValueMap.
 452   for (; CstStart != CstEnd; ++CstStart)
 453     ValueMap[Values[CstStart].first] = CstStart+1;
 454 }
 455
 456
 457 /// EnumerateValueSymbolTable - Insert all of the values in the specified symbol
 458 /// table into the values table.
 459 void ValueEnumerator::EnumerateValueSymbolTable(const ValueSymbolTable &VST) {
 460   for (ValueSymbolTable::const_iterator VI = VST.begin(), VE = VST.end();
 461        VI != VE; ++VI)
 462     EnumerateValue(VI->getValue());
 463 }
 464
 465 /// EnumerateNamedMetadata - Insert all of the values referenced by
 466 /// named metadata in the specified module.
 467 void ValueEnumerator::EnumerateNamedMetadata(const Module *M) {
 468   for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
 469        E = M->named_metadata_end(); I != E; ++I)
 470     EnumerateNamedMDNode(I);
 471 }
 472
 473 void ValueEnumerator::EnumerateNamedMDNode(const NamedMDNode *MD) {
 474   for (unsigned i = 0, e = MD->getNumOperands(); i != e; ++i)
 475     EnumerateMetadata(MD->getOperand(i));
 476 }
 477
 478 /// EnumerateMDNodeOperands - Enumerate all non-function-local values
 479 /// and types referenced by the given MDNode.
 480 void ValueEnumerator::EnumerateMDNodeOperands(const MDNode *N) {
 481   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 482     if (Value *V = N->getOperand(i)) {
 483       if (isa<MDNode>(V) || isa<MDString>(V))
 484         EnumerateMetadata(V);
 485       else if (!isa<Instruction>(V) && !isa<Argument>(V))
 486         EnumerateValue(V);
 487     } else
 488       EnumerateType(Type::getVoidTy(N->getContext()));
 489   }
 490 }
 491
 492 void ValueEnumerator::EnumerateMetadata(const Value *MD) {
 493   assert((isa<MDNode>(MD) || isa<MDString>(MD)) && "Invalid metadata kind");
 494
 495   // Enumerate the type of this value.
 496   EnumerateType(MD->getType());
 497
 498   const MDNode *N = dyn_cast<MDNode>(MD);
 499
 500   // In the module-level pass, skip function-local nodes themselves, but
 501   // do walk their operands.
 502   if (N && N->isFunctionLocal() && N->getFunction()) {
 503     EnumerateMDNodeOperands(N);
 504     return;
 505   }
 506
 507   // Check to see if it's already in!
 508   unsigned &MDValueID = MDValueMap[MD];
 509   if (MDValueID) {
 510     // Increment use count.
 511     MDValues[MDValueID-1].second++;
 512     return;
 513   }
 514   MDValues.push_back(std::make_pair(MD, 1U));
 515   MDValueID = MDValues.size();
 516
 517   // Enumerate all non-function-local operands.
 518   if (N)
 519     EnumerateMDNodeOperands(N);
 520 }
 521
 522 /// EnumerateFunctionLocalMetadataa - Incorporate function-local metadata
 523 /// information reachable from the given MDNode.
 524 void ValueEnumerator::EnumerateFunctionLocalMetadata(const MDNode *N) {
 525   assert(N->isFunctionLocal() && N->getFunction() &&
 526          "EnumerateFunctionLocalMetadata called on non-function-local mdnode!");
 527
 528   // Enumerate the type of this value.
 529   EnumerateType(N->getType());
 530
 531   // Check to see if it's already in!
 532   unsigned &MDValueID = MDValueMap[N];
 533   if (MDValueID) {
 534     // Increment use count.
 535     MDValues[MDValueID-1].second++;
 536     return;
 537   }
 538   MDValues.push_back(std::make_pair(N, 1U));
 539   MDValueID = MDValues.size();
 540
 541   // To incoroporate function-local information visit all function-local
 542   // MDNodes and all function-local values they reference.
 543   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 544     if (Value *V = N->getOperand(i)) {
 545       if (MDNode *O = dyn_cast<MDNode>(V)) {
 546         if (O->isFunctionLocal() && O->getFunction())
 547           EnumerateFunctionLocalMetadata(O);
 548       } else if (isa<Instruction>(V) || isa<Argument>(V))
 549         EnumerateValue(V);
 550     }
 551
 552   // Also, collect all function-local MDNodes for easy access.
 553   FunctionLocalMDs.push_back(N);
 554 }
 555
 556 void ValueEnumerator::EnumerateValue(const Value *V) {
 557   assert(!V->getType()->isVoidTy() && "Can't insert void values!");
 558   assert(!isa<MDNode>(V) && !isa<MDString>(V) &&
 559          "EnumerateValue doesn't handle Metadata!");
 560
 561   // Check to see if it's already in!
 562   unsigned &ValueID = ValueMap[V];
 563   if (ValueID) {
 564     // Increment use count.
 565     Values[ValueID-1].second++;
 566     return;
 567   }
 568
 569   if (auto *GO = dyn_cast<GlobalObject>(V))
 570     if (const Comdat *C = GO->getComdat())
 571       Comdats.insert(C);
 572
 573   // Enumerate the type of this value.
 574   EnumerateType(V->getType());
 575
 576   if (const Constant *C = dyn_cast<Constant>(V)) {
 577     if (isa<GlobalValue>(C)) {
 578       // Initializers for globals are handled explicitly elsewhere.
 579     } else if (C->getNumOperands()) {
 580       // If a constant has operands, enumerate them.  This makes sure that if a
 581       // constant has uses (for example an array of const ints), that they are
 582       // inserted also.
 583
 584       // We prefer to enumerate them with values before we enumerate the user
 585       // itself.  This makes it more likely that we can avoid forward references
 586       // in the reader.  We know that there can be no cycles in the constants
 587       // graph that don't go through a global variable.
 588       for (User::const_op_iterator I = C->op_begin(), E = C->op_end();
 589            I != E; ++I)
 590         if (!isa<BasicBlock>(*I)) // Don't enumerate BB operand to BlockAddress.
 591           EnumerateValue(*I);
 592
 593       // Finally, add the value.  Doing this could make the ValueID reference be
 594       // dangling, don't reuse it.
 595       Values.push_back(std::make_pair(V, 1U));
 596       ValueMap[V] = Values.size();
 597       return;
 598     }
 599   }
 600
 601   // Add the value.
 602   Values.push_back(std::make_pair(V, 1U));
 603   ValueID = Values.size();
 604 }
 605
 606
 607 void ValueEnumerator::EnumerateType(Type *Ty) {
 608   unsigned *TypeID = &TypeMap[Ty];
 609
 610   // We've already seen this type.
 611   if (*TypeID)
 612     return;
 613
 614   // If it is a non-anonymous struct, mark the type as being visited so that we
 615   // don't recursively visit it.  This is safe because we allow forward
 616   // references of these in the bitcode reader.
 617   if (StructType *STy = dyn_cast<StructType>(Ty))
 618     if (!STy->isLiteral())
 619       *TypeID = ~0U;
 620
 621   // Enumerate all of the subtypes before we enumerate this type.  This ensures
 622   // that the type will be enumerated in an order that can be directly built.
 623   for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 624        I != E; ++I)
 625     EnumerateType(*I);
 626
 627   // Refresh the TypeID pointer in case the table rehashed.
 628   TypeID = &TypeMap[Ty];
 629
 630   // Check to see if we got the pointer another way.  This can happen when
 631   // enumerating recursive types that hit the base case deeper than they start.
 632   //
 633   // If this is actually a struct that we are treating as forward ref'able,
 634   // then emit the definition now that all of its contents are available.
 635   if (*TypeID && *TypeID != ~0U)
 636     return;
 637
 638   // Add this type now that its contents are all happily enumerated.
 639   Types.push_back(Ty);
 640
 641   *TypeID = Types.size();
 642 }
 643
 644 // Enumerate the types for the specified value.  If the value is a constant,
 645 // walk through it, enumerating the types of the constant.
 646 void ValueEnumerator::EnumerateOperandType(const Value *V) {
 647   EnumerateType(V->getType());
 648
 649   if (const Constant *C = dyn_cast<Constant>(V)) {
 650     // If this constant is already enumerated, ignore it, we know its type must
 651     // be enumerated.
 652     if (ValueMap.count(V)) return;
 653
 654     // This constant may have operands, make sure to enumerate the types in
 655     // them.
 656     for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
 657       const Value *Op = C->getOperand(i);
 658
 659       // Don't enumerate basic blocks here, this happens as operands to
 660       // blockaddress.
 661       if (isa<BasicBlock>(Op)) continue;
 662
 663       EnumerateOperandType(Op);
 664     }
 665
 666     if (const MDNode *N = dyn_cast<MDNode>(V)) {
 667       for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 668         if (Value *Elem = N->getOperand(i))
 669           EnumerateOperandType(Elem);
 670     }
 671   } else if (isa<MDString>(V) || isa<MDNode>(V))
 672     EnumerateMetadata(V);
 673 }
 674
 675 void ValueEnumerator::EnumerateAttributes(AttributeSet PAL) {
 676   if (PAL.isEmpty()) return;  // null is always 0.
 677
 678   // Do a lookup.
 679   unsigned &Entry = AttributeMap[PAL];
 680   if (Entry == 0) {
 681     // Never saw this before, add it.
 682     Attribute.push_back(PAL);
 683     Entry = Attribute.size();
 684   }
 685
 686   // Do lookups for all attribute groups.
 687   for (unsigned i = 0, e = PAL.getNumSlots(); i != e; ++i) {
 688     AttributeSet AS = PAL.getSlotAttributes(i);
 689     unsigned &Entry = AttributeGroupMap[AS];
 690     if (Entry == 0) {
 691       AttributeGroups.push_back(AS);
 692       Entry = AttributeGroups.size();
 693     }
 694   }
 695 }
 696
 697 void ValueEnumerator::incorporateFunction(const Function &F) {
 698   InstructionCount = 0;
 699   NumModuleValues = Values.size();
 700   NumModuleMDValues = MDValues.size();
 701
 702   // Adding function arguments to the value table.
 703   for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end();
 704        I != E; ++I)
 705     EnumerateValue(I);
 706
 707   FirstFuncConstantID = Values.size();
 708
 709   // Add all function-level constants to the value table.
 710   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 711     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I)
 712       for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
 713            OI != E; ++OI) {
 714         if ((isa<Constant>(*OI) && !isa<GlobalValue>(*OI)) ||
 715             isa<InlineAsm>(*OI))
 716           EnumerateValue(*OI);
 717       }
 718     BasicBlocks.push_back(BB);
 719     ValueMap[BB] = BasicBlocks.size();
 720   }
 721
 722   // Optimize the constant layout.
 723   OptimizeConstants(FirstFuncConstantID, Values.size());
 724
 725   // Add the function's parameter attributes so they are available for use in
 726   // the function's instruction.
 727   EnumerateAttributes(F.getAttributes());
 728
 729   FirstInstID = Values.size();
 730
 731   SmallVector<MDNode *, 8> FnLocalMDVector;
 732   // Add all of the instructions.
 733   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 734     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
 735       for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
 736            OI != E; ++OI) {
 737         if (MDNode *MD = dyn_cast<MDNode>(*OI))
 738           if (MD->isFunctionLocal() && MD->getFunction())
 739             // Enumerate metadata after the instructions they might refer to.
 740             FnLocalMDVector.push_back(MD);
 741       }
 742
 743       SmallVector<std::pair<unsigned, MDNode*>, 8> MDs;
 744       I->getAllMetadataOtherThanDebugLoc(MDs);
 745       for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
 746         MDNode *N = MDs[i].second;
 747         if (N->isFunctionLocal() && N->getFunction())
 748           FnLocalMDVector.push_back(N);
 749       }
 750
 751       if (!I->getType()->isVoidTy())
 752         EnumerateValue(I);
 753     }
 754   }
 755
 756   // Add all of the function-local metadata.
 757   for (unsigned i = 0, e = FnLocalMDVector.size(); i != e; ++i)
 758     EnumerateFunctionLocalMetadata(FnLocalMDVector[i]);
 759 }
 760
 761 void ValueEnumerator::purgeFunction() {
 762   /// Remove purged values from the ValueMap.
 763   for (unsigned i = NumModuleValues, e = Values.size(); i != e; ++i)
 764     ValueMap.erase(Values[i].first);
 765   for (unsigned i = NumModuleMDValues, e = MDValues.size(); i != e; ++i)
 766     MDValueMap.erase(MDValues[i].first);
 767   for (unsigned i = 0, e = BasicBlocks.size(); i != e; ++i)
 768     ValueMap.erase(BasicBlocks[i]);
 769
 770   Values.resize(NumModuleValues);
 771   MDValues.resize(NumModuleMDValues);
 772   BasicBlocks.clear();
 773   FunctionLocalMDs.clear();
 774 }
 775
 776 static void IncorporateFunctionInfoGlobalBBIDs(const Function *F,
 777                                  DenseMap<const BasicBlock*, unsigned> &IDMap) {
 778   unsigned Counter = 0;
 779   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 780     IDMap[BB] = ++Counter;
 781 }
 782
 783 /// getGlobalBasicBlockID - This returns the function-specific ID for the
 784 /// specified basic block.  This is relatively expensive information, so it
 785 /// should only be used by rare constructs such as address-of-label.
 786 unsigned ValueEnumerator::getGlobalBasicBlockID(const BasicBlock *BB) const {
 787   unsigned &Idx = GlobalBasicBlockIDs[BB];
 788   if (Idx != 0)
 789     return Idx-1;
 790
 791   IncorporateFunctionInfoGlobalBBIDs(BB->getParent(), GlobalBasicBlockIDs);
 792   return getGlobalBasicBlockID(BB);
 793 }
 794