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