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