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
24namespace llvm {
25
26class Type;
27class Value;
28class Instruction;
29class BasicBlock;
30class Comdat;
31class Function;
32class Module;
33class Metadata;
34class LocalAsMetadata;
35class MDNode;
36class NamedMDNode;
37class AttributeSet;
38class ValueSymbolTable;
39class MDSymbolTable;
40class raw_ostream;
41
42class ValueEnumerator {
43public:
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
51private:
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 HasDILocation;
69  bool HasGenericDINode;
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;
105public:
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;
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  }
119  unsigned getMetadataOrNullID(const Metadata *MD) const {
120    return MDValueMap.lookup(MD);
121  }
122  unsigned numMDs() const { return MDs.size(); }
123
124  bool hasMDString() const { return HasMDString; }
125  bool hasDILocation() const { return HasDILocation; }
126  bool hasGenericDINode() const { return HasGenericDINode; }
127
128  bool shouldPreserveUseListOrder() const { return ShouldPreserveUseListOrder; }
129
130  unsigned getTypeID(Type *T) const {
131    TypeMapType::const_iterator I = TypeMap.find(T);
132    assert(I != TypeMap.end() && "Type not in ValueEnumerator!");
133    return I->second-1;
134  }
135
136  unsigned getInstructionID(const Instruction *I) const;
137  void setInstructionID(const Instruction *I);
138
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!");
143    return I->second;
144  }
145
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!");
150    return I->second;
151  }
152
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;
157    End = FirstInstID;
158  }
159
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;
164  }
165  const TypeList &getTypes() const { return Types; }
166  const std::vector<const BasicBlock*> &getBasicBlocks() const {
167    return BasicBlocks;
168  }
169  const std::vector<AttributeSet> &getAttributes() const {
170    return Attribute;
171  }
172  const std::vector<AttributeSet> &getAttributeGroups() const {
173    return AttributeGroups;
174  }
175
176  const ComdatSetType &getComdats() const { return Comdats; }
177  unsigned getComdatID(const Comdat *C) const;
178
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;
183
184  /// incorporateFunction/purgeFunction - If you'd like to deal with a function,
185  /// use these two methods to get its data into the ValueEnumerator!
186  ///
187  void incorporateFunction(const Function &F);
188  void purgeFunction();
189  uint64_t computeBitsRequiredForTypeIndicies() const;
190
191private:
192  void OptimizeConstants(unsigned CstStart, unsigned CstEnd);
193
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);
202
203  void EnumerateValueSymbolTable(const ValueSymbolTable &ST);
204  void EnumerateNamedMetadata(const Module &M);
205};
206
207} // End llvm namespace
208
209#endif
210