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/TargetInstrInfo.h"
21 #include "llvm/Target/TargetMachine.h"
22 #include "llvm/Target/TargetOptions.h"
23 #include "llvm/MC/MCSymbol.h"
24 #include "llvm/ADT/PointerUnion.h"
25 #include "llvm/Support/Dwarf.h"
26 #include "llvm/Support/ErrorHandling.h"
28 using namespace llvm::dwarf;
30 // Handle the Pass registration stuff necessary to use TargetData's.
31 INITIALIZE_PASS(MachineModuleInfo, "machinemoduleinfo",
32 "Machine Module Information", false, false)
33 char MachineModuleInfo::ID = 0;
35 // Out of line virtual method.
36 MachineModuleInfoImpl::~MachineModuleInfoImpl() {}
39 class MMIAddrLabelMapCallbackPtr : CallbackVH {
42 MMIAddrLabelMapCallbackPtr() : Map(0) {}
43 MMIAddrLabelMapCallbackPtr(Value *V) : CallbackVH(V), Map(0) {}
45 void setPtr(BasicBlock *BB) {
46 ValueHandleBase::operator=(BB);
49 void setMap(MMIAddrLabelMap *map) { Map = map; }
51 virtual void deleted();
52 virtual void allUsesReplacedWith(Value *V2);
55 class MMIAddrLabelMap {
57 struct AddrLabelSymEntry {
58 /// Symbols - The symbols for the label. This is a pointer union that is
59 /// either one symbol (the common case) or a list of symbols.
60 PointerUnion<MCSymbol *, std::vector<MCSymbol*>*> Symbols;
62 Function *Fn; // The containing function of the BasicBlock.
63 unsigned Index; // The index in BBCallbacks for the BasicBlock.
66 DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry> AddrLabelSymbols;
68 /// BBCallbacks - Callbacks for the BasicBlock's that we have entries for. We
69 /// use this so we get notified if a block is deleted or RAUWd.
70 std::vector<MMIAddrLabelMapCallbackPtr> BBCallbacks;
72 /// DeletedAddrLabelsNeedingEmission - This is a per-function list of symbols
73 /// whose corresponding BasicBlock got deleted. These symbols need to be
74 /// emitted at some point in the file, so AsmPrinter emits them after the
76 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >
77 DeletedAddrLabelsNeedingEmission;
80 MMIAddrLabelMap(MCContext &context) : Context(context) {}
82 assert(DeletedAddrLabelsNeedingEmission.empty() &&
83 "Some labels for deleted blocks never got emitted");
85 // Deallocate any of the 'list of symbols' case.
86 for (DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry>::iterator
87 I = AddrLabelSymbols.begin(), E = AddrLabelSymbols.end(); I != E; ++I)
88 if (I->second.Symbols.is<std::vector<MCSymbol*>*>())
89 delete I->second.Symbols.get<std::vector<MCSymbol*>*>();
92 MCSymbol *getAddrLabelSymbol(BasicBlock *BB);
93 std::vector<MCSymbol*> getAddrLabelSymbolToEmit(BasicBlock *BB);
95 void takeDeletedSymbolsForFunction(Function *F,
96 std::vector<MCSymbol*> &Result);
98 void UpdateForDeletedBlock(BasicBlock *BB);
99 void UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New);
103 MCSymbol *MMIAddrLabelMap::getAddrLabelSymbol(BasicBlock *BB) {
104 assert(BB->hasAddressTaken() &&
105 "Shouldn't get label for block without address taken");
106 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
108 // If we already had an entry for this block, just return it.
109 if (!Entry.Symbols.isNull()) {
110 assert(BB->getParent() == Entry.Fn && "Parent changed");
111 if (Entry.Symbols.is<MCSymbol*>())
112 return Entry.Symbols.get<MCSymbol*>();
113 return (*Entry.Symbols.get<std::vector<MCSymbol*>*>())[0];
116 // Otherwise, this is a new entry, create a new symbol for it and add an
117 // entry to BBCallbacks so we can be notified if the BB is deleted or RAUWd.
118 BBCallbacks.push_back(BB);
119 BBCallbacks.back().setMap(this);
120 Entry.Index = BBCallbacks.size()-1;
121 Entry.Fn = BB->getParent();
122 MCSymbol *Result = Context.CreateTempSymbol();
123 Entry.Symbols = Result;
127 std::vector<MCSymbol*>
128 MMIAddrLabelMap::getAddrLabelSymbolToEmit(BasicBlock *BB) {
129 assert(BB->hasAddressTaken() &&
130 "Shouldn't get label for block without address taken");
131 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
133 std::vector<MCSymbol*> Result;
135 // If we already had an entry for this block, just return it.
136 if (Entry.Symbols.isNull())
137 Result.push_back(getAddrLabelSymbol(BB));
138 else if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>())
139 Result.push_back(Sym);
141 Result = *Entry.Symbols.get<std::vector<MCSymbol*>*>();
146 /// takeDeletedSymbolsForFunction - If we have any deleted symbols for F, return
148 void MMIAddrLabelMap::
149 takeDeletedSymbolsForFunction(Function *F, std::vector<MCSymbol*> &Result) {
150 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >::iterator I =
151 DeletedAddrLabelsNeedingEmission.find(F);
153 // If there are no entries for the function, just return.
154 if (I == DeletedAddrLabelsNeedingEmission.end()) return;
156 // Otherwise, take the list.
157 std::swap(Result, I->second);
158 DeletedAddrLabelsNeedingEmission.erase(I);
162 void MMIAddrLabelMap::UpdateForDeletedBlock(BasicBlock *BB) {
163 // If the block got deleted, there is no need for the symbol. If the symbol
164 // was already emitted, we can just forget about it, otherwise we need to
165 // queue it up for later emission when the function is output.
166 AddrLabelSymEntry Entry = AddrLabelSymbols[BB];
167 AddrLabelSymbols.erase(BB);
168 assert(!Entry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
169 BBCallbacks[Entry.Index] = 0; // Clear the callback.
171 assert((BB->getParent() == 0 || BB->getParent() == Entry.Fn) &&
172 "Block/parent mismatch");
174 // Handle both the single and the multiple symbols cases.
175 if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>()) {
176 if (Sym->isDefined())
179 // If the block is not yet defined, we need to emit it at the end of the
180 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
181 // for the containing Function. Since the block is being deleted, its
182 // parent may already be removed, we have to get the function from 'Entry'.
183 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
185 std::vector<MCSymbol*> *Syms = Entry.Symbols.get<std::vector<MCSymbol*>*>();
187 for (unsigned i = 0, e = Syms->size(); i != e; ++i) {
188 MCSymbol *Sym = (*Syms)[i];
189 if (Sym->isDefined()) continue; // Ignore already emitted labels.
191 // If the block is not yet defined, we need to emit it at the end of the
192 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
193 // for the containing Function. Since the block is being deleted, its
194 // parent may already be removed, we have to get the function from
196 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
199 // The entry is deleted, free the memory associated with the symbol list.
204 void MMIAddrLabelMap::UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New) {
205 // Get the entry for the RAUW'd block and remove it from our map.
206 AddrLabelSymEntry OldEntry = AddrLabelSymbols[Old];
207 AddrLabelSymbols.erase(Old);
208 assert(!OldEntry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
210 AddrLabelSymEntry &NewEntry = AddrLabelSymbols[New];
212 // If New is not address taken, just move our symbol over to it.
213 if (NewEntry.Symbols.isNull()) {
214 BBCallbacks[OldEntry.Index].setPtr(New); // Update the callback.
215 NewEntry = OldEntry; // Set New's entry.
219 BBCallbacks[OldEntry.Index] = 0; // Update the callback.
221 // Otherwise, we need to add the old symbol to the new block's set. If it is
222 // just a single entry, upgrade it to a symbol list.
223 if (MCSymbol *PrevSym = NewEntry.Symbols.dyn_cast<MCSymbol*>()) {
224 std::vector<MCSymbol*> *SymList = new std::vector<MCSymbol*>();
225 SymList->push_back(PrevSym);
226 NewEntry.Symbols = SymList;
229 std::vector<MCSymbol*> *SymList =
230 NewEntry.Symbols.get<std::vector<MCSymbol*>*>();
232 // If the old entry was a single symbol, add it.
233 if (MCSymbol *Sym = OldEntry.Symbols.dyn_cast<MCSymbol*>()) {
234 SymList->push_back(Sym);
238 // Otherwise, concatenate the list.
239 std::vector<MCSymbol*> *Syms =OldEntry.Symbols.get<std::vector<MCSymbol*>*>();
240 SymList->insert(SymList->end(), Syms->begin(), Syms->end());
245 void MMIAddrLabelMapCallbackPtr::deleted() {
246 Map->UpdateForDeletedBlock(cast<BasicBlock>(getValPtr()));
249 void MMIAddrLabelMapCallbackPtr::allUsesReplacedWith(Value *V2) {
250 Map->UpdateForRAUWBlock(cast<BasicBlock>(getValPtr()), cast<BasicBlock>(V2));
254 //===----------------------------------------------------------------------===//
256 MachineModuleInfo::MachineModuleInfo(const MCAsmInfo &MAI)
257 : ImmutablePass(ID), Context(MAI),
259 CurCallSite(0), CallsEHReturn(0), CallsUnwindInit(0), DbgInfoAvailable(false),
260 CallsExternalFunctionWithFloatingPointArguments(false) {
261 // Always emit some info, by default "no personality" info.
262 Personalities.push_back(NULL);
263 AddrLabelSymbols = 0;
267 MachineModuleInfo::MachineModuleInfo()
268 : ImmutablePass(ID), Context(*(MCAsmInfo*)0) {
269 assert(0 && "This MachineModuleInfo constructor should never be called, MMI "
270 "should always be explicitly constructed by LLVMTargetMachine");
274 MachineModuleInfo::~MachineModuleInfo() {
277 // FIXME: Why isn't doFinalization being called??
278 //assert(AddrLabelSymbols == 0 && "doFinalization not called");
279 delete AddrLabelSymbols;
280 AddrLabelSymbols = 0;
283 /// doInitialization - Initialize the state for a new module.
285 bool MachineModuleInfo::doInitialization() {
286 assert(AddrLabelSymbols == 0 && "Improperly initialized");
290 /// doFinalization - Tear down the state after completion of a module.
292 bool MachineModuleInfo::doFinalization() {
293 delete AddrLabelSymbols;
294 AddrLabelSymbols = 0;
298 /// EndFunction - Discard function meta information.
300 void MachineModuleInfo::EndFunction() {
301 // Clean up frame info.
304 // Clean up exception info.
312 VariableDbgInfo.clear();
315 /// AnalyzeModule - Scan the module for global debug information.
317 void MachineModuleInfo::AnalyzeModule(const Module &M) {
318 // Insert functions in the llvm.used array (but not llvm.compiler.used) into
320 const GlobalVariable *GV = M.getGlobalVariable("llvm.used");
321 if (!GV || !GV->hasInitializer()) return;
323 // Should be an array of 'i8*'.
324 const ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
325 if (InitList == 0) return;
327 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
328 if (const Function *F =
329 dyn_cast<Function>(InitList->getOperand(i)->stripPointerCasts()))
330 UsedFunctions.insert(F);
333 //===- Address of Block Management ----------------------------------------===//
336 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
337 /// block when its address is taken. This cannot be its normal LBB label
338 /// because the block may be accessed outside its containing function.
339 MCSymbol *MachineModuleInfo::getAddrLabelSymbol(const BasicBlock *BB) {
340 // Lazily create AddrLabelSymbols.
341 if (AddrLabelSymbols == 0)
342 AddrLabelSymbols = new MMIAddrLabelMap(Context);
343 return AddrLabelSymbols->getAddrLabelSymbol(const_cast<BasicBlock*>(BB));
346 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
347 /// basic block when its address is taken. If other blocks were RAUW'd to
348 /// this one, we may have to emit them as well, return the whole set.
349 std::vector<MCSymbol*> MachineModuleInfo::
350 getAddrLabelSymbolToEmit(const BasicBlock *BB) {
351 // Lazily create AddrLabelSymbols.
352 if (AddrLabelSymbols == 0)
353 AddrLabelSymbols = new MMIAddrLabelMap(Context);
354 return AddrLabelSymbols->getAddrLabelSymbolToEmit(const_cast<BasicBlock*>(BB));
358 /// takeDeletedSymbolsForFunction - If the specified function has had any
359 /// references to address-taken blocks generated, but the block got deleted,
360 /// return the symbol now so we can emit it. This prevents emitting a
361 /// reference to a symbol that has no definition.
362 void MachineModuleInfo::
363 takeDeletedSymbolsForFunction(const Function *F,
364 std::vector<MCSymbol*> &Result) {
365 // If no blocks have had their addresses taken, we're done.
366 if (AddrLabelSymbols == 0) return;
367 return AddrLabelSymbols->
368 takeDeletedSymbolsForFunction(const_cast<Function*>(F), Result);
371 //===- EH -----------------------------------------------------------------===//
373 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
374 /// specified MachineBasicBlock.
375 LandingPadInfo &MachineModuleInfo::getOrCreateLandingPadInfo
376 (MachineBasicBlock *LandingPad) {
377 unsigned N = LandingPads.size();
378 for (unsigned i = 0; i < N; ++i) {
379 LandingPadInfo &LP = LandingPads[i];
380 if (LP.LandingPadBlock == LandingPad)
384 LandingPads.push_back(LandingPadInfo(LandingPad));
385 return LandingPads[N];
388 /// addInvoke - Provide the begin and end labels of an invoke style call and
389 /// associate it with a try landing pad block.
390 void MachineModuleInfo::addInvoke(MachineBasicBlock *LandingPad,
391 MCSymbol *BeginLabel, MCSymbol *EndLabel) {
392 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
393 LP.BeginLabels.push_back(BeginLabel);
394 LP.EndLabels.push_back(EndLabel);
397 /// addLandingPad - Provide the label of a try LandingPad block.
399 MCSymbol *MachineModuleInfo::addLandingPad(MachineBasicBlock *LandingPad) {
400 MCSymbol *LandingPadLabel = Context.CreateTempSymbol();
401 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
402 LP.LandingPadLabel = LandingPadLabel;
403 return LandingPadLabel;
406 /// addPersonality - Provide the personality function for the exception
408 void MachineModuleInfo::addPersonality(MachineBasicBlock *LandingPad,
409 const Function *Personality) {
410 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
411 LP.Personality = Personality;
413 for (unsigned i = 0; i < Personalities.size(); ++i)
414 if (Personalities[i] == Personality)
417 // If this is the first personality we're adding go
418 // ahead and add it at the beginning.
419 if (Personalities[0] == NULL)
420 Personalities[0] = Personality;
422 Personalities.push_back(Personality);
425 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
427 void MachineModuleInfo::addCatchTypeInfo(MachineBasicBlock *LandingPad,
428 std::vector<const GlobalVariable *> &TyInfo) {
429 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
430 for (unsigned N = TyInfo.size(); N; --N)
431 LP.TypeIds.push_back(getTypeIDFor(TyInfo[N - 1]));
434 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
436 void MachineModuleInfo::addFilterTypeInfo(MachineBasicBlock *LandingPad,
437 std::vector<const GlobalVariable *> &TyInfo) {
438 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
439 std::vector<unsigned> IdsInFilter(TyInfo.size());
440 for (unsigned I = 0, E = TyInfo.size(); I != E; ++I)
441 IdsInFilter[I] = getTypeIDFor(TyInfo[I]);
442 LP.TypeIds.push_back(getFilterIDFor(IdsInFilter));
445 /// addCleanup - Add a cleanup action for a landing pad.
447 void MachineModuleInfo::addCleanup(MachineBasicBlock *LandingPad) {
448 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
449 LP.TypeIds.push_back(0);
452 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
454 void MachineModuleInfo::TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap) {
455 for (unsigned i = 0; i != LandingPads.size(); ) {
456 LandingPadInfo &LandingPad = LandingPads[i];
457 if (LandingPad.LandingPadLabel &&
458 !LandingPad.LandingPadLabel->isDefined() &&
459 (!LPMap || (*LPMap)[LandingPad.LandingPadLabel] == 0))
460 LandingPad.LandingPadLabel = 0;
462 // Special case: we *should* emit LPs with null LP MBB. This indicates
464 if (!LandingPad.LandingPadLabel && LandingPad.LandingPadBlock) {
465 LandingPads.erase(LandingPads.begin() + i);
469 for (unsigned j = 0, e = LandingPads[i].BeginLabels.size(); j != e; ++j) {
470 MCSymbol *BeginLabel = LandingPad.BeginLabels[j];
471 MCSymbol *EndLabel = LandingPad.EndLabels[j];
472 if ((BeginLabel->isDefined() ||
473 (LPMap && (*LPMap)[BeginLabel] != 0)) &&
474 (EndLabel->isDefined() ||
475 (LPMap && (*LPMap)[EndLabel] != 0))) continue;
477 LandingPad.BeginLabels.erase(LandingPad.BeginLabels.begin() + j);
478 LandingPad.EndLabels.erase(LandingPad.EndLabels.begin() + j);
482 // Remove landing pads with no try-ranges.
483 if (LandingPads[i].BeginLabels.empty()) {
484 LandingPads.erase(LandingPads.begin() + i);
488 // If there is no landing pad, ensure that the list of typeids is empty.
489 // If the only typeid is a cleanup, this is the same as having no typeids.
490 if (!LandingPad.LandingPadBlock ||
491 (LandingPad.TypeIds.size() == 1 && !LandingPad.TypeIds[0]))
492 LandingPad.TypeIds.clear();
497 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
499 unsigned MachineModuleInfo::getTypeIDFor(const GlobalVariable *TI) {
500 for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
501 if (TypeInfos[i] == TI) return i + 1;
503 TypeInfos.push_back(TI);
504 return TypeInfos.size();
507 /// getFilterIDFor - Return the filter id for the specified typeinfos. This is
509 int MachineModuleInfo::getFilterIDFor(std::vector<unsigned> &TyIds) {
510 // If the new filter coincides with the tail of an existing filter, then
511 // re-use the existing filter. Folding filters more than this requires
512 // re-ordering filters and/or their elements - probably not worth it.
513 for (std::vector<unsigned>::iterator I = FilterEnds.begin(),
514 E = FilterEnds.end(); I != E; ++I) {
515 unsigned i = *I, j = TyIds.size();
518 if (FilterIds[--i] != TyIds[--j])
522 // The new filter coincides with range [i, end) of the existing filter.
528 // Add the new filter.
529 int FilterID = -(1 + FilterIds.size());
530 FilterIds.reserve(FilterIds.size() + TyIds.size() + 1);
531 for (unsigned I = 0, N = TyIds.size(); I != N; ++I)
532 FilterIds.push_back(TyIds[I]);
533 FilterEnds.push_back(FilterIds.size());
534 FilterIds.push_back(0); // terminator
538 /// getPersonality - Return the personality function for the current function.
539 const Function *MachineModuleInfo::getPersonality() const {
540 // FIXME: Until PR1414 will be fixed, we're using 1 personality function per
542 return !LandingPads.empty() ? LandingPads[0].Personality : NULL;
545 /// getPersonalityIndex - Return unique index for current personality
546 /// function. NULL/first personality function should always get zero index.
547 unsigned MachineModuleInfo::getPersonalityIndex() const {
548 const Function* Personality = NULL;
550 // Scan landing pads. If there is at least one non-NULL personality - use it.
551 for (unsigned i = 0; i != LandingPads.size(); ++i)
552 if (LandingPads[i].Personality) {
553 Personality = LandingPads[i].Personality;
557 for (unsigned i = 0; i < Personalities.size(); ++i) {
558 if (Personalities[i] == Personality)
562 // This will happen if the current personality function is
563 // in the zero index.