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/Constants.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Metadata.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/TypeSymbolTable.h"
  20 #include "llvm/ValueSymbolTable.h"
  21 #include "llvm/Instructions.h"
  22 #include <algorithm>
  23 using namespace llvm;
  24
  25 static bool isSingleValueType(const std::pair<const llvm::Type*,
  26                               unsigned int> &P) {
  27   return P.first->isSingleValueType();
  28 }
  29
  30 static bool isIntegerValue(const std::pair<const Value*, unsigned> &V) {
  31   return isa<IntegerType>(V.first->getType());
  32 }
  33
  34 static bool CompareByFrequency(const std::pair<const llvm::Type*,
  35                                unsigned int> &P1,
  36                                const std::pair<const llvm::Type*,
  37                                unsigned int> &P2) {
  38   return P1.second > P2.second;
  39 }
  40
  41 /// ValueEnumerator - Enumerate module-level information.
  42 ValueEnumerator::ValueEnumerator(const Module *M) {
  43   InstructionCount = 0;
  44
  45   // Enumerate the global variables.
  46   for (Module::const_global_iterator I = M->global_begin(),
  47          E = M->global_end(); I != E; ++I)
  48     EnumerateValue(I);
  49
  50   // Enumerate the functions.
  51   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I) {
  52     EnumerateValue(I);
  53     EnumerateAttributes(cast<Function>(I)->getAttributes());
  54   }
  55
  56   // Enumerate the aliases.
  57   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
  58        I != E; ++I)
  59     EnumerateValue(I);
  60
  61   // Remember what is the cutoff between globalvalue's and other constants.
  62   unsigned FirstConstant = Values.size();
  63
  64   // Enumerate the global variable initializers.
  65   for (Module::const_global_iterator I = M->global_begin(),
  66          E = M->global_end(); I != E; ++I)
  67     if (I->hasInitializer())
  68       EnumerateValue(I->getInitializer());
  69
  70   // Enumerate the aliasees.
  71   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
  72        I != E; ++I)
  73     EnumerateValue(I->getAliasee());
  74
  75   // Enumerate types used by the type symbol table.
  76   EnumerateTypeSymbolTable(M->getTypeSymbolTable());
  77
  78   // Insert constants that are named at module level into the slot pool so that
  79   // the module symbol table can refer to them...
  80   EnumerateValueSymbolTable(M->getValueSymbolTable());
  81
  82   // Enumerate types used by function bodies and argument lists.
  83   for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
  84
  85     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
  86          I != E; ++I)
  87       EnumerateType(I->getType());
  88
  89     MetadataContext &TheMetadata = F->getContext().getMetadata();
  90     typedef SmallVector<std::pair<unsigned, TrackingVH<MDNode> >, 2> MDMapTy;
  91     MDMapTy MDs;
  92     for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
  93       for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E;++I){
  94         for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
  95              OI != E; ++OI)
  96           EnumerateOperandType(*OI);
  97         EnumerateType(I->getType());
  98         if (const CallInst *CI = dyn_cast<CallInst>(I))
  99           EnumerateAttributes(CI->getAttributes());
 100         else if (const InvokeInst *II = dyn_cast<InvokeInst>(I))
 101           EnumerateAttributes(II->getAttributes());
 102
 103         // Enumerate metadata attached with this instruction.
 104         MDs.clear();
 105         TheMetadata.getMDs(I, MDs);
 106         for (MDMapTy::const_iterator MI = MDs.begin(), ME = MDs.end(); MI != ME;
 107              ++MI)
 108           EnumerateMetadata(MI->second);
 109       }
 110   }
 111
 112   // Optimize constant ordering.
 113   OptimizeConstants(FirstConstant, Values.size());
 114
 115   // Sort the type table by frequency so that most commonly used types are early
 116   // in the table (have low bit-width).
 117   std::stable_sort(Types.begin(), Types.end(), CompareByFrequency);
 118
 119   // Partition the Type ID's so that the single-value types occur before the
 120   // aggregate types.  This allows the aggregate types to be dropped from the
 121   // type table after parsing the global variable initializers.
 122   std::partition(Types.begin(), Types.end(), isSingleValueType);
 123
 124   // Now that we rearranged the type table, rebuild TypeMap.
 125   for (unsigned i = 0, e = Types.size(); i != e; ++i)
 126     TypeMap[Types[i].first] = i+1;
 127 }
 128
 129 unsigned ValueEnumerator::getInstructionID(const Instruction *Inst) const {
 130   InstructionMapType::const_iterator I = InstructionMap.find(Inst);
 131   assert (I != InstructionMap.end() && "Instruction is not mapped!");
 132     return I->second;
 133 }
 134
 135 void ValueEnumerator::setInstructionID(const Instruction *I) {
 136   InstructionMap[I] = InstructionCount++;
 137 }
 138
 139 unsigned ValueEnumerator::getValueID(const Value *V) const {
 140   if (isa<MetadataBase>(V)) {
 141     ValueMapType::const_iterator I = MDValueMap.find(V);
 142     assert(I != MDValueMap.end() && "Value not in slotcalculator!");
 143     return I->second-1;
 144   }
 145
 146   ValueMapType::const_iterator I = ValueMap.find(V);
 147   assert(I != ValueMap.end() && "Value not in slotcalculator!");
 148   return I->second-1;
 149 }
 150
 151 // Optimize constant ordering.
 152 namespace {
 153   struct CstSortPredicate {
 154     ValueEnumerator &VE;
 155     explicit CstSortPredicate(ValueEnumerator &ve) : VE(ve) {}
 156     bool operator()(const std::pair<const Value*, unsigned> &LHS,
 157                     const std::pair<const Value*, unsigned> &RHS) {
 158       // Sort by plane.
 159       if (LHS.first->getType() != RHS.first->getType())
 160         return VE.getTypeID(LHS.first->getType()) <
 161                VE.getTypeID(RHS.first->getType());
 162       // Then by frequency.
 163       return LHS.second > RHS.second;
 164     }
 165   };
 166 }
 167
 168 /// OptimizeConstants - Reorder constant pool for denser encoding.
 169 void ValueEnumerator::OptimizeConstants(unsigned CstStart, unsigned CstEnd) {
 170   if (CstStart == CstEnd || CstStart+1 == CstEnd) return;
 171
 172   CstSortPredicate P(*this);
 173   std::stable_sort(Values.begin()+CstStart, Values.begin()+CstEnd, P);
 174
 175   // Ensure that integer constants are at the start of the constant pool.  This
 176   // is important so that GEP structure indices come before gep constant exprs.
 177   std::partition(Values.begin()+CstStart, Values.begin()+CstEnd,
 178                  isIntegerValue);
 179
 180   // Rebuild the modified portion of ValueMap.
 181   for (; CstStart != CstEnd; ++CstStart)
 182     ValueMap[Values[CstStart].first] = CstStart+1;
 183 }
 184
 185
 186 /// EnumerateTypeSymbolTable - Insert all of the types in the specified symbol
 187 /// table.
 188 void ValueEnumerator::EnumerateTypeSymbolTable(const TypeSymbolTable &TST) {
 189   for (TypeSymbolTable::const_iterator TI = TST.begin(), TE = TST.end();
 190        TI != TE; ++TI)
 191     EnumerateType(TI->second);
 192 }
 193
 194 /// EnumerateValueSymbolTable - Insert all of the values in the specified symbol
 195 /// table into the values table.
 196 void ValueEnumerator::EnumerateValueSymbolTable(const ValueSymbolTable &VST) {
 197   for (ValueSymbolTable::const_iterator VI = VST.begin(), VE = VST.end();
 198        VI != VE; ++VI)
 199     EnumerateValue(VI->getValue());
 200 }
 201
 202 void ValueEnumerator::EnumerateMetadata(const MetadataBase *MD) {
 203   // Check to see if it's already in!
 204   unsigned &MDValueID = MDValueMap[MD];
 205   if (MDValueID) {
 206     // Increment use count.
 207     MDValues[MDValueID-1].second++;
 208     return;
 209   }
 210
 211   // Enumerate the type of this value.
 212   EnumerateType(MD->getType());
 213
 214   if (const MDNode *N = dyn_cast<MDNode>(MD)) {
 215     MDValues.push_back(std::make_pair(MD, 1U));
 216     MDValueMap[MD] = MDValues.size();
 217     MDValueID = MDValues.size();
 218     for (unsigned i = 0, e = N->getNumElements(); i != e; ++i) {
 219       if (Value *V = N->getElement(i))
 220         EnumerateValue(V);
 221       else
 222         EnumerateType(Type::getVoidTy(MD->getContext()));
 223     }
 224     return;
 225   } else if (const NamedMDNode *N = dyn_cast<NamedMDNode>(MD)) {
 226     for(NamedMDNode::const_elem_iterator I = N->elem_begin(),
 227           E = N->elem_end(); I != E; ++I) {
 228       MetadataBase *M = *I;
 229       EnumerateValue(M);
 230     }
 231     MDValues.push_back(std::make_pair(MD, 1U));
 232     MDValueMap[MD] = Values.size();
 233     return;
 234   }
 235
 236   // Add the value.
 237   MDValues.push_back(std::make_pair(MD, 1U));
 238   MDValueID = MDValues.size();
 239 }
 240
 241 void ValueEnumerator::EnumerateValue(const Value *V) {
 242   assert(V->getType() != Type::getVoidTy(V->getContext()) &&
 243          "Can't insert void values!");
 244   if (const MetadataBase *MB = dyn_cast<MetadataBase>(V))
 245     return EnumerateMetadata(MB);
 246
 247   // Check to see if it's already in!
 248   unsigned &ValueID = ValueMap[V];
 249   if (ValueID) {
 250     // Increment use count.
 251     Values[ValueID-1].second++;
 252     return;
 253   }
 254
 255   // Enumerate the type of this value.
 256   EnumerateType(V->getType());
 257
 258   if (const Constant *C = dyn_cast<Constant>(V)) {
 259     if (isa<GlobalValue>(C)) {
 260       // Initializers for globals are handled explicitly elsewhere.
 261     } else if (isa<ConstantArray>(C) && cast<ConstantArray>(C)->isString()) {
 262       // Do not enumerate the initializers for an array of simple characters.
 263       // The initializers just polute the value table, and we emit the strings
 264       // specially.
 265     } else if (C->getNumOperands()) {
 266       // If a constant has operands, enumerate them.  This makes sure that if a
 267       // constant has uses (for example an array of const ints), that they are
 268       // inserted also.
 269
 270       // We prefer to enumerate them with values before we enumerate the user
 271       // itself.  This makes it more likely that we can avoid forward references
 272       // in the reader.  We know that there can be no cycles in the constants
 273       // graph that don't go through a global variable.
 274       for (User::const_op_iterator I = C->op_begin(), E = C->op_end();
 275            I != E; ++I)
 276         EnumerateValue(*I);
 277
 278       // Finally, add the value.  Doing this could make the ValueID reference be
 279       // dangling, don't reuse it.
 280       Values.push_back(std::make_pair(V, 1U));
 281       ValueMap[V] = Values.size();
 282       return;
 283     }
 284   }
 285
 286   // Add the value.
 287   Values.push_back(std::make_pair(V, 1U));
 288   ValueID = Values.size();
 289 }
 290
 291
 292 void ValueEnumerator::EnumerateType(const Type *Ty) {
 293   unsigned &TypeID = TypeMap[Ty];
 294
 295   if (TypeID) {
 296     // If we've already seen this type, just increase its occurrence count.
 297     Types[TypeID-1].second++;
 298     return;
 299   }
 300
 301   // First time we saw this type, add it.
 302   Types.push_back(std::make_pair(Ty, 1U));
 303   TypeID = Types.size();
 304
 305   // Enumerate subtypes.
 306   for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 307        I != E; ++I)
 308     EnumerateType(*I);
 309 }
 310
 311 // Enumerate the types for the specified value.  If the value is a constant,
 312 // walk through it, enumerating the types of the constant.
 313 void ValueEnumerator::EnumerateOperandType(const Value *V) {
 314   EnumerateType(V->getType());
 315   if (const Constant *C = dyn_cast<Constant>(V)) {
 316     // If this constant is already enumerated, ignore it, we know its type must
 317     // be enumerated.
 318     if (ValueMap.count(V)) return;
 319
 320     // This constant may have operands, make sure to enumerate the types in
 321     // them.
 322     for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
 323       EnumerateOperandType(C->getOperand(i));
 324
 325     if (const MDNode *N = dyn_cast<MDNode>(V)) {
 326       for (unsigned i = 0, e = N->getNumElements(); i != e; ++i) {
 327         Value *Elem = N->getElement(i);
 328         if (Elem)
 329           EnumerateOperandType(Elem);
 330       }
 331     }
 332   } else if (isa<MDString>(V) || isa<MDNode>(V))
 333     EnumerateValue(V);
 334 }
 335
 336 void ValueEnumerator::EnumerateAttributes(const AttrListPtr &PAL) {
 337   if (PAL.isEmpty()) return;  // null is always 0.
 338   // Do a lookup.
 339   unsigned &Entry = AttributeMap[PAL.getRawPointer()];
 340   if (Entry == 0) {
 341     // Never saw this before, add it.
 342     Attributes.push_back(PAL);
 343     Entry = Attributes.size();
 344   }
 345 }
 346
 347
 348 void ValueEnumerator::incorporateFunction(const Function &F) {
 349   NumModuleValues = Values.size();
 350
 351   // Adding function arguments to the value table.
 352   for(Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end();
 353       I != E; ++I)
 354     EnumerateValue(I);
 355
 356   FirstFuncConstantID = Values.size();
 357
 358   // Add all function-level constants to the value table.
 359   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 360     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I)
 361       for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
 362            OI != E; ++OI) {
 363         if ((isa<Constant>(*OI) && !isa<GlobalValue>(*OI)) ||
 364             isa<InlineAsm>(*OI))
 365           EnumerateValue(*OI);
 366       }
 367     BasicBlocks.push_back(BB);
 368     ValueMap[BB] = BasicBlocks.size();
 369   }
 370
 371   // Optimize the constant layout.
 372   OptimizeConstants(FirstFuncConstantID, Values.size());
 373
 374   // Add the function's parameter attributes so they are available for use in
 375   // the function's instruction.
 376   EnumerateAttributes(F.getAttributes());
 377
 378   FirstInstID = Values.size();
 379
 380   // Add all of the instructions.
 381   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 382     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
 383       if (I->getType() != Type::getVoidTy(F.getContext()))
 384         EnumerateValue(I);
 385     }
 386   }
 387 }
 388
 389 void ValueEnumerator::purgeFunction() {
 390   /// Remove purged values from the ValueMap.
 391   for (unsigned i = NumModuleValues, e = Values.size(); i != e; ++i)
 392     ValueMap.erase(Values[i].first);
 393   for (unsigned i = 0, e = BasicBlocks.size(); i != e; ++i)
 394     ValueMap.erase(BasicBlocks[i]);
 395
 396   Values.resize(NumModuleValues);
 397   BasicBlocks.clear();
 398 }