1 //===-- Bitcode/Writer/ValueEnumerator.h - Number values --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This class gives values and types Unique ID's.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_BITCODE_WRITER_VALUEENUMERATOR_H
15 #define LLVM_LIB_BITCODE_WRITER_VALUEENUMERATOR_H
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"
34 class LocalAsMetadata;
38 class ValueSymbolTable;
42 class ValueEnumerator {
44 typedef std::vector<Type*> TypeList;
46 // For each value, we remember its Value* and occurrence frequency.
47 typedef std::vector<std::pair<const Value*, unsigned> > ValueList;
49 UseListOrderStack UseListOrders;
52 typedef DenseMap<Type*, unsigned> TypeMapType;
56 typedef DenseMap<const Value*, unsigned> ValueMapType;
57 ValueMapType ValueMap;
60 typedef UniqueVector<const Comdat *> ComdatSetType;
61 ComdatSetType Comdats;
63 std::vector<const Metadata *> MDs;
64 SmallVector<const LocalAsMetadata *, 8> FunctionLocalMDs;
65 typedef DenseMap<const Metadata *, unsigned> MetadataMapType;
66 MetadataMapType MDValueMap;
69 bool HasGenericDINode;
70 bool ShouldPreserveUseListOrder;
72 typedef DenseMap<AttributeSet, unsigned> AttributeGroupMapType;
73 AttributeGroupMapType AttributeGroupMap;
74 std::vector<AttributeSet> AttributeGroups;
76 typedef DenseMap<AttributeSet, unsigned> AttributeMapType;
77 AttributeMapType AttributeMap;
78 std::vector<AttributeSet> Attribute;
80 /// GlobalBasicBlockIDs - This map memoizes the basic block ID's referenced by
81 /// the "getGlobalBasicBlockID" method.
82 mutable DenseMap<const BasicBlock*, unsigned> GlobalBasicBlockIDs;
84 typedef DenseMap<const Instruction*, unsigned> InstructionMapType;
85 InstructionMapType InstructionMap;
86 unsigned InstructionCount;
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;
92 /// When a function is incorporated, this is the size of the Values list
93 /// before incorporation.
94 unsigned NumModuleValues;
96 /// When a function is incorporated, this is the size of the MDValues list
97 /// before incorporation.
98 unsigned NumModuleMDs;
100 unsigned FirstFuncConstantID;
101 unsigned FirstInstID;
103 ValueEnumerator(const ValueEnumerator &) = delete;
104 void operator=(const ValueEnumerator &) = delete;
106 ValueEnumerator(const Module &M, bool ShouldPreserveUseListOrder);
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;
113 unsigned getValueID(const Value *V) const;
114 unsigned getMetadataID(const Metadata *MD) const {
115 auto ID = getMetadataOrNullID(MD);
116 assert(ID != 0 && "Metadata not in slotcalculator!");
119 unsigned getMetadataOrNullID(const Metadata *MD) const {
120 return MDValueMap.lookup(MD);
122 unsigned numMDs() const { return MDs.size(); }
124 bool hasMDString() const { return HasMDString; }
125 bool hasDILocation() const { return HasDILocation; }
126 bool hasGenericDINode() const { return HasGenericDINode; }
128 bool shouldPreserveUseListOrder() const { return ShouldPreserveUseListOrder; }
130 unsigned getTypeID(Type *T) const {
131 TypeMapType::const_iterator I = TypeMap.find(T);
132 assert(I != TypeMap.end() && "Type not in ValueEnumerator!");
136 unsigned getInstructionID(const Instruction *I) const;
137 void setInstructionID(const Instruction *I);
139 unsigned getAttributeID(AttributeSet PAL) const {
140 if (PAL.isEmpty()) return 0; // Null maps to zero.
141 AttributeMapType::const_iterator I = AttributeMap.find(PAL);
142 assert(I != AttributeMap.end() && "Attribute not in ValueEnumerator!");
146 unsigned getAttributeGroupID(AttributeSet PAL) const {
147 if (PAL.isEmpty()) return 0; // Null maps to zero.
148 AttributeGroupMapType::const_iterator I = AttributeGroupMap.find(PAL);
149 assert(I != AttributeGroupMap.end() && "Attribute not in ValueEnumerator!");
153 /// getFunctionConstantRange - Return the range of values that corresponds to
154 /// function-local constants.
155 void getFunctionConstantRange(unsigned &Start, unsigned &End) const {
156 Start = FirstFuncConstantID;
160 const ValueList &getValues() const { return Values; }
161 const std::vector<const Metadata *> &getMDs() const { return MDs; }
162 const SmallVectorImpl<const LocalAsMetadata *> &getFunctionLocalMDs() const {
163 return FunctionLocalMDs;
165 const TypeList &getTypes() const { return Types; }
166 const std::vector<const BasicBlock*> &getBasicBlocks() const {
169 const std::vector<AttributeSet> &getAttributes() const {
172 const std::vector<AttributeSet> &getAttributeGroups() const {
173 return AttributeGroups;
176 const ComdatSetType &getComdats() const { return Comdats; }
177 unsigned getComdatID(const Comdat *C) const;
179 /// getGlobalBasicBlockID - This returns the function-specific ID for the
180 /// specified basic block. This is relatively expensive information, so it
181 /// should only be used by rare constructs such as address-of-label.
182 unsigned getGlobalBasicBlockID(const BasicBlock *BB) const;
184 /// incorporateFunction/purgeFunction - If you'd like to deal with a function,
185 /// use these two methods to get its data into the ValueEnumerator!
187 void incorporateFunction(const Function &F);
188 void purgeFunction();
189 uint64_t computeBitsRequiredForTypeIndicies() const;
192 void OptimizeConstants(unsigned CstStart, unsigned CstEnd);
194 void EnumerateMDNodeOperands(const MDNode *N);
195 void EnumerateMetadata(const Metadata *MD);
196 void EnumerateFunctionLocalMetadata(const LocalAsMetadata *Local);
197 void EnumerateNamedMDNode(const NamedMDNode *NMD);
198 void EnumerateValue(const Value *V);
199 void EnumerateType(Type *T);
200 void EnumerateOperandType(const Value *V);
201 void EnumerateAttributes(AttributeSet PAL);
203 void EnumerateValueSymbolTable(const ValueSymbolTable &ST);
204 void EnumerateNamedMetadata(const Module &M);
207 } // End llvm namespace