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/ValueSymbolTable.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 #include <algorithm>
  25 using namespace llvm;
  26
  27 static bool isIntOrIntVectorValue(const std::pair<const Value*, unsigned> &V) {
  28   return V.first->getType()->isIntOrIntVectorTy();
  29 }
  30
  31 /// ValueEnumerator - Enumerate module-level information.
  32 ValueEnumerator::ValueEnumerator(const Module *M) {
  33   // Enumerate the global variables.
  34   for (Module::const_global_iterator I = M->global_begin(),
  35          E = M->global_end(); I != E; ++I)
  36     EnumerateValue(I);
  37
  38   // Enumerate the functions.
  39   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I) {
  40     EnumerateValue(I);
  41     EnumerateAttributes(cast<Function>(I)->getAttributes());
  42   }
  43
  44   // Enumerate the aliases.
  45   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
  46        I != E; ++I)
  47     EnumerateValue(I);
  48
  49   // Remember what is the cutoff between globalvalue's and other constants.
  50   unsigned FirstConstant = Values.size();
  51
  52   // Enumerate the global variable initializers.
  53   for (Module::const_global_iterator I = M->global_begin(),
  54          E = M->global_end(); I != E; ++I)
  55     if (I->hasInitializer())
  56       EnumerateValue(I->getInitializer());
  57
  58   // Enumerate the aliasees.
  59   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
  60        I != E; ++I)
  61     EnumerateValue(I->getAliasee());
  62
  63   // Enumerate the prefix data constants.
  64   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
  65     if (I->hasPrefixData())
  66       EnumerateValue(I->getPrefixData());
  67
  68   // Insert constants and metadata that are named at module level into the slot
  69   // pool so that the module symbol table can refer to them...
  70   EnumerateValueSymbolTable(M->getValueSymbolTable());
  71   EnumerateNamedMetadata(M);
  72
  73   SmallVector<std::pair<unsigned, MDNode*>, 8> MDs;
  74
  75   // Enumerate types used by function bodies and argument lists.
  76   for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
  77
  78     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
  79          I != E; ++I)
  80       EnumerateType(I->getType());
  81
  82     for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
  83       for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E;++I){
  84         for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
  85              OI != E; ++OI) {
  86           if (MDNode *MD = dyn_cast<MDNode>(*OI))
  87             if (MD->isFunctionLocal() && MD->getFunction())
  88               // These will get enumerated during function-incorporation.
  89               continue;
  90           EnumerateOperandType(*OI);
  91         }
  92         EnumerateType(I->getType());
  93         if (const CallInst *CI = dyn_cast<CallInst>(I))
  94           EnumerateAttributes(CI->getAttributes());
  95         else if (const InvokeInst *II = dyn_cast<InvokeInst>(I))
  96           EnumerateAttributes(II->getAttributes());
  97
  98         // Enumerate metadata attached with this instruction.
  99         MDs.clear();
 100         I->getAllMetadataOtherThanDebugLoc(MDs);
 101         for (unsigned i = 0, e = MDs.size(); i != e; ++i)
 102           EnumerateMetadata(MDs[i].second);
 103
 104         if (!I->getDebugLoc().isUnknown()) {
 105           MDNode *Scope, *IA;
 106           I->getDebugLoc().getScopeAndInlinedAt(Scope, IA, I->getContext());
 107           if (Scope) EnumerateMetadata(Scope);
 108           if (IA) EnumerateMetadata(IA);
 109         }
 110       }
 111   }
 112
 113   // Optimize constant ordering.
 114   OptimizeConstants(FirstConstant, Values.size());
 115 }
 116
 117 unsigned ValueEnumerator::getInstructionID(const Instruction *Inst) const {
 118   InstructionMapType::const_iterator I = InstructionMap.find(Inst);
 119   assert(I != InstructionMap.end() && "Instruction is not mapped!");
 120   return I->second;
 121 }
 122
 123 void ValueEnumerator::setInstructionID(const Instruction *I) {
 124   InstructionMap[I] = InstructionCount++;
 125 }
 126
 127 unsigned ValueEnumerator::getValueID(const Value *V) const {
 128   if (isa<MDNode>(V) || isa<MDString>(V)) {
 129     ValueMapType::const_iterator I = MDValueMap.find(V);
 130     assert(I != MDValueMap.end() && "Value not in slotcalculator!");
 131     return I->second-1;
 132   }
 133
 134   ValueMapType::const_iterator I = ValueMap.find(V);
 135   assert(I != ValueMap.end() && "Value not in slotcalculator!");
 136   return I->second-1;
 137 }
 138
 139 void ValueEnumerator::dump() const {
 140   print(dbgs(), ValueMap, "Default");
 141   dbgs() << '\n';
 142   print(dbgs(), MDValueMap, "MetaData");
 143   dbgs() << '\n';
 144 }
 145
 146 void ValueEnumerator::print(raw_ostream &OS, const ValueMapType &Map,
 147                             const char *Name) const {
 148
 149   OS << "Map Name: " << Name << "\n";
 150   OS << "Size: " << Map.size() << "\n";
 151   for (ValueMapType::const_iterator I = Map.begin(),
 152          E = Map.end(); I != E; ++I) {
 153
 154     const Value *V = I->first;
 155     if (V->hasName())
 156       OS << "Value: " << V->getName();
 157     else
 158       OS << "Value: [null]\n";
 159     V->dump();
 160
 161     OS << " Uses(" << std::distance(V->use_begin(),V->use_end()) << "):";
 162     for (Value::const_use_iterator UI = V->use_begin(), UE = V->use_end();
 163          UI != UE; ++UI) {
 164       if (UI != V->use_begin())
 165         OS << ",";
 166       if((*UI)->hasName())
 167         OS << " " << (*UI)->getName();
 168       else
 169         OS << " [null]";
 170
 171     }
 172     OS <<  "\n\n";
 173   }
 174 }
 175
 176 /// OptimizeConstants - Reorder constant pool for denser encoding.
 177 void ValueEnumerator::OptimizeConstants(unsigned CstStart, unsigned CstEnd) {
 178   if (CstStart == CstEnd || CstStart+1 == CstEnd) return;
 179
 180   std::stable_sort(Values.begin() + CstStart, Values.begin() + CstEnd,
 181                    [this](const std::pair<const Value *, unsigned> &LHS,
 182                           const std::pair<const Value *, unsigned> &RHS) {
 183     // Sort by plane.
 184     if (LHS.first->getType() != RHS.first->getType())
 185       return getTypeID(LHS.first->getType()) < getTypeID(RHS.first->getType());
 186     // Then by frequency.
 187     return LHS.second > RHS.second;
 188   });
 189
 190   // Ensure that integer and vector of integer constants are at the start of the
 191   // constant pool.  This is important so that GEP structure indices come before
 192   // gep constant exprs.
 193   std::partition(Values.begin()+CstStart, Values.begin()+CstEnd,
 194                  isIntOrIntVectorValue);
 195
 196   // Rebuild the modified portion of ValueMap.
 197   for (; CstStart != CstEnd; ++CstStart)
 198     ValueMap[Values[CstStart].first] = CstStart+1;
 199 }
 200
 201
 202 /// EnumerateValueSymbolTable - Insert all of the values in the specified symbol
 203 /// table into the values table.
 204 void ValueEnumerator::EnumerateValueSymbolTable(const ValueSymbolTable &VST) {
 205   for (ValueSymbolTable::const_iterator VI = VST.begin(), VE = VST.end();
 206        VI != VE; ++VI)
 207     EnumerateValue(VI->getValue());
 208 }
 209
 210 /// EnumerateNamedMetadata - Insert all of the values referenced by
 211 /// named metadata in the specified module.
 212 void ValueEnumerator::EnumerateNamedMetadata(const Module *M) {
 213   for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
 214        E = M->named_metadata_end(); I != E; ++I)
 215     EnumerateNamedMDNode(I);
 216 }
 217
 218 void ValueEnumerator::EnumerateNamedMDNode(const NamedMDNode *MD) {
 219   for (unsigned i = 0, e = MD->getNumOperands(); i != e; ++i)
 220     EnumerateMetadata(MD->getOperand(i));
 221 }
 222
 223 /// EnumerateMDNodeOperands - Enumerate all non-function-local values
 224 /// and types referenced by the given MDNode.
 225 void ValueEnumerator::EnumerateMDNodeOperands(const MDNode *N) {
 226   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 227     if (Value *V = N->getOperand(i)) {
 228       if (isa<MDNode>(V) || isa<MDString>(V))
 229         EnumerateMetadata(V);
 230       else if (!isa<Instruction>(V) && !isa<Argument>(V))
 231         EnumerateValue(V);
 232     } else
 233       EnumerateType(Type::getVoidTy(N->getContext()));
 234   }
 235 }
 236
 237 void ValueEnumerator::EnumerateMetadata(const Value *MD) {
 238   assert((isa<MDNode>(MD) || isa<MDString>(MD)) && "Invalid metadata kind");
 239
 240   // Enumerate the type of this value.
 241   EnumerateType(MD->getType());
 242
 243   const MDNode *N = dyn_cast<MDNode>(MD);
 244
 245   // In the module-level pass, skip function-local nodes themselves, but
 246   // do walk their operands.
 247   if (N && N->isFunctionLocal() && N->getFunction()) {
 248     EnumerateMDNodeOperands(N);
 249     return;
 250   }
 251
 252   // Check to see if it's already in!
 253   unsigned &MDValueID = MDValueMap[MD];
 254   if (MDValueID) {
 255     // Increment use count.
 256     MDValues[MDValueID-1].second++;
 257     return;
 258   }
 259   MDValues.push_back(std::make_pair(MD, 1U));
 260   MDValueID = MDValues.size();
 261
 262   // Enumerate all non-function-local operands.
 263   if (N)
 264     EnumerateMDNodeOperands(N);
 265 }
 266
 267 /// EnumerateFunctionLocalMetadataa - Incorporate function-local metadata
 268 /// information reachable from the given MDNode.
 269 void ValueEnumerator::EnumerateFunctionLocalMetadata(const MDNode *N) {
 270   assert(N->isFunctionLocal() && N->getFunction() &&
 271          "EnumerateFunctionLocalMetadata called on non-function-local mdnode!");
 272
 273   // Enumerate the type of this value.
 274   EnumerateType(N->getType());
 275
 276   // Check to see if it's already in!
 277   unsigned &MDValueID = MDValueMap[N];
 278   if (MDValueID) {
 279     // Increment use count.
 280     MDValues[MDValueID-1].second++;
 281     return;
 282   }
 283   MDValues.push_back(std::make_pair(N, 1U));
 284   MDValueID = MDValues.size();
 285
 286   // To incoroporate function-local information visit all function-local
 287   // MDNodes and all function-local values they reference.
 288   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 289     if (Value *V = N->getOperand(i)) {
 290       if (MDNode *O = dyn_cast<MDNode>(V)) {
 291         if (O->isFunctionLocal() && O->getFunction())
 292           EnumerateFunctionLocalMetadata(O);
 293       } else if (isa<Instruction>(V) || isa<Argument>(V))
 294         EnumerateValue(V);
 295     }
 296
 297   // Also, collect all function-local MDNodes for easy access.
 298   FunctionLocalMDs.push_back(N);
 299 }
 300
 301 void ValueEnumerator::EnumerateValue(const Value *V) {
 302   assert(!V->getType()->isVoidTy() && "Can't insert void values!");
 303   assert(!isa<MDNode>(V) && !isa<MDString>(V) &&
 304          "EnumerateValue doesn't handle Metadata!");
 305
 306   // Check to see if it's already in!
 307   unsigned &ValueID = ValueMap[V];
 308   if (ValueID) {
 309     // Increment use count.
 310     Values[ValueID-1].second++;
 311     return;
 312   }
 313
 314   // Enumerate the type of this value.
 315   EnumerateType(V->getType());
 316
 317   if (const Constant *C = dyn_cast<Constant>(V)) {
 318     if (isa<GlobalValue>(C)) {
 319       // Initializers for globals are handled explicitly elsewhere.
 320     } else if (C->getNumOperands()) {
 321       // If a constant has operands, enumerate them.  This makes sure that if a
 322       // constant has uses (for example an array of const ints), that they are
 323       // inserted also.
 324
 325       // We prefer to enumerate them with values before we enumerate the user
 326       // itself.  This makes it more likely that we can avoid forward references
 327       // in the reader.  We know that there can be no cycles in the constants
 328       // graph that don't go through a global variable.
 329       for (User::const_op_iterator I = C->op_begin(), E = C->op_end();
 330            I != E; ++I)
 331         if (!isa<BasicBlock>(*I)) // Don't enumerate BB operand to BlockAddress.
 332           EnumerateValue(*I);
 333
 334       // Finally, add the value.  Doing this could make the ValueID reference be
 335       // dangling, don't reuse it.
 336       Values.push_back(std::make_pair(V, 1U));
 337       ValueMap[V] = Values.size();
 338       return;
 339     }
 340   }
 341
 342   // Add the value.
 343   Values.push_back(std::make_pair(V, 1U));
 344   ValueID = Values.size();
 345 }
 346
 347
 348 void ValueEnumerator::EnumerateType(Type *Ty) {
 349   unsigned *TypeID = &TypeMap[Ty];
 350
 351   // We've already seen this type.
 352   if (*TypeID)
 353     return;
 354
 355   // If it is a non-anonymous struct, mark the type as being visited so that we
 356   // don't recursively visit it.  This is safe because we allow forward
 357   // references of these in the bitcode reader.
 358   if (StructType *STy = dyn_cast<StructType>(Ty))
 359     if (!STy->isLiteral())
 360       *TypeID = ~0U;
 361
 362   // Enumerate all of the subtypes before we enumerate this type.  This ensures
 363   // that the type will be enumerated in an order that can be directly built.
 364   for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 365        I != E; ++I)
 366     EnumerateType(*I);
 367
 368   // Refresh the TypeID pointer in case the table rehashed.
 369   TypeID = &TypeMap[Ty];
 370
 371   // Check to see if we got the pointer another way.  This can happen when
 372   // enumerating recursive types that hit the base case deeper than they start.
 373   //
 374   // If this is actually a struct that we are treating as forward ref'able,
 375   // then emit the definition now that all of its contents are available.
 376   if (*TypeID && *TypeID != ~0U)
 377     return;
 378
 379   // Add this type now that its contents are all happily enumerated.
 380   Types.push_back(Ty);
 381
 382   *TypeID = Types.size();
 383 }
 384
 385 // Enumerate the types for the specified value.  If the value is a constant,
 386 // walk through it, enumerating the types of the constant.
 387 void ValueEnumerator::EnumerateOperandType(const Value *V) {
 388   EnumerateType(V->getType());
 389
 390   if (const Constant *C = dyn_cast<Constant>(V)) {
 391     // If this constant is already enumerated, ignore it, we know its type must
 392     // be enumerated.
 393     if (ValueMap.count(V)) return;
 394
 395     // This constant may have operands, make sure to enumerate the types in
 396     // them.
 397     for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
 398       const Value *Op = C->getOperand(i);
 399
 400       // Don't enumerate basic blocks here, this happens as operands to
 401       // blockaddress.
 402       if (isa<BasicBlock>(Op)) continue;
 403
 404       EnumerateOperandType(Op);
 405     }
 406
 407     if (const MDNode *N = dyn_cast<MDNode>(V)) {
 408       for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 409         if (Value *Elem = N->getOperand(i))
 410           EnumerateOperandType(Elem);
 411     }
 412   } else if (isa<MDString>(V) || isa<MDNode>(V))
 413     EnumerateMetadata(V);
 414 }
 415
 416 void ValueEnumerator::EnumerateAttributes(AttributeSet PAL) {
 417   if (PAL.isEmpty()) return;  // null is always 0.
 418
 419   // Do a lookup.
 420   unsigned &Entry = AttributeMap[PAL];
 421   if (Entry == 0) {
 422     // Never saw this before, add it.
 423     Attribute.push_back(PAL);
 424     Entry = Attribute.size();
 425   }
 426
 427   // Do lookups for all attribute groups.
 428   for (unsigned i = 0, e = PAL.getNumSlots(); i != e; ++i) {
 429     AttributeSet AS = PAL.getSlotAttributes(i);
 430     unsigned &Entry = AttributeGroupMap[AS];
 431     if (Entry == 0) {
 432       AttributeGroups.push_back(AS);
 433       Entry = AttributeGroups.size();
 434     }
 435   }
 436 }
 437
 438 void ValueEnumerator::incorporateFunction(const Function &F) {
 439   InstructionCount = 0;
 440   NumModuleValues = Values.size();
 441   NumModuleMDValues = MDValues.size();
 442
 443   // Adding function arguments to the value table.
 444   for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end();
 445        I != E; ++I)
 446     EnumerateValue(I);
 447
 448   FirstFuncConstantID = Values.size();
 449
 450   // Add all function-level constants to the value table.
 451   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 452     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I)
 453       for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
 454            OI != E; ++OI) {
 455         if ((isa<Constant>(*OI) && !isa<GlobalValue>(*OI)) ||
 456             isa<InlineAsm>(*OI))
 457           EnumerateValue(*OI);
 458       }
 459     BasicBlocks.push_back(BB);
 460     ValueMap[BB] = BasicBlocks.size();
 461   }
 462
 463   // Optimize the constant layout.
 464   OptimizeConstants(FirstFuncConstantID, Values.size());
 465
 466   // Add the function's parameter attributes so they are available for use in
 467   // the function's instruction.
 468   EnumerateAttributes(F.getAttributes());
 469
 470   FirstInstID = Values.size();
 471
 472   SmallVector<MDNode *, 8> FnLocalMDVector;
 473   // Add all of the instructions.
 474   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 475     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
 476       for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
 477            OI != E; ++OI) {
 478         if (MDNode *MD = dyn_cast<MDNode>(*OI))
 479           if (MD->isFunctionLocal() && MD->getFunction())
 480             // Enumerate metadata after the instructions they might refer to.
 481             FnLocalMDVector.push_back(MD);
 482       }
 483
 484       SmallVector<std::pair<unsigned, MDNode*>, 8> MDs;
 485       I->getAllMetadataOtherThanDebugLoc(MDs);
 486       for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
 487         MDNode *N = MDs[i].second;
 488         if (N->isFunctionLocal() && N->getFunction())
 489           FnLocalMDVector.push_back(N);
 490       }
 491
 492       if (!I->getType()->isVoidTy())
 493         EnumerateValue(I);
 494     }
 495   }
 496
 497   // Add all of the function-local metadata.
 498   for (unsigned i = 0, e = FnLocalMDVector.size(); i != e; ++i)
 499     EnumerateFunctionLocalMetadata(FnLocalMDVector[i]);
 500 }
 501
 502 void ValueEnumerator::purgeFunction() {
 503   /// Remove purged values from the ValueMap.
 504   for (unsigned i = NumModuleValues, e = Values.size(); i != e; ++i)
 505     ValueMap.erase(Values[i].first);
 506   for (unsigned i = NumModuleMDValues, e = MDValues.size(); i != e; ++i)
 507     MDValueMap.erase(MDValues[i].first);
 508   for (unsigned i = 0, e = BasicBlocks.size(); i != e; ++i)
 509     ValueMap.erase(BasicBlocks[i]);
 510
 511   Values.resize(NumModuleValues);
 512   MDValues.resize(NumModuleMDValues);
 513   BasicBlocks.clear();
 514   FunctionLocalMDs.clear();
 515 }
 516
 517 static void IncorporateFunctionInfoGlobalBBIDs(const Function *F,
 518                                  DenseMap<const BasicBlock*, unsigned> &IDMap) {
 519   unsigned Counter = 0;
 520   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 521     IDMap[BB] = ++Counter;
 522 }
 523
 524 /// getGlobalBasicBlockID - This returns the function-specific ID for the
 525 /// specified basic block.  This is relatively expensive information, so it
 526 /// should only be used by rare constructs such as address-of-label.
 527 unsigned ValueEnumerator::getGlobalBasicBlockID(const BasicBlock *BB) const {
 528   unsigned &Idx = GlobalBasicBlockIDs[BB];
 529   if (Idx != 0)
 530     return Idx-1;
 531
 532   IncorporateFunctionInfoGlobalBBIDs(BB->getParent(), GlobalBasicBlockIDs);
 533   return getGlobalBasicBlockID(BB);
 534 }
 535