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