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