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 bool HasMDLocation; 69 bool HasGenericDebugNode; 70 bool ShouldPreserveUseListOrder; 71 72 typedef DenseMap<AttributeSet, unsigned> AttributeGroupMapType; 73 AttributeGroupMapType AttributeGroupMap; 74 std::vector<AttributeSet> AttributeGroups; 75 76 typedef DenseMap<AttributeSet, unsigned> AttributeMapType; 77 AttributeMapType AttributeMap; 78 std::vector<AttributeSet> Attribute; 79 80 /// GlobalBasicBlockIDs - This map memoizes the basic block ID's referenced by 81 /// the "getGlobalBasicBlockID" method. 82 mutable DenseMap<const BasicBlock*, unsigned> GlobalBasicBlockIDs; 83 84 typedef DenseMap<const Instruction*, unsigned> InstructionMapType; 85 InstructionMapType InstructionMap; 86 unsigned InstructionCount; 87 88 /// BasicBlocks - This contains all the basic blocks for the currently 89 /// incorporated function. Their reverse mapping is stored in ValueMap. 90 std::vector<const BasicBlock*> BasicBlocks; 91 92 /// When a function is incorporated, this is the size of the Values list 93 /// before incorporation. 94 unsigned NumModuleValues; 95 96 /// When a function is incorporated, this is the size of the MDValues list 97 /// before incorporation. 98 unsigned NumModuleMDs; 99 100 unsigned FirstFuncConstantID; 101 unsigned FirstInstID; 102 103 ValueEnumerator(const ValueEnumerator &) = delete; 104 void operator=(const ValueEnumerator &) = delete; 105 public: 106 ValueEnumerator(const Module &M, bool ShouldPreserveUseListOrder); 107 108 void dump() const; 109 void print(raw_ostream &OS, const ValueMapType &Map, const char *Name) const; 110 void print(raw_ostream &OS, const MetadataMapType &Map, 111 const char *Name) const; 112 113 unsigned getValueID(const Value *V) const; getMetadataID(const Metadata * MD)114 unsigned getMetadataID(const Metadata *MD) const { 115 auto ID = getMetadataOrNullID(MD); 116 assert(ID != 0 && "Metadata not in slotcalculator!"); 117 return ID - 1; 118 } getMetadataOrNullID(const Metadata * MD)119 unsigned getMetadataOrNullID(const Metadata *MD) const { 120 return MDValueMap.lookup(MD); 121 } 122 hasMDString()123 bool hasMDString() const { return HasMDString; } hasMDLocation()124 bool hasMDLocation() const { return HasMDLocation; } hasGenericDebugNode()125 bool hasGenericDebugNode() const { return HasGenericDebugNode; } 126 shouldPreserveUseListOrder()127 bool shouldPreserveUseListOrder() const { return ShouldPreserveUseListOrder; } 128 getTypeID(Type * T)129 unsigned getTypeID(Type *T) const { 130 TypeMapType::const_iterator I = TypeMap.find(T); 131 assert(I != TypeMap.end() && "Type not in ValueEnumerator!"); 132 return I->second-1; 133 } 134 135 unsigned getInstructionID(const Instruction *I) const; 136 void setInstructionID(const Instruction *I); 137 getAttributeID(AttributeSet PAL)138 unsigned getAttributeID(AttributeSet PAL) const { 139 if (PAL.isEmpty()) return 0; // Null maps to zero. 140 AttributeMapType::const_iterator I = AttributeMap.find(PAL); 141 assert(I != AttributeMap.end() && "Attribute not in ValueEnumerator!"); 142 return I->second; 143 } 144 getAttributeGroupID(AttributeSet PAL)145 unsigned getAttributeGroupID(AttributeSet PAL) const { 146 if (PAL.isEmpty()) return 0; // Null maps to zero. 147 AttributeGroupMapType::const_iterator I = AttributeGroupMap.find(PAL); 148 assert(I != AttributeGroupMap.end() && "Attribute not in ValueEnumerator!"); 149 return I->second; 150 } 151 152 /// getFunctionConstantRange - Return the range of values that corresponds to 153 /// function-local constants. getFunctionConstantRange(unsigned & Start,unsigned & End)154 void getFunctionConstantRange(unsigned &Start, unsigned &End) const { 155 Start = FirstFuncConstantID; 156 End = FirstInstID; 157 } 158 getValues()159 const ValueList &getValues() const { return Values; } getMDs()160 const std::vector<const Metadata *> &getMDs() const { return MDs; } getFunctionLocalMDs()161 const SmallVectorImpl<const LocalAsMetadata *> &getFunctionLocalMDs() const { 162 return FunctionLocalMDs; 163 } getTypes()164 const TypeList &getTypes() const { return Types; } getBasicBlocks()165 const std::vector<const BasicBlock*> &getBasicBlocks() const { 166 return BasicBlocks; 167 } getAttributes()168 const std::vector<AttributeSet> &getAttributes() const { 169 return Attribute; 170 } getAttributeGroups()171 const std::vector<AttributeSet> &getAttributeGroups() const { 172 return AttributeGroups; 173 } 174 getComdats()175 const ComdatSetType &getComdats() const { return Comdats; } 176 unsigned getComdatID(const Comdat *C) const; 177 178 /// getGlobalBasicBlockID - This returns the function-specific ID for the 179 /// specified basic block. This is relatively expensive information, so it 180 /// should only be used by rare constructs such as address-of-label. 181 unsigned getGlobalBasicBlockID(const BasicBlock *BB) const; 182 183 /// incorporateFunction/purgeFunction - If you'd like to deal with a function, 184 /// use these two methods to get its data into the ValueEnumerator! 185 /// 186 void incorporateFunction(const Function &F); 187 void purgeFunction(); 188 uint64_t computeBitsRequiredForTypeIndicies() const; 189 190 private: 191 void OptimizeConstants(unsigned CstStart, unsigned CstEnd); 192 193 void EnumerateMDNodeOperands(const MDNode *N); 194 void EnumerateMetadata(const Metadata *MD); 195 void EnumerateFunctionLocalMetadata(const LocalAsMetadata *Local); 196 void EnumerateNamedMDNode(const NamedMDNode *NMD); 197 void EnumerateValue(const Value *V); 198 void EnumerateType(Type *T); 199 void EnumerateOperandType(const Value *V); 200 void EnumerateAttributes(AttributeSet PAL); 201 202 void EnumerateValueSymbolTable(const ValueSymbolTable &ST); 203 void EnumerateNamedMetadata(const Module &M); 204 }; 205 206 } // End llvm namespace 207 208 #endif 209