1 //===-- ValueEnumerator.cpp - Number values and types for bitcode writer --===//
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 file implements the ValueEnumerator class.
12 //===----------------------------------------------------------------------===//
14 #include "ValueEnumerator.h"
15 #include "llvm/Constants.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Metadata.h"
18 #include "llvm/Module.h"
19 #include "llvm/TypeSymbolTable.h"
20 #include "llvm/ValueSymbolTable.h"
21 #include "llvm/Instructions.h"
25 static bool isSingleValueType(const std::pair<const llvm::Type*,
27 return P.first->isSingleValueType();
30 static bool isIntegerValue(const std::pair<const Value*, unsigned> &V) {
31 return isa<IntegerType>(V.first->getType());
34 static bool CompareByFrequency(const std::pair<const llvm::Type*,
36 const std::pair<const llvm::Type*,
38 return P1.second > P2.second;
41 /// ValueEnumerator - Enumerate module-level information.
42 ValueEnumerator::ValueEnumerator(const Module *M) {
45 // Enumerate the global variables.
46 for (Module::const_global_iterator I = M->global_begin(),
47 E = M->global_end(); I != E; ++I)
50 // Enumerate the functions.
51 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I) {
53 EnumerateAttributes(cast<Function>(I)->getAttributes());
56 // Enumerate the aliases.
57 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
61 // Remember what is the cutoff between globalvalue's and other constants.
62 unsigned FirstConstant = Values.size();
64 // Enumerate the global variable initializers.
65 for (Module::const_global_iterator I = M->global_begin(),
66 E = M->global_end(); I != E; ++I)
67 if (I->hasInitializer())
68 EnumerateValue(I->getInitializer());
70 // Enumerate the aliasees.
71 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
73 EnumerateValue(I->getAliasee());
75 // Enumerate types used by the type symbol table.
76 EnumerateTypeSymbolTable(M->getTypeSymbolTable());
78 // Insert constants that are named at module level into the slot pool so that
79 // the module symbol table can refer to them...
80 EnumerateValueSymbolTable(M->getValueSymbolTable());
82 // Enumerate types used by function bodies and argument lists.
83 for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
85 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
87 EnumerateType(I->getType());
89 MetadataContext &TheMetadata = F->getContext().getMetadata();
90 for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
91 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E;++I){
92 for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
94 EnumerateOperandType(*OI);
95 EnumerateType(I->getType());
96 if (const CallInst *CI = dyn_cast<CallInst>(I))
97 EnumerateAttributes(CI->getAttributes());
98 else if (const InvokeInst *II = dyn_cast<InvokeInst>(I))
99 EnumerateAttributes(II->getAttributes());
101 // Enumerate metadata attached with this instruction.
102 const MetadataContext::MDMapTy *MDs = TheMetadata.getMDs(I);
104 for (MetadataContext::MDMapTy::const_iterator MI = MDs->begin(),
105 ME = MDs->end(); MI != ME; ++MI)
106 if (MDNode *MDN = dyn_cast_or_null<MDNode>(MI->second))
107 EnumerateMetadata(MDN);
111 // Optimize constant ordering.
112 OptimizeConstants(FirstConstant, Values.size());
114 // Sort the type table by frequency so that most commonly used types are early
115 // in the table (have low bit-width).
116 std::stable_sort(Types.begin(), Types.end(), CompareByFrequency);
118 // Partition the Type ID's so that the single-value types occur before the
119 // aggregate types. This allows the aggregate types to be dropped from the
120 // type table after parsing the global variable initializers.
121 std::partition(Types.begin(), Types.end(), isSingleValueType);
123 // Now that we rearranged the type table, rebuild TypeMap.
124 for (unsigned i = 0, e = Types.size(); i != e; ++i)
125 TypeMap[Types[i].first] = i+1;
128 unsigned ValueEnumerator::getInstructionID(const Instruction *Inst) const {
129 InstructionMapType::const_iterator I = InstructionMap.find(Inst);
130 assert (I != InstructionMap.end() && "Instruction is not mapped!");
134 void ValueEnumerator::setInstructionID(const Instruction *I) {
135 InstructionMap[I] = InstructionCount++;
138 unsigned ValueEnumerator::getValueID(const Value *V) const {
139 if (isa<MetadataBase>(V)) {
140 ValueMapType::const_iterator I = MDValueMap.find(V);
141 assert(I != MDValueMap.end() && "Value not in slotcalculator!");
145 ValueMapType::const_iterator I = ValueMap.find(V);
146 assert(I != ValueMap.end() && "Value not in slotcalculator!");
150 // Optimize constant ordering.
152 struct CstSortPredicate {
154 explicit CstSortPredicate(ValueEnumerator &ve) : VE(ve) {}
155 bool operator()(const std::pair<const Value*, unsigned> &LHS,
156 const std::pair<const Value*, unsigned> &RHS) {
158 if (LHS.first->getType() != RHS.first->getType())
159 return VE.getTypeID(LHS.first->getType()) <
160 VE.getTypeID(RHS.first->getType());
161 // Then by frequency.
162 return LHS.second > RHS.second;
167 /// OptimizeConstants - Reorder constant pool for denser encoding.
168 void ValueEnumerator::OptimizeConstants(unsigned CstStart, unsigned CstEnd) {
169 if (CstStart == CstEnd || CstStart+1 == CstEnd) return;
171 CstSortPredicate P(*this);
172 std::stable_sort(Values.begin()+CstStart, Values.begin()+CstEnd, P);
174 // Ensure that integer constants are at the start of the constant pool. This
175 // is important so that GEP structure indices come before gep constant exprs.
176 std::partition(Values.begin()+CstStart, Values.begin()+CstEnd,
179 // Rebuild the modified portion of ValueMap.
180 for (; CstStart != CstEnd; ++CstStart)
181 ValueMap[Values[CstStart].first] = CstStart+1;
185 /// EnumerateTypeSymbolTable - Insert all of the types in the specified symbol
187 void ValueEnumerator::EnumerateTypeSymbolTable(const TypeSymbolTable &TST) {
188 for (TypeSymbolTable::const_iterator TI = TST.begin(), TE = TST.end();
190 EnumerateType(TI->second);
193 /// EnumerateValueSymbolTable - Insert all of the values in the specified symbol
194 /// table into the values table.
195 void ValueEnumerator::EnumerateValueSymbolTable(const ValueSymbolTable &VST) {
196 for (ValueSymbolTable::const_iterator VI = VST.begin(), VE = VST.end();
198 EnumerateValue(VI->getValue());
201 void ValueEnumerator::EnumerateMetadata(const MetadataBase *MD) {
202 // Check to see if it's already in!
203 unsigned &MDValueID = MDValueMap[MD];
205 // Increment use count.
206 MDValues[MDValueID-1].second++;
210 // Enumerate the type of this value.
211 EnumerateType(MD->getType());
213 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
214 MDValues.push_back(std::make_pair(MD, 1U));
215 MDValueMap[MD] = MDValues.size();
216 MDValueID = MDValues.size();
217 for (unsigned i = 0, e = N->getNumElements(); i != e; ++i) {
218 if (Value *V = N->getElement(i))
221 EnumerateType(Type::getVoidTy(MD->getContext()));
224 } else if (const NamedMDNode *N = dyn_cast<NamedMDNode>(MD)) {
225 for(NamedMDNode::const_elem_iterator I = N->elem_begin(),
226 E = N->elem_end(); I != E; ++I) {
227 MetadataBase *M = *I;
230 MDValues.push_back(std::make_pair(MD, 1U));
231 MDValueMap[MD] = Values.size();
236 MDValues.push_back(std::make_pair(MD, 1U));
237 MDValueID = MDValues.size();
240 void ValueEnumerator::EnumerateValue(const Value *V) {
241 assert(V->getType() != Type::getVoidTy(V->getContext()) &&
242 "Can't insert void values!");
243 if (const MetadataBase *MB = dyn_cast<MetadataBase>(V))
244 return EnumerateMetadata(MB);
246 // Check to see if it's already in!
247 unsigned &ValueID = ValueMap[V];
249 // Increment use count.
250 Values[ValueID-1].second++;
254 // Enumerate the type of this value.
255 EnumerateType(V->getType());
257 if (const Constant *C = dyn_cast<Constant>(V)) {
258 if (isa<GlobalValue>(C)) {
259 // Initializers for globals are handled explicitly elsewhere.
260 } else if (isa<ConstantArray>(C) && cast<ConstantArray>(C)->isString()) {
261 // Do not enumerate the initializers for an array of simple characters.
262 // The initializers just polute the value table, and we emit the strings
264 } else if (C->getNumOperands()) {
265 // If a constant has operands, enumerate them. This makes sure that if a
266 // constant has uses (for example an array of const ints), that they are
269 // We prefer to enumerate them with values before we enumerate the user
270 // itself. This makes it more likely that we can avoid forward references
271 // in the reader. We know that there can be no cycles in the constants
272 // graph that don't go through a global variable.
273 for (User::const_op_iterator I = C->op_begin(), E = C->op_end();
277 // Finally, add the value. Doing this could make the ValueID reference be
278 // dangling, don't reuse it.
279 Values.push_back(std::make_pair(V, 1U));
280 ValueMap[V] = Values.size();
286 Values.push_back(std::make_pair(V, 1U));
287 ValueID = Values.size();
291 void ValueEnumerator::EnumerateType(const Type *Ty) {
292 unsigned &TypeID = TypeMap[Ty];
295 // If we've already seen this type, just increase its occurrence count.
296 Types[TypeID-1].second++;
300 // First time we saw this type, add it.
301 Types.push_back(std::make_pair(Ty, 1U));
302 TypeID = Types.size();
304 // Enumerate subtypes.
305 for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
310 // Enumerate the types for the specified value. If the value is a constant,
311 // walk through it, enumerating the types of the constant.
312 void ValueEnumerator::EnumerateOperandType(const Value *V) {
313 EnumerateType(V->getType());
314 if (const Constant *C = dyn_cast<Constant>(V)) {
315 // If this constant is already enumerated, ignore it, we know its type must
317 if (ValueMap.count(V)) return;
319 // This constant may have operands, make sure to enumerate the types in
321 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
322 EnumerateOperandType(C->getOperand(i));
324 if (const MDNode *N = dyn_cast<MDNode>(V)) {
325 for (unsigned i = 0, e = N->getNumElements(); i != e; ++i) {
326 Value *Elem = N->getElement(i);
328 EnumerateOperandType(Elem);
331 } else if (isa<MDString>(V) || isa<MDNode>(V))
335 void ValueEnumerator::EnumerateAttributes(const AttrListPtr &PAL) {
336 if (PAL.isEmpty()) return; // null is always 0.
338 unsigned &Entry = AttributeMap[PAL.getRawPointer()];
340 // Never saw this before, add it.
341 Attributes.push_back(PAL);
342 Entry = Attributes.size();
347 void ValueEnumerator::incorporateFunction(const Function &F) {
348 NumModuleValues = Values.size();
350 // Adding function arguments to the value table.
351 for(Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end();
355 FirstFuncConstantID = Values.size();
357 // Add all function-level constants to the value table.
358 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
359 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I)
360 for (User::const_op_iterator OI = I->op_begin(), E = I->op_end();
362 if ((isa<Constant>(*OI) && !isa<GlobalValue>(*OI)) ||
366 BasicBlocks.push_back(BB);
367 ValueMap[BB] = BasicBlocks.size();
370 // Optimize the constant layout.
371 OptimizeConstants(FirstFuncConstantID, Values.size());
373 // Add the function's parameter attributes so they are available for use in
374 // the function's instruction.
375 EnumerateAttributes(F.getAttributes());
377 FirstInstID = Values.size();
379 // Add all of the instructions.
380 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
381 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
382 if (I->getType() != Type::getVoidTy(F.getContext()))
388 void ValueEnumerator::purgeFunction() {
389 /// Remove purged values from the ValueMap.
390 for (unsigned i = NumModuleValues, e = Values.size(); i != e; ++i)
391 ValueMap.erase(Values[i].first);
392 for (unsigned i = 0, e = BasicBlocks.size(); i != e; ++i)
393 ValueMap.erase(BasicBlocks[i]);
395 Values.resize(NumModuleValues);