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/Module.h"
16 #include "llvm/Analysis/ValueTracking.h"
17 #include "llvm/CodeGen/MachineFunctionPass.h"
18 #include "llvm/CodeGen/MachineFunction.h"
19 #include "llvm/CodeGen/Passes.h"
20 #include "llvm/Target/TargetAsmInfo.h"
21 #include "llvm/MC/MCObjectFileInfo.h"
22 #include "llvm/MC/MCSymbol.h"
23 #include "llvm/ADT/PointerUnion.h"
24 #include "llvm/Support/Dwarf.h"
25 #include "llvm/Support/ErrorHandling.h"
27 using namespace llvm::dwarf;
29 // Handle the Pass registration stuff necessary to use TargetData's.
30 INITIALIZE_PASS(MachineModuleInfo, "machinemoduleinfo",
31 "Machine Module Information", false, false)
32 char MachineModuleInfo::ID = 0;
34 // Out of line virtual method.
35 MachineModuleInfoImpl::~MachineModuleInfoImpl() {}
38 class MMIAddrLabelMapCallbackPtr : CallbackVH {
41 MMIAddrLabelMapCallbackPtr() : Map(0) {}
42 MMIAddrLabelMapCallbackPtr(Value *V) : CallbackVH(V), Map(0) {}
44 void setPtr(BasicBlock *BB) {
45 ValueHandleBase::operator=(BB);
48 void setMap(MMIAddrLabelMap *map) { Map = map; }
50 virtual void deleted();
51 virtual void allUsesReplacedWith(Value *V2);
54 class MMIAddrLabelMap {
56 struct AddrLabelSymEntry {
57 /// Symbols - The symbols for the label. This is a pointer union that is
58 /// either one symbol (the common case) or a list of symbols.
59 PointerUnion<MCSymbol *, std::vector<MCSymbol*>*> Symbols;
61 Function *Fn; // The containing function of the BasicBlock.
62 unsigned Index; // The index in BBCallbacks for the BasicBlock.
65 DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry> AddrLabelSymbols;
67 /// BBCallbacks - Callbacks for the BasicBlock's that we have entries for. We
68 /// use this so we get notified if a block is deleted or RAUWd.
69 std::vector<MMIAddrLabelMapCallbackPtr> BBCallbacks;
71 /// DeletedAddrLabelsNeedingEmission - This is a per-function list of symbols
72 /// whose corresponding BasicBlock got deleted. These symbols need to be
73 /// emitted at some point in the file, so AsmPrinter emits them after the
75 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >
76 DeletedAddrLabelsNeedingEmission;
79 MMIAddrLabelMap(MCContext &context) : Context(context) {}
81 assert(DeletedAddrLabelsNeedingEmission.empty() &&
82 "Some labels for deleted blocks never got emitted");
84 // Deallocate any of the 'list of symbols' case.
85 for (DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry>::iterator
86 I = AddrLabelSymbols.begin(), E = AddrLabelSymbols.end(); I != E; ++I)
87 if (I->second.Symbols.is<std::vector<MCSymbol*>*>())
88 delete I->second.Symbols.get<std::vector<MCSymbol*>*>();
91 MCSymbol *getAddrLabelSymbol(BasicBlock *BB);
92 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(BasicBlock *BB);
94 void takeDeletedSymbolsForFunction(Function *F,
95 std::vector<MCSymbol*> &Result);
97 void UpdateForDeletedBlock(BasicBlock *BB);
98 void UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New);
102 MCSymbol *MMIAddrLabelMap::getAddrLabelSymbol(BasicBlock *BB) {
103 assert(BB->hasAddressTaken() &&
104 "Shouldn't get label for block without address taken");
105 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
107 // If we already had an entry for this block, just return it.
108 if (!Entry.Symbols.isNull()) {
109 assert(BB->getParent() == Entry.Fn && "Parent changed");
110 if (Entry.Symbols.is<MCSymbol*>())
111 return Entry.Symbols.get<MCSymbol*>();
112 return (*Entry.Symbols.get<std::vector<MCSymbol*>*>())[0];
115 // Otherwise, this is a new entry, create a new symbol for it and add an
116 // entry to BBCallbacks so we can be notified if the BB is deleted or RAUWd.
117 BBCallbacks.push_back(BB);
118 BBCallbacks.back().setMap(this);
119 Entry.Index = BBCallbacks.size()-1;
120 Entry.Fn = BB->getParent();
121 MCSymbol *Result = Context.CreateTempSymbol();
122 Entry.Symbols = Result;
126 std::vector<MCSymbol*>
127 MMIAddrLabelMap::getAddrLabelSymbolToEmit(BasicBlock *BB) {
128 assert(BB->hasAddressTaken() &&
129 "Shouldn't get label for block without address taken");
130 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
132 std::vector<MCSymbol*> Result;
134 // If we already had an entry for this block, just return it.
135 if (Entry.Symbols.isNull())
136 Result.push_back(getAddrLabelSymbol(BB));
137 else if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>())
138 Result.push_back(Sym);
140 Result = *Entry.Symbols.get<std::vector<MCSymbol*>*>();
145 /// takeDeletedSymbolsForFunction - If we have any deleted symbols for F, return
147 void MMIAddrLabelMap::
148 takeDeletedSymbolsForFunction(Function *F, std::vector<MCSymbol*> &Result) {
149 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >::iterator I =
150 DeletedAddrLabelsNeedingEmission.find(F);
152 // If there are no entries for the function, just return.
153 if (I == DeletedAddrLabelsNeedingEmission.end()) return;
155 // Otherwise, take the list.
156 std::swap(Result, I->second);
157 DeletedAddrLabelsNeedingEmission.erase(I);
161 void MMIAddrLabelMap::UpdateForDeletedBlock(BasicBlock *BB) {
162 // If the block got deleted, there is no need for the symbol. If the symbol
163 // was already emitted, we can just forget about it, otherwise we need to
164 // queue it up for later emission when the function is output.
165 AddrLabelSymEntry Entry = AddrLabelSymbols[BB];
166 AddrLabelSymbols.erase(BB);
167 assert(!Entry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
168 BBCallbacks[Entry.Index] = 0; // Clear the callback.
170 assert((BB->getParent() == 0 || BB->getParent() == Entry.Fn) &&
171 "Block/parent mismatch");
173 // Handle both the single and the multiple symbols cases.
174 if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>()) {
175 if (Sym->isDefined())
178 // If the block is not yet defined, we need to emit it at the end of the
179 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
180 // for the containing Function. Since the block is being deleted, its
181 // parent may already be removed, we have to get the function from 'Entry'.
182 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
184 std::vector<MCSymbol*> *Syms = Entry.Symbols.get<std::vector<MCSymbol*>*>();
186 for (unsigned i = 0, e = Syms->size(); i != e; ++i) {
187 MCSymbol *Sym = (*Syms)[i];
188 if (Sym->isDefined()) continue; // Ignore already emitted labels.
190 // If the block is not yet defined, we need to emit it at the end of the
191 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
192 // for the containing Function. Since the block is being deleted, its
193 // parent may already be removed, we have to get the function from
195 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
198 // The entry is deleted, free the memory associated with the symbol list.
203 void MMIAddrLabelMap::UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New) {
204 // Get the entry for the RAUW'd block and remove it from our map.
205 AddrLabelSymEntry OldEntry = AddrLabelSymbols[Old];
206 AddrLabelSymbols.erase(Old);
207 assert(!OldEntry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
209 AddrLabelSymEntry &NewEntry = AddrLabelSymbols[New];
211 // If New is not address taken, just move our symbol over to it.
212 if (NewEntry.Symbols.isNull()) {
213 BBCallbacks[OldEntry.Index].setPtr(New); // Update the callback.
214 NewEntry = OldEntry; // Set New's entry.
218 BBCallbacks[OldEntry.Index] = 0; // Update the callback.
220 // Otherwise, we need to add the old symbol to the new block's set. If it is
221 // just a single entry, upgrade it to a symbol list.
222 if (MCSymbol *PrevSym = NewEntry.Symbols.dyn_cast<MCSymbol*>()) {
223 std::vector<MCSymbol*> *SymList = new std::vector<MCSymbol*>();
224 SymList->push_back(PrevSym);
225 NewEntry.Symbols = SymList;
228 std::vector<MCSymbol*> *SymList =
229 NewEntry.Symbols.get<std::vector<MCSymbol*>*>();
231 // If the old entry was a single symbol, add it.
232 if (MCSymbol *Sym = OldEntry.Symbols.dyn_cast<MCSymbol*>()) {
233 SymList->push_back(Sym);
237 // Otherwise, concatenate the list.
238 std::vector<MCSymbol*> *Syms =OldEntry.Symbols.get<std::vector<MCSymbol*>*>();
239 SymList->insert(SymList->end(), Syms->begin(), Syms->end());
244 void MMIAddrLabelMapCallbackPtr::deleted() {
245 Map->UpdateForDeletedBlock(cast<BasicBlock>(getValPtr()));
248 void MMIAddrLabelMapCallbackPtr::allUsesReplacedWith(Value *V2) {
249 Map->UpdateForRAUWBlock(cast<BasicBlock>(getValPtr()), cast<BasicBlock>(V2));
253 //===----------------------------------------------------------------------===//
255 MachineModuleInfo::MachineModuleInfo(const MCAsmInfo &MAI,
256 const MCRegisterInfo &MRI,
257 const MCObjectFileInfo *MOFI,
258 const TargetAsmInfo *TAI)
259 : ImmutablePass(ID), Context(MAI, MRI, MOFI, TAI),
260 ObjFileMMI(0), CompactUnwindEncoding(0), CurCallSite(0), CallsEHReturn(0),
261 CallsUnwindInit(0), DbgInfoAvailable(false),
262 CallsExternalVAFunctionWithFloatingPointArguments(false) {
263 initializeMachineModuleInfoPass(*PassRegistry::getPassRegistry());
264 // Always emit some info, by default "no personality" info.
265 Personalities.push_back(NULL);
266 AddrLabelSymbols = 0;
270 MachineModuleInfo::MachineModuleInfo()
272 Context(*(MCAsmInfo*)0, *(MCRegisterInfo*)0, (MCObjectFileInfo*)0, NULL) {
273 assert(0 && "This MachineModuleInfo constructor should never be called, MMI "
274 "should always be explicitly constructed by LLVMTargetMachine");
278 MachineModuleInfo::~MachineModuleInfo() {
281 // FIXME: Why isn't doFinalization being called??
282 //assert(AddrLabelSymbols == 0 && "doFinalization not called");
283 delete AddrLabelSymbols;
284 AddrLabelSymbols = 0;
287 /// doInitialization - Initialize the state for a new module.
289 bool MachineModuleInfo::doInitialization() {
290 assert(AddrLabelSymbols == 0 && "Improperly initialized");
294 /// doFinalization - Tear down the state after completion of a module.
296 bool MachineModuleInfo::doFinalization() {
297 delete AddrLabelSymbols;
298 AddrLabelSymbols = 0;
302 /// EndFunction - Discard function meta information.
304 void MachineModuleInfo::EndFunction() {
305 // Clean up frame info.
308 // Clean up exception info.
316 CompactUnwindEncoding = 0;
317 VariableDbgInfo.clear();
320 /// AnalyzeModule - Scan the module for global debug information.
322 void MachineModuleInfo::AnalyzeModule(const Module &M) {
323 // Insert functions in the llvm.used array (but not llvm.compiler.used) into
325 const GlobalVariable *GV = M.getGlobalVariable("llvm.used");
326 if (!GV || !GV->hasInitializer()) return;
328 // Should be an array of 'i8*'.
329 const ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
330 if (InitList == 0) return;
332 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
333 if (const Function *F =
334 dyn_cast<Function>(InitList->getOperand(i)->stripPointerCasts()))
335 UsedFunctions.insert(F);
338 //===- Address of Block Management ----------------------------------------===//
341 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
342 /// block when its address is taken. This cannot be its normal LBB label
343 /// because the block may be accessed outside its containing function.
344 MCSymbol *MachineModuleInfo::getAddrLabelSymbol(const BasicBlock *BB) {
345 // Lazily create AddrLabelSymbols.
346 if (AddrLabelSymbols == 0)
347 AddrLabelSymbols = new MMIAddrLabelMap(Context);
348 return AddrLabelSymbols->getAddrLabelSymbol(const_cast<BasicBlock*>(BB));
351 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
352 /// basic block when its address is taken. If other blocks were RAUW'd to
353 /// this one, we may have to emit them as well, return the whole set.
354 std::vector<MCSymbol*> MachineModuleInfo::
355 getAddrLabelSymbolToEmit(const BasicBlock *BB) {
356 // Lazily create AddrLabelSymbols.
357 if (AddrLabelSymbols == 0)
358 AddrLabelSymbols = new MMIAddrLabelMap(Context);
359 return AddrLabelSymbols->getAddrLabelSymbolToEmit(const_cast<BasicBlock*>(BB));
363 /// takeDeletedSymbolsForFunction - If the specified function has had any
364 /// references to address-taken blocks generated, but the block got deleted,
365 /// return the symbol now so we can emit it. This prevents emitting a
366 /// reference to a symbol that has no definition.
367 void MachineModuleInfo::
368 takeDeletedSymbolsForFunction(const Function *F,
369 std::vector<MCSymbol*> &Result) {
370 // If no blocks have had their addresses taken, we're done.
371 if (AddrLabelSymbols == 0) return;
372 return AddrLabelSymbols->
373 takeDeletedSymbolsForFunction(const_cast<Function*>(F), Result);
376 //===- EH -----------------------------------------------------------------===//
378 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
379 /// specified MachineBasicBlock.
380 LandingPadInfo &MachineModuleInfo::getOrCreateLandingPadInfo
381 (MachineBasicBlock *LandingPad) {
382 unsigned N = LandingPads.size();
383 for (unsigned i = 0; i < N; ++i) {
384 LandingPadInfo &LP = LandingPads[i];
385 if (LP.LandingPadBlock == LandingPad)
389 LandingPads.push_back(LandingPadInfo(LandingPad));
390 return LandingPads[N];
393 /// addInvoke - Provide the begin and end labels of an invoke style call and
394 /// associate it with a try landing pad block.
395 void MachineModuleInfo::addInvoke(MachineBasicBlock *LandingPad,
396 MCSymbol *BeginLabel, MCSymbol *EndLabel) {
397 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
398 LP.BeginLabels.push_back(BeginLabel);
399 LP.EndLabels.push_back(EndLabel);
402 /// addLandingPad - Provide the label of a try LandingPad block.
404 MCSymbol *MachineModuleInfo::addLandingPad(MachineBasicBlock *LandingPad) {
405 MCSymbol *LandingPadLabel = Context.CreateTempSymbol();
406 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
407 LP.LandingPadLabel = LandingPadLabel;
408 return LandingPadLabel;
411 /// addPersonality - Provide the personality function for the exception
413 void MachineModuleInfo::addPersonality(MachineBasicBlock *LandingPad,
414 const Function *Personality) {
415 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
416 LP.Personality = Personality;
418 for (unsigned i = 0; i < Personalities.size(); ++i)
419 if (Personalities[i] == Personality)
422 // If this is the first personality we're adding go
423 // ahead and add it at the beginning.
424 if (Personalities[0] == NULL)
425 Personalities[0] = Personality;
427 Personalities.push_back(Personality);
430 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
432 void MachineModuleInfo::addCatchTypeInfo(MachineBasicBlock *LandingPad,
433 std::vector<const GlobalVariable *> &TyInfo) {
434 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
435 for (unsigned N = TyInfo.size(); N; --N)
436 LP.TypeIds.push_back(getTypeIDFor(TyInfo[N - 1]));
439 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
441 void MachineModuleInfo::addFilterTypeInfo(MachineBasicBlock *LandingPad,
442 std::vector<const GlobalVariable *> &TyInfo) {
443 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
444 std::vector<unsigned> IdsInFilter(TyInfo.size());
445 for (unsigned I = 0, E = TyInfo.size(); I != E; ++I)
446 IdsInFilter[I] = getTypeIDFor(TyInfo[I]);
447 LP.TypeIds.push_back(getFilterIDFor(IdsInFilter));
450 /// addCleanup - Add a cleanup action for a landing pad.
452 void MachineModuleInfo::addCleanup(MachineBasicBlock *LandingPad) {
453 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
454 LP.TypeIds.push_back(0);
457 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
459 void MachineModuleInfo::TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap) {
460 for (unsigned i = 0; i != LandingPads.size(); ) {
461 LandingPadInfo &LandingPad = LandingPads[i];
462 if (LandingPad.LandingPadLabel &&
463 !LandingPad.LandingPadLabel->isDefined() &&
464 (!LPMap || (*LPMap)[LandingPad.LandingPadLabel] == 0))
465 LandingPad.LandingPadLabel = 0;
467 // Special case: we *should* emit LPs with null LP MBB. This indicates
469 if (!LandingPad.LandingPadLabel && LandingPad.LandingPadBlock) {
470 LandingPads.erase(LandingPads.begin() + i);
474 for (unsigned j = 0, e = LandingPads[i].BeginLabels.size(); j != e; ++j) {
475 MCSymbol *BeginLabel = LandingPad.BeginLabels[j];
476 MCSymbol *EndLabel = LandingPad.EndLabels[j];
477 if ((BeginLabel->isDefined() ||
478 (LPMap && (*LPMap)[BeginLabel] != 0)) &&
479 (EndLabel->isDefined() ||
480 (LPMap && (*LPMap)[EndLabel] != 0))) continue;
482 LandingPad.BeginLabels.erase(LandingPad.BeginLabels.begin() + j);
483 LandingPad.EndLabels.erase(LandingPad.EndLabels.begin() + j);
487 // Remove landing pads with no try-ranges.
488 if (LandingPads[i].BeginLabels.empty()) {
489 LandingPads.erase(LandingPads.begin() + i);
493 // If there is no landing pad, ensure that the list of typeids is empty.
494 // If the only typeid is a cleanup, this is the same as having no typeids.
495 if (!LandingPad.LandingPadBlock ||
496 (LandingPad.TypeIds.size() == 1 && !LandingPad.TypeIds[0]))
497 LandingPad.TypeIds.clear();
502 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
504 unsigned MachineModuleInfo::getTypeIDFor(const GlobalVariable *TI) {
505 for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
506 if (TypeInfos[i] == TI) return i + 1;
508 TypeInfos.push_back(TI);
509 return TypeInfos.size();
512 /// getFilterIDFor - Return the filter id for the specified typeinfos. This is
514 int MachineModuleInfo::getFilterIDFor(std::vector<unsigned> &TyIds) {
515 // If the new filter coincides with the tail of an existing filter, then
516 // re-use the existing filter. Folding filters more than this requires
517 // re-ordering filters and/or their elements - probably not worth it.
518 for (std::vector<unsigned>::iterator I = FilterEnds.begin(),
519 E = FilterEnds.end(); I != E; ++I) {
520 unsigned i = *I, j = TyIds.size();
523 if (FilterIds[--i] != TyIds[--j])
527 // The new filter coincides with range [i, end) of the existing filter.
533 // Add the new filter.
534 int FilterID = -(1 + FilterIds.size());
535 FilterIds.reserve(FilterIds.size() + TyIds.size() + 1);
536 for (unsigned I = 0, N = TyIds.size(); I != N; ++I)
537 FilterIds.push_back(TyIds[I]);
538 FilterEnds.push_back(FilterIds.size());
539 FilterIds.push_back(0); // terminator
543 /// getPersonality - Return the personality function for the current function.
544 const Function *MachineModuleInfo::getPersonality() const {
545 // FIXME: Until PR1414 will be fixed, we're using 1 personality function per
547 return !LandingPads.empty() ? LandingPads[0].Personality : NULL;
550 /// getPersonalityIndex - Return unique index for current personality
551 /// function. NULL/first personality function should always get zero index.
552 unsigned MachineModuleInfo::getPersonalityIndex() const {
553 const Function* Personality = NULL;
555 // Scan landing pads. If there is at least one non-NULL personality - use it.
556 for (unsigned i = 0; i != LandingPads.size(); ++i)
557 if (LandingPads[i].Personality) {
558 Personality = LandingPads[i].Personality;
562 for (unsigned i = 0; i < Personalities.size(); ++i) {
563 if (Personalities[i] == Personality)
567 // This will happen if the current personality function is
568 // in the zero index.