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 and metadata  that are named at module level into the slot
  78   // pool so that the module symbol table can refer to them...
  79   EnumerateValueSymbolTable(M->getValueSymbolTable());
  80   EnumerateMDSymbolTable(M->getMDSymbolTable());
  81
  82   SmallVector<std::pair<unsigned, MDNode*>, 8> MDs;
  83
  84   // Enumerate types used by function bodies and argument lists.
  85   for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
  86
  87     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
  88          I != E; ++I)
  89       EnumerateType(I->getType());
  90
  91     for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
  92       for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E;++I){
  93         for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
  94              OI != E; ++OI)
  95           EnumerateOperandType(*OI, true);
  96         EnumerateType(I->getType());
  97         if (const CallInst *CI = dyn_cast<CallInst>(I))
  98           EnumerateAttributes(CI->getAttributes());
  99         else if (const InvokeInst *II = dyn_cast<InvokeInst>(I))
 100           EnumerateAttributes(II->getAttributes());
 101
 102         // Enumerate metadata attached with this instruction.
 103         MDs.clear();
 104         I->getAllMetadata(MDs);
 105         for (unsigned i = 0, e = MDs.size(); i != e; ++i)
 106           EnumerateMetadata(MDs[i].second, true);
 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 /// EnumerateMDSymbolTable - Insert all of the values in the specified metadata
 201 /// table.
 202 void ValueEnumerator::EnumerateMDSymbolTable(const MDSymbolTable &MST) {
 203   for (MDSymbolTable::const_iterator MI = MST.begin(), ME = MST.end();
 204        MI != ME; ++MI)
 205     EnumerateValue(MI->getValue());
 206 }
 207
 208 void ValueEnumerator::EnumerateNamedMDNode(const NamedMDNode *MD) {
 209   // Check to see if it's already in!
 210   unsigned &MDValueID = MDValueMap[MD];
 211   if (MDValueID) {
 212     // Increment use count.
 213     MDValues[MDValueID-1].second++;
 214     return;
 215   }
 216
 217   // Enumerate the type of this value.
 218   EnumerateType(MD->getType());
 219
 220   for (unsigned i = 0, e = MD->getNumOperands(); i != e; ++i)
 221     if (MDNode *E = MD->getOperand(i))
 222       EnumerateValue(E);
 223   MDValues.push_back(std::make_pair(MD, 1U));
 224   MDValueMap[MD] = Values.size();
 225 }
 226
 227 void ValueEnumerator::EnumerateMetadata(const MetadataBase *MD, bool isGlobal) {
 228   // Check to see if it's already in!
 229   unsigned &MDValueID = MDValueMap[MD];
 230   if (MDValueID) {
 231     // Increment use count.
 232     MDValues[MDValueID-1].second++;
 233     return;
 234   }
 235
 236   // Enumerate the type of this value.
 237   EnumerateType(MD->getType());
 238
 239   if (const MDNode *N = dyn_cast<MDNode>(MD)) {
 240     if ((isGlobal && !N->isFunctionLocal()) ||
 241         (!isGlobal && N->isFunctionLocal())) {
 242       MDValues.push_back(std::make_pair(MD, 1U));
 243       MDValueMap[MD] = MDValues.size();
 244       MDValueID = MDValues.size();
 245       for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 246         if (Value *V = N->getOperand(i))
 247           EnumerateValue(V);
 248         else
 249           EnumerateType(Type::getVoidTy(MD->getContext()));
 250     }
 251     return;
 252   }
 253
 254   // Add the value.
 255   assert(isa<MDString>(MD) && "Unknown metadata kind");
 256   MDValues.push_back(std::make_pair(MD, 1U));
 257   MDValueID = MDValues.size();
 258 }
 259
 260 void ValueEnumerator::EnumerateValue(const Value *V, bool isGlobal) {
 261   assert(!V->getType()->isVoidTy() && "Can't insert void values!");
 262   if (const MetadataBase *MB = dyn_cast<MetadataBase>(V))
 263     return EnumerateMetadata(MB, isGlobal);
 264   else if (const NamedMDNode *NMD = dyn_cast<NamedMDNode>(V))
 265     return EnumerateNamedMDNode(NMD);
 266
 267   // Check to see if it's already in!
 268   unsigned &ValueID = ValueMap[V];
 269   if (ValueID) {
 270     // Increment use count.
 271     Values[ValueID-1].second++;
 272     return;
 273   }
 274
 275   // Enumerate the type of this value.
 276   EnumerateType(V->getType());
 277
 278   if (const Constant *C = dyn_cast<Constant>(V)) {
 279     if (isa<GlobalValue>(C)) {
 280       // Initializers for globals are handled explicitly elsewhere.
 281     } else if (isa<ConstantArray>(C) && cast<ConstantArray>(C)->isString()) {
 282       // Do not enumerate the initializers for an array of simple characters.
 283       // The initializers just polute the value table, and we emit the strings
 284       // specially.
 285     } else if (C->getNumOperands()) {
 286       // If a constant has operands, enumerate them.  This makes sure that if a
 287       // constant has uses (for example an array of const ints), that they are
 288       // inserted also.
 289
 290       // We prefer to enumerate them with values before we enumerate the user
 291       // itself.  This makes it more likely that we can avoid forward references
 292       // in the reader.  We know that there can be no cycles in the constants
 293       // graph that don't go through a global variable.
 294       for (User::const_op_iterator I = C->op_begin(), E = C->op_end();
 295            I != E; ++I)
 296         if (!isa<BasicBlock>(*I)) // Don't enumerate BB operand to BlockAddress.
 297           EnumerateValue(*I, isGlobal);
 298
 299       // Finally, add the value.  Doing this could make the ValueID reference be
 300       // dangling, don't reuse it.
 301       Values.push_back(std::make_pair(V, 1U));
 302       ValueMap[V] = Values.size();
 303       return;
 304     }
 305   }
 306
 307   // Add the value.
 308   Values.push_back(std::make_pair(V, 1U));
 309   ValueID = Values.size();
 310 }
 311
 312
 313 void ValueEnumerator::EnumerateType(const Type *Ty) {
 314   unsigned &TypeID = TypeMap[Ty];
 315
 316   if (TypeID) {
 317     // If we've already seen this type, just increase its occurrence count.
 318     Types[TypeID-1].second++;
 319     return;
 320   }
 321
 322   // First time we saw this type, add it.
 323   Types.push_back(std::make_pair(Ty, 1U));
 324   TypeID = Types.size();
 325
 326   // Enumerate subtypes.
 327   for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
 328        I != E; ++I)
 329     EnumerateType(*I);
 330 }
 331
 332 // Enumerate the types for the specified value.  If the value is a constant,
 333 // walk through it, enumerating the types of the constant.
 334 void ValueEnumerator::EnumerateOperandType(const Value *V, bool isGlobal) {
 335   EnumerateType(V->getType());
 336
 337   // During function-incorporation, only enumerate metadata operands.
 338   if (!isGlobal)
 339     if (const MetadataBase *MB = dyn_cast<MetadataBase>(V))
 340       return EnumerateMetadata(MB, isGlobal);
 341
 342   if (const Constant *C = dyn_cast<Constant>(V)) {
 343     // If this constant is already enumerated, ignore it, we know its type must
 344     // be enumerated.
 345     if (ValueMap.count(V)) return;
 346
 347     // This constant may have operands, make sure to enumerate the types in
 348     // them.
 349     for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i) {
 350       const User *Op = C->getOperand(i);
 351
 352       // Don't enumerate basic blocks here, this happens as operands to
 353       // blockaddress.
 354       if (isa<BasicBlock>(Op)) continue;
 355
 356       EnumerateOperandType(cast<Constant>(Op), isGlobal);
 357     }
 358
 359     if (const MDNode *N = dyn_cast<MDNode>(V)) {
 360       for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 361         if (Value *Elem = N->getOperand(i))
 362           EnumerateOperandType(Elem, isGlobal);
 363     }
 364   } else if (isa<MDString>(V) || isa<MDNode>(V))
 365     EnumerateValue(V);
 366 }
 367
 368 void ValueEnumerator::EnumerateAttributes(const AttrListPtr &PAL) {
 369   if (PAL.isEmpty()) return;  // null is always 0.
 370   // Do a lookup.
 371   unsigned &Entry = AttributeMap[PAL.getRawPointer()];
 372   if (Entry == 0) {
 373     // Never saw this before, add it.
 374     Attributes.push_back(PAL);
 375     Entry = Attributes.size();
 376   }
 377 }
 378
 379
 380 void ValueEnumerator::incorporateFunction(const Function &F) {
 381   NumModuleValues = Values.size();
 382
 383   // Adding function arguments to the value table.
 384   for(Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end();
 385       I != E; ++I)
 386     EnumerateValue(I);
 387
 388   FirstFuncConstantID = Values.size();
 389
 390   // Add all function-level constants to the value table.
 391   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 392     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I)
 393       for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
 394            OI != E; ++OI) {
 395         if ((isa<Constant>(*OI) && !isa<GlobalValue>(*OI)) ||
 396             isa<InlineAsm>(*OI))
 397           EnumerateValue(*OI);
 398       }
 399     BasicBlocks.push_back(BB);
 400     ValueMap[BB] = BasicBlocks.size();
 401   }
 402
 403   // Optimize the constant layout.
 404   OptimizeConstants(FirstFuncConstantID, Values.size());
 405
 406   // Add the function's parameter attributes so they are available for use in
 407   // the function's instruction.
 408   EnumerateAttributes(F.getAttributes());
 409
 410   FirstInstID = Values.size();
 411
 412   // Add all of the instructions.
 413   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 414     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
 415       for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
 416            OI != E; ++OI) {
 417         EnumerateOperandType(*OI, false);
 418       }
 419       if (!I->getType()->isVoidTy())
 420         EnumerateValue(I);
 421     }
 422   }
 423 }
 424
 425 void ValueEnumerator::purgeFunction() {
 426   /// Remove purged values from the ValueMap.
 427   for (unsigned i = NumModuleValues, e = Values.size(); i != e; ++i)
 428     ValueMap.erase(Values[i].first);
 429   for (unsigned i = 0, e = BasicBlocks.size(); i != e; ++i)
 430     ValueMap.erase(BasicBlocks[i]);
 431
 432   Values.resize(NumModuleValues);
 433   BasicBlocks.clear();
 434 }
 435
 436 static void IncorporateFunctionInfoGlobalBBIDs(const Function *F,
 437                                  DenseMap<const BasicBlock*, unsigned> &IDMap) {
 438   unsigned Counter = 0;
 439   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 440     IDMap[BB] = ++Counter;
 441 }
 442
 443 /// getGlobalBasicBlockID - This returns the function-specific ID for the
 444 /// specified basic block.  This is relatively expensive information, so it
 445 /// should only be used by rare constructs such as address-of-label.
 446 unsigned ValueEnumerator::getGlobalBasicBlockID(const BasicBlock *BB) const {
 447   unsigned &Idx = GlobalBasicBlockIDs[BB];
 448   if (Idx != 0)
 449     return Idx-1;
 450
 451   IncorporateFunctionInfoGlobalBBIDs(BB->getParent(), GlobalBasicBlockIDs);
 452   return getGlobalBasicBlockID(BB);
 453 }
 454