lib/Bitcode/Writer/ValueEnumerator.h

   1 //===-- Bitcode/Writer/ValueEnumerator.h - Number values --------*- C++ -*-===//
   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 class gives values and types Unique ID's.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_LIB_BITCODE_WRITER_VALUEENUMERATOR_H
  15 #define LLVM_LIB_BITCODE_WRITER_VALUEENUMERATOR_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/UniqueVector.h"
  20 #include "llvm/IR/Attributes.h"
  21 #include "llvm/IR/UseListOrder.h"
  22 #include <vector>
  23
  24 namespace llvm {
  25
  26 class Type;
  27 class Value;
  28 class Instruction;
  29 class BasicBlock;
  30 class Comdat;
  31 class Function;
  32 class Module;
  33 class Metadata;
  34 class LocalAsMetadata;
  35 class MDNode;
  36 class NamedMDNode;
  37 class AttributeSet;
  38 class ValueSymbolTable;
  39 class MDSymbolTable;
  40 class raw_ostream;
  41
  42 class ValueEnumerator {
  43 public:
  44   typedef std::vector<Type*> TypeList;
  45
  46   // For each value, we remember its Value* and occurrence frequency.
  47   typedef std::vector<std::pair<const Value*, unsigned> > ValueList;
  48
  49   UseListOrderStack UseListOrders;
  50
  51 private:
  52   typedef DenseMap<Type*, unsigned> TypeMapType;
  53   TypeMapType TypeMap;
  54   TypeList Types;
  55
  56   typedef DenseMap<const Value*, unsigned> ValueMapType;
  57   ValueMapType ValueMap;
  58   ValueList Values;
  59
  60   typedef UniqueVector<const Comdat *> ComdatSetType;
  61   ComdatSetType Comdats;
  62
  63   std::vector<const Metadata *> MDs;
  64   SmallVector<const LocalAsMetadata *, 8> FunctionLocalMDs;
  65   typedef DenseMap<const Metadata *, unsigned> MetadataMapType;
  66   MetadataMapType MDValueMap;
  67   bool HasMDString;
  68
  69   typedef DenseMap<AttributeSet, unsigned> AttributeGroupMapType;
  70   AttributeGroupMapType AttributeGroupMap;
  71   std::vector<AttributeSet> AttributeGroups;
  72
  73   typedef DenseMap<AttributeSet, unsigned> AttributeMapType;
  74   AttributeMapType AttributeMap;
  75   std::vector<AttributeSet> Attribute;
  76
  77   /// GlobalBasicBlockIDs - This map memoizes the basic block ID's referenced by
  78   /// the "getGlobalBasicBlockID" method.
  79   mutable DenseMap<const BasicBlock*, unsigned> GlobalBasicBlockIDs;
  80
  81   typedef DenseMap<const Instruction*, unsigned> InstructionMapType;
  82   InstructionMapType InstructionMap;
  83   unsigned InstructionCount;
  84
  85   /// BasicBlocks - This contains all the basic blocks for the currently
  86   /// incorporated function.  Their reverse mapping is stored in ValueMap.
  87   std::vector<const BasicBlock*> BasicBlocks;
  88
  89   /// When a function is incorporated, this is the size of the Values list
  90   /// before incorporation.
  91   unsigned NumModuleValues;
  92
  93   /// When a function is incorporated, this is the size of the MDValues list
  94   /// before incorporation.
  95   unsigned NumModuleMDs;
  96
  97   unsigned FirstFuncConstantID;
  98   unsigned FirstInstID;
  99
 100   ValueEnumerator(const ValueEnumerator &) LLVM_DELETED_FUNCTION;
 101   void operator=(const ValueEnumerator &) LLVM_DELETED_FUNCTION;
 102 public:
 103   ValueEnumerator(const Module &M);
 104
 105   void dump() const;
 106   void print(raw_ostream &OS, const ValueMapType &Map, const char *Name) const;
 107   void print(raw_ostream &OS, const MetadataMapType &Map,
 108              const char *Name) const;
 109
 110   unsigned getValueID(const Value *V) const;
 111   unsigned getMetadataID(const Metadata *V) const;
 112
 113   bool hasMDString() const { return HasMDString; }
 114
 115   unsigned getTypeID(Type *T) const {
 116     TypeMapType::const_iterator I = TypeMap.find(T);
 117     assert(I != TypeMap.end() && "Type not in ValueEnumerator!");
 118     return I->second-1;
 119   }
 120
 121   unsigned getInstructionID(const Instruction *I) const;
 122   void setInstructionID(const Instruction *I);
 123
 124   unsigned getAttributeID(AttributeSet PAL) const {
 125     if (PAL.isEmpty()) return 0;  // Null maps to zero.
 126     AttributeMapType::const_iterator I = AttributeMap.find(PAL);
 127     assert(I != AttributeMap.end() && "Attribute not in ValueEnumerator!");
 128     return I->second;
 129   }
 130
 131   unsigned getAttributeGroupID(AttributeSet PAL) const {
 132     if (PAL.isEmpty()) return 0;  // Null maps to zero.
 133     AttributeGroupMapType::const_iterator I = AttributeGroupMap.find(PAL);
 134     assert(I != AttributeGroupMap.end() && "Attribute not in ValueEnumerator!");
 135     return I->second;
 136   }
 137
 138   /// getFunctionConstantRange - Return the range of values that corresponds to
 139   /// function-local constants.
 140   void getFunctionConstantRange(unsigned &Start, unsigned &End) const {
 141     Start = FirstFuncConstantID;
 142     End = FirstInstID;
 143   }
 144
 145   const ValueList &getValues() const { return Values; }
 146   const std::vector<const Metadata *> &getMDs() const { return MDs; }
 147   const SmallVectorImpl<const LocalAsMetadata *> &getFunctionLocalMDs() const {
 148     return FunctionLocalMDs;
 149   }
 150   const TypeList &getTypes() const { return Types; }
 151   const std::vector<const BasicBlock*> &getBasicBlocks() const {
 152     return BasicBlocks;
 153   }
 154   const std::vector<AttributeSet> &getAttributes() const {
 155     return Attribute;
 156   }
 157   const std::vector<AttributeSet> &getAttributeGroups() const {
 158     return AttributeGroups;
 159   }
 160
 161   const ComdatSetType &getComdats() const { return Comdats; }
 162   unsigned getComdatID(const Comdat *C) const;
 163
 164   /// getGlobalBasicBlockID - This returns the function-specific ID for the
 165   /// specified basic block.  This is relatively expensive information, so it
 166   /// should only be used by rare constructs such as address-of-label.
 167   unsigned getGlobalBasicBlockID(const BasicBlock *BB) const;
 168
 169   /// incorporateFunction/purgeFunction - If you'd like to deal with a function,
 170   /// use these two methods to get its data into the ValueEnumerator!
 171   ///
 172   void incorporateFunction(const Function &F);
 173   void purgeFunction();
 174
 175 private:
 176   void OptimizeConstants(unsigned CstStart, unsigned CstEnd);
 177
 178   void EnumerateMDNodeOperands(const MDNode *N);
 179   void EnumerateMetadata(const Metadata *MD);
 180   void EnumerateFunctionLocalMetadata(const LocalAsMetadata *Local);
 181   void EnumerateNamedMDNode(const NamedMDNode *NMD);
 182   void EnumerateValue(const Value *V);
 183   void EnumerateType(Type *T);
 184   void EnumerateOperandType(const Value *V);
 185   void EnumerateAttributes(AttributeSet PAL);
 186
 187   void EnumerateValueSymbolTable(const ValueSymbolTable &ST);
 188   void EnumerateNamedMetadata(const Module &M);
 189 };
 190
 191 } // End llvm namespace
 192
 193 #endif