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 VALUE_ENUMERATOR_H
15 #define VALUE_ENUMERATOR_H
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/Attributes.h"
33 class TypeSymbolTable;
34 class ValueSymbolTable;
37 class ValueEnumerator {
39 typedef std::vector<const Type*> TypeList;
41 // For each value, we remember its Value* and occurrence frequency.
42 typedef std::vector<std::pair<const Value*, unsigned> > ValueList;
44 typedef DenseMap<const Type*, unsigned> TypeMapType;
48 typedef DenseMap<const Value*, unsigned> ValueMapType;
49 ValueMapType ValueMap;
52 SmallVector<const MDNode *, 8> FunctionLocalMDs;
53 ValueMapType MDValueMap;
55 typedef DenseMap<void*, unsigned> AttributeMapType;
56 AttributeMapType AttributeMap;
57 std::vector<AttrListPtr> Attributes;
59 /// GlobalBasicBlockIDs - This map memoizes the basic block ID's referenced by
60 /// the "getGlobalBasicBlockID" method.
61 mutable DenseMap<const BasicBlock*, unsigned> GlobalBasicBlockIDs;
63 typedef DenseMap<const Instruction*, unsigned> InstructionMapType;
64 InstructionMapType InstructionMap;
65 unsigned InstructionCount;
67 /// BasicBlocks - This contains all the basic blocks for the currently
68 /// incorporated function. Their reverse mapping is stored in ValueMap.
69 std::vector<const BasicBlock*> BasicBlocks;
71 /// When a function is incorporated, this is the size of the Values list
72 /// before incorporation.
73 unsigned NumModuleValues;
75 /// When a function is incorporated, this is the size of the MDValues list
76 /// before incorporation.
77 unsigned NumModuleMDValues;
79 unsigned FirstFuncConstantID;
82 ValueEnumerator(const ValueEnumerator &); // DO NOT IMPLEMENT
83 void operator=(const ValueEnumerator &); // DO NOT IMPLEMENT
85 ValueEnumerator(const Module *M);
87 unsigned getValueID(const Value *V) const;
89 unsigned getTypeID(const Type *T) const {
90 TypeMapType::const_iterator I = TypeMap.find(T);
91 assert(I != TypeMap.end() && "Type not in ValueEnumerator!");
95 unsigned getInstructionID(const Instruction *I) const;
96 void setInstructionID(const Instruction *I);
98 unsigned getAttributeID(const AttrListPtr &PAL) const {
99 if (PAL.isEmpty()) return 0; // Null maps to zero.
100 AttributeMapType::const_iterator I = AttributeMap.find(PAL.getRawPointer());
101 assert(I != AttributeMap.end() && "Attribute not in ValueEnumerator!");
105 /// getFunctionConstantRange - Return the range of values that corresponds to
106 /// function-local constants.
107 void getFunctionConstantRange(unsigned &Start, unsigned &End) const {
108 Start = FirstFuncConstantID;
112 const ValueList &getValues() const { return Values; }
113 const ValueList &getMDValues() const { return MDValues; }
114 const SmallVector<const MDNode *, 8> &getFunctionLocalMDValues() const {
115 return FunctionLocalMDs;
117 const TypeList &getTypes() const { return Types; }
118 const std::vector<const BasicBlock*> &getBasicBlocks() const {
121 const std::vector<AttrListPtr> &getAttributes() const {
125 /// getGlobalBasicBlockID - This returns the function-specific ID for the
126 /// specified basic block. This is relatively expensive information, so it
127 /// should only be used by rare constructs such as address-of-label.
128 unsigned getGlobalBasicBlockID(const BasicBlock *BB) const;
130 /// incorporateFunction/purgeFunction - If you'd like to deal with a function,
131 /// use these two methods to get its data into the ValueEnumerator!
133 void incorporateFunction(const Function &F);
134 void purgeFunction();
137 void OptimizeConstants(unsigned CstStart, unsigned CstEnd);
138 void OptimizeTypes();
140 void EnumerateMDNodeOperands(const MDNode *N);
141 void EnumerateMetadata(const Value *MD);
142 void EnumerateFunctionLocalMetadata(const MDNode *N);
143 void EnumerateNamedMDNode(const NamedMDNode *NMD);
144 void EnumerateValue(const Value *V);
145 void EnumerateType(const Type *T);
146 void EnumerateOperandType(const Value *V);
147 void EnumerateAttributes(const AttrListPtr &PAL);
149 void EnumerateTypeSymbolTable(const TypeSymbolTable &ST);
150 void EnumerateValueSymbolTable(const ValueSymbolTable &ST);
151 void EnumerateNamedMetadata(const Module *M);
154 } // End llvm namespace