1 //===-- llvm/CodeGen/MachineModuleInfo.cpp ----------------------*- 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 #include "llvm/CodeGen/MachineModuleInfo.h"
12 #include "llvm/Constants.h"
13 #include "llvm/DerivedTypes.h"
14 #include "llvm/GlobalVariable.h"
15 #include "llvm/Intrinsics.h"
16 #include "llvm/Instructions.h"
17 #include "llvm/Module.h"
18 #include "llvm/Analysis/ValueTracking.h"
19 #include "llvm/CodeGen/MachineFunctionPass.h"
20 #include "llvm/CodeGen/MachineFunction.h"
21 #include "llvm/CodeGen/Passes.h"
22 #include "llvm/Target/TargetInstrInfo.h"
23 #include "llvm/Target/TargetMachine.h"
24 #include "llvm/Target/TargetOptions.h"
25 #include "llvm/MC/MCSymbol.h"
26 #include "llvm/ADT/PointerUnion.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ErrorHandling.h"
30 using namespace llvm::dwarf;
32 // Handle the Pass registration stuff necessary to use TargetData's.
33 static RegisterPass<MachineModuleInfo>
34 X("machinemoduleinfo", "Machine Module Information");
35 char MachineModuleInfo::ID = 0;
37 // Out of line virtual method.
38 MachineModuleInfoImpl::~MachineModuleInfoImpl() {}
41 class MMIAddrLabelMapCallbackPtr : CallbackVH {
44 MMIAddrLabelMapCallbackPtr() : Map(0) {}
45 MMIAddrLabelMapCallbackPtr(Value *V) : CallbackVH(V), Map(0) {}
47 void setPtr(BasicBlock *BB) {
48 ValueHandleBase::operator=(BB);
51 void setMap(MMIAddrLabelMap *map) { Map = map; }
53 virtual void deleted();
54 virtual void allUsesReplacedWith(Value *V2);
57 class MMIAddrLabelMap {
59 struct AddrLabelSymEntry {
60 /// Symbols - The symbols for the label. This is a pointer union that is
61 /// either one symbol (the common case) or a list of symbols.
62 PointerUnion<MCSymbol *, std::vector<MCSymbol*>*> Symbols;
64 Function *Fn; // The containing function of the BasicBlock.
65 unsigned Index; // The index in BBCallbacks for the BasicBlock.
68 DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry> AddrLabelSymbols;
70 /// BBCallbacks - Callbacks for the BasicBlock's that we have entries for. We
71 /// use this so we get notified if a block is deleted or RAUWd.
72 std::vector<MMIAddrLabelMapCallbackPtr> BBCallbacks;
74 /// DeletedAddrLabelsNeedingEmission - This is a per-function list of symbols
75 /// whose corresponding BasicBlock got deleted. These symbols need to be
76 /// emitted at some point in the file, so AsmPrinter emits them after the
78 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >
79 DeletedAddrLabelsNeedingEmission;
82 MMIAddrLabelMap(MCContext &context) : Context(context) {}
84 assert(DeletedAddrLabelsNeedingEmission.empty() &&
85 "Some labels for deleted blocks never got emitted");
87 // Deallocate any of the 'list of symbols' case.
88 for (DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry>::iterator
89 I = AddrLabelSymbols.begin(), E = AddrLabelSymbols.end(); I != E; ++I)
90 if (I->second.Symbols.is<std::vector<MCSymbol*>*>())
91 delete I->second.Symbols.get<std::vector<MCSymbol*>*>();
94 MCSymbol *getAddrLabelSymbol(BasicBlock *BB);
95 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(BasicBlock *BB);
97 void takeDeletedSymbolsForFunction(Function *F,
98 std::vector<MCSymbol*> &Result);
100 void UpdateForDeletedBlock(BasicBlock *BB);
101 void UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New);
105 MCSymbol *MMIAddrLabelMap::getAddrLabelSymbol(BasicBlock *BB) {
106 assert(BB->hasAddressTaken() &&
107 "Shouldn't get label for block without address taken");
108 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
110 // If we already had an entry for this block, just return it.
111 if (!Entry.Symbols.isNull()) {
112 assert(BB->getParent() == Entry.Fn && "Parent changed");
113 if (Entry.Symbols.is<MCSymbol*>())
114 return Entry.Symbols.get<MCSymbol*>();
115 return (*Entry.Symbols.get<std::vector<MCSymbol*>*>())[0];
118 // Otherwise, this is a new entry, create a new symbol for it and add an
119 // entry to BBCallbacks so we can be notified if the BB is deleted or RAUWd.
120 BBCallbacks.push_back(BB);
121 BBCallbacks.back().setMap(this);
122 Entry.Index = BBCallbacks.size()-1;
123 Entry.Fn = BB->getParent();
124 MCSymbol *Result = Context.CreateTempSymbol();
125 Entry.Symbols = Result;
129 std::vector<MCSymbol*>
130 MMIAddrLabelMap::getAddrLabelSymbolToEmit(BasicBlock *BB) {
131 assert(BB->hasAddressTaken() &&
132 "Shouldn't get label for block without address taken");
133 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
135 std::vector<MCSymbol*> Result;
137 // If we already had an entry for this block, just return it.
138 if (Entry.Symbols.isNull())
139 Result.push_back(getAddrLabelSymbol(BB));
140 else if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>())
141 Result.push_back(Sym);
143 Result = *Entry.Symbols.get<std::vector<MCSymbol*>*>();
148 /// takeDeletedSymbolsForFunction - If we have any deleted symbols for F, return
150 void MMIAddrLabelMap::
151 takeDeletedSymbolsForFunction(Function *F, std::vector<MCSymbol*> &Result) {
152 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >::iterator I =
153 DeletedAddrLabelsNeedingEmission.find(F);
155 // If there are no entries for the function, just return.
156 if (I == DeletedAddrLabelsNeedingEmission.end()) return;
158 // Otherwise, take the list.
159 std::swap(Result, I->second);
160 DeletedAddrLabelsNeedingEmission.erase(I);
164 void MMIAddrLabelMap::UpdateForDeletedBlock(BasicBlock *BB) {
165 // If the block got deleted, there is no need for the symbol. If the symbol
166 // was already emitted, we can just forget about it, otherwise we need to
167 // queue it up for later emission when the function is output.
168 AddrLabelSymEntry Entry = AddrLabelSymbols[BB];
169 AddrLabelSymbols.erase(BB);
170 assert(!Entry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
171 BBCallbacks[Entry.Index] = 0; // Clear the callback.
173 assert((BB->getParent() == 0 || BB->getParent() == Entry.Fn) &&
174 "Block/parent mismatch");
176 // Handle both the single and the multiple symbols cases.
177 if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>()) {
178 if (Sym->isDefined())
181 // If the block is not yet defined, we need to emit it at the end of the
182 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
183 // for the containing Function. Since the block is being deleted, its
184 // parent may already be removed, we have to get the function from 'Entry'.
185 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
187 std::vector<MCSymbol*> *Syms = Entry.Symbols.get<std::vector<MCSymbol*>*>();
189 for (unsigned i = 0, e = Syms->size(); i != e; ++i) {
190 MCSymbol *Sym = (*Syms)[i];
191 if (Sym->isDefined()) continue; // Ignore already emitted labels.
193 // If the block is not yet defined, we need to emit it at the end of the
194 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
195 // for the containing Function. Since the block is being deleted, its
196 // parent may already be removed, we have to get the function from
198 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
201 // The entry is deleted, free the memory associated with the symbol list.
206 void MMIAddrLabelMap::UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New) {
207 // Get the entry for the RAUW'd block and remove it from our map.
208 AddrLabelSymEntry OldEntry = AddrLabelSymbols[Old];
209 AddrLabelSymbols.erase(Old);
210 assert(!OldEntry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
212 AddrLabelSymEntry &NewEntry = AddrLabelSymbols[New];
214 // If New is not address taken, just move our symbol over to it.
215 if (NewEntry.Symbols.isNull()) {
216 BBCallbacks[OldEntry.Index].setPtr(New); // Update the callback.
217 NewEntry = OldEntry; // Set New's entry.
221 BBCallbacks[OldEntry.Index] = 0; // Update the callback.
223 // Otherwise, we need to add the old symbol to the new block's set. If it is
224 // just a single entry, upgrade it to a symbol list.
225 if (MCSymbol *PrevSym = NewEntry.Symbols.dyn_cast<MCSymbol*>()) {
226 std::vector<MCSymbol*> *SymList = new std::vector<MCSymbol*>();
227 SymList->push_back(PrevSym);
228 NewEntry.Symbols = SymList;
231 std::vector<MCSymbol*> *SymList =
232 NewEntry.Symbols.get<std::vector<MCSymbol*>*>();
234 // If the old entry was a single symbol, add it.
235 if (MCSymbol *Sym = OldEntry.Symbols.dyn_cast<MCSymbol*>()) {
236 SymList->push_back(Sym);
240 // Otherwise, concatenate the list.
241 std::vector<MCSymbol*> *Syms =OldEntry.Symbols.get<std::vector<MCSymbol*>*>();
242 SymList->insert(SymList->end(), Syms->begin(), Syms->end());
247 void MMIAddrLabelMapCallbackPtr::deleted() {
248 Map->UpdateForDeletedBlock(cast<BasicBlock>(getValPtr()));
251 void MMIAddrLabelMapCallbackPtr::allUsesReplacedWith(Value *V2) {
252 Map->UpdateForRAUWBlock(cast<BasicBlock>(getValPtr()), cast<BasicBlock>(V2));
256 //===----------------------------------------------------------------------===//
258 MachineModuleInfo::MachineModuleInfo(const MCAsmInfo &MAI)
259 : ImmutablePass(&ID), Context(MAI),
261 CurCallSite(0), CallsEHReturn(0), CallsUnwindInit(0), DbgInfoAvailable(false){
262 // Always emit some info, by default "no personality" info.
263 Personalities.push_back(NULL);
264 AddrLabelSymbols = 0;
268 MachineModuleInfo::MachineModuleInfo()
269 : ImmutablePass(&ID), Context(*(MCAsmInfo*)0) {
270 assert(0 && "This MachineModuleInfo constructor should never be called, MMI "
271 "should always be explicitly constructed by LLVMTargetMachine");
275 MachineModuleInfo::~MachineModuleInfo() {
278 // FIXME: Why isn't doFinalization being called??
279 //assert(AddrLabelSymbols == 0 && "doFinalization not called");
280 delete AddrLabelSymbols;
281 AddrLabelSymbols = 0;
284 /// doInitialization - Initialize the state for a new module.
286 bool MachineModuleInfo::doInitialization() {
287 assert(AddrLabelSymbols == 0 && "Improperly initialized");
291 /// doFinalization - Tear down the state after completion of a module.
293 bool MachineModuleInfo::doFinalization() {
294 delete AddrLabelSymbols;
295 AddrLabelSymbols = 0;
299 /// EndFunction - Discard function meta information.
301 void MachineModuleInfo::EndFunction() {
302 // Clean up frame info.
305 // Clean up exception info.
313 VariableDbgInfo.clear();
316 /// AnalyzeModule - Scan the module for global debug information.
318 void MachineModuleInfo::AnalyzeModule(Module &M) {
319 // Insert functions in the llvm.used array (but not llvm.compiler.used) into
321 GlobalVariable *GV = M.getGlobalVariable("llvm.used");
322 if (!GV || !GV->hasInitializer()) return;
324 // Should be an array of 'i8*'.
325 ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
326 if (InitList == 0) return;
328 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
330 dyn_cast<Function>(InitList->getOperand(i)->stripPointerCasts()))
331 UsedFunctions.insert(F);
334 //===- Address of Block Management ----------------------------------------===//
337 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
338 /// block when its address is taken. This cannot be its normal LBB label
339 /// because the block may be accessed outside its containing function.
340 MCSymbol *MachineModuleInfo::getAddrLabelSymbol(const BasicBlock *BB) {
341 // Lazily create AddrLabelSymbols.
342 if (AddrLabelSymbols == 0)
343 AddrLabelSymbols = new MMIAddrLabelMap(Context);
344 return AddrLabelSymbols->getAddrLabelSymbol(const_cast<BasicBlock*>(BB));
347 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
348 /// basic block when its address is taken. If other blocks were RAUW'd to
349 /// this one, we may have to emit them as well, return the whole set.
350 std::vector<MCSymbol*> MachineModuleInfo::
351 getAddrLabelSymbolToEmit(const BasicBlock *BB) {
352 // Lazily create AddrLabelSymbols.
353 if (AddrLabelSymbols == 0)
354 AddrLabelSymbols = new MMIAddrLabelMap(Context);
355 return AddrLabelSymbols->getAddrLabelSymbolToEmit(const_cast<BasicBlock*>(BB));
359 /// takeDeletedSymbolsForFunction - If the specified function has had any
360 /// references to address-taken blocks generated, but the block got deleted,
361 /// return the symbol now so we can emit it. This prevents emitting a
362 /// reference to a symbol that has no definition.
363 void MachineModuleInfo::
364 takeDeletedSymbolsForFunction(const Function *F,
365 std::vector<MCSymbol*> &Result) {
366 // If no blocks have had their addresses taken, we're done.
367 if (AddrLabelSymbols == 0) return;
368 return AddrLabelSymbols->
369 takeDeletedSymbolsForFunction(const_cast<Function*>(F), Result);
372 //===- EH -----------------------------------------------------------------===//
374 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
375 /// specified MachineBasicBlock.
376 LandingPadInfo &MachineModuleInfo::getOrCreateLandingPadInfo
377 (MachineBasicBlock *LandingPad) {
378 unsigned N = LandingPads.size();
379 for (unsigned i = 0; i < N; ++i) {
380 LandingPadInfo &LP = LandingPads[i];
381 if (LP.LandingPadBlock == LandingPad)
385 LandingPads.push_back(LandingPadInfo(LandingPad));
386 return LandingPads[N];
389 /// addInvoke - Provide the begin and end labels of an invoke style call and
390 /// associate it with a try landing pad block.
391 void MachineModuleInfo::addInvoke(MachineBasicBlock *LandingPad,
392 MCSymbol *BeginLabel, MCSymbol *EndLabel) {
393 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
394 LP.BeginLabels.push_back(BeginLabel);
395 LP.EndLabels.push_back(EndLabel);
398 /// addLandingPad - Provide the label of a try LandingPad block.
400 MCSymbol *MachineModuleInfo::addLandingPad(MachineBasicBlock *LandingPad) {
401 MCSymbol *LandingPadLabel = Context.CreateTempSymbol();
402 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
403 LP.LandingPadLabel = LandingPadLabel;
404 return LandingPadLabel;
407 /// addPersonality - Provide the personality function for the exception
409 void MachineModuleInfo::addPersonality(MachineBasicBlock *LandingPad,
410 Function *Personality) {
411 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
412 LP.Personality = Personality;
414 for (unsigned i = 0; i < Personalities.size(); ++i)
415 if (Personalities[i] == Personality)
418 // If this is the first personality we're adding go
419 // ahead and add it at the beginning.
420 if (Personalities[0] == NULL)
421 Personalities[0] = Personality;
423 Personalities.push_back(Personality);
426 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
428 void MachineModuleInfo::addCatchTypeInfo(MachineBasicBlock *LandingPad,
429 std::vector<GlobalVariable *> &TyInfo) {
430 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
431 for (unsigned N = TyInfo.size(); N; --N)
432 LP.TypeIds.push_back(getTypeIDFor(TyInfo[N - 1]));
435 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
437 void MachineModuleInfo::addFilterTypeInfo(MachineBasicBlock *LandingPad,
438 std::vector<GlobalVariable *> &TyInfo) {
439 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
440 std::vector<unsigned> IdsInFilter(TyInfo.size());
441 for (unsigned I = 0, E = TyInfo.size(); I != E; ++I)
442 IdsInFilter[I] = getTypeIDFor(TyInfo[I]);
443 LP.TypeIds.push_back(getFilterIDFor(IdsInFilter));
446 /// addCleanup - Add a cleanup action for a landing pad.
448 void MachineModuleInfo::addCleanup(MachineBasicBlock *LandingPad) {
449 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
450 LP.TypeIds.push_back(0);
453 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
455 void MachineModuleInfo::TidyLandingPads() {
456 for (unsigned i = 0; i != LandingPads.size(); ) {
457 LandingPadInfo &LandingPad = LandingPads[i];
458 if (LandingPad.LandingPadLabel && !LandingPad.LandingPadLabel->isDefined())
459 LandingPad.LandingPadLabel = 0;
461 // Special case: we *should* emit LPs with null LP MBB. This indicates
463 if (!LandingPad.LandingPadLabel && LandingPad.LandingPadBlock) {
464 LandingPads.erase(LandingPads.begin() + i);
468 for (unsigned j = 0, e = LandingPads[i].BeginLabels.size(); j != e; ++j) {
469 MCSymbol *BeginLabel = LandingPad.BeginLabels[j];
470 MCSymbol *EndLabel = LandingPad.EndLabels[j];
471 if (BeginLabel->isDefined() && EndLabel->isDefined()) continue;
473 LandingPad.BeginLabels.erase(LandingPad.BeginLabels.begin() + j);
474 LandingPad.EndLabels.erase(LandingPad.EndLabels.begin() + j);
478 // Remove landing pads with no try-ranges.
479 if (LandingPads[i].BeginLabels.empty()) {
480 LandingPads.erase(LandingPads.begin() + i);
484 // If there is no landing pad, ensure that the list of typeids is empty.
485 // If the only typeid is a cleanup, this is the same as having no typeids.
486 if (!LandingPad.LandingPadBlock ||
487 (LandingPad.TypeIds.size() == 1 && !LandingPad.TypeIds[0]))
488 LandingPad.TypeIds.clear();
493 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
495 unsigned MachineModuleInfo::getTypeIDFor(GlobalVariable *TI) {
496 for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
497 if (TypeInfos[i] == TI) return i + 1;
499 TypeInfos.push_back(TI);
500 return TypeInfos.size();
503 /// getFilterIDFor - Return the filter id for the specified typeinfos. This is
505 int MachineModuleInfo::getFilterIDFor(std::vector<unsigned> &TyIds) {
506 // If the new filter coincides with the tail of an existing filter, then
507 // re-use the existing filter. Folding filters more than this requires
508 // re-ordering filters and/or their elements - probably not worth it.
509 for (std::vector<unsigned>::iterator I = FilterEnds.begin(),
510 E = FilterEnds.end(); I != E; ++I) {
511 unsigned i = *I, j = TyIds.size();
514 if (FilterIds[--i] != TyIds[--j])
518 // The new filter coincides with range [i, end) of the existing filter.
524 // Add the new filter.
525 int FilterID = -(1 + FilterIds.size());
526 FilterIds.reserve(FilterIds.size() + TyIds.size() + 1);
527 for (unsigned I = 0, N = TyIds.size(); I != N; ++I)
528 FilterIds.push_back(TyIds[I]);
529 FilterEnds.push_back(FilterIds.size());
530 FilterIds.push_back(0); // terminator
534 /// getPersonality - Return the personality function for the current function.
535 Function *MachineModuleInfo::getPersonality() const {
536 // FIXME: Until PR1414 will be fixed, we're using 1 personality function per
538 return !LandingPads.empty() ? LandingPads[0].Personality : NULL;
541 /// getPersonalityIndex - Return unique index for current personality
542 /// function. NULL/first personality function should always get zero index.
543 unsigned MachineModuleInfo::getPersonalityIndex() const {
544 const Function* Personality = NULL;
546 // Scan landing pads. If there is at least one non-NULL personality - use it.
547 for (unsigned i = 0; i != LandingPads.size(); ++i)
548 if (LandingPads[i].Personality) {
549 Personality = LandingPads[i].Personality;
553 for (unsigned i = 0; i < Personalities.size(); ++i) {
554 if (Personalities[i] == Personality)
558 // This will happen if the current personality function is
559 // in the zero index.