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 const TargetAsmInfo
*TAI
)
258 : ImmutablePass(ID
), Context(MAI
, TAI
),
260 CurCallSite(0), CallsEHReturn(0), CallsUnwindInit(0), DbgInfoAvailable(false),
261 CallsExternalVAFunctionWithFloatingPointArguments(false) {
262 initializeMachineModuleInfoPass(*PassRegistry::getPassRegistry());
263 // Always emit some info, by default "no personality" info.
264 Personalities
.push_back(NULL
);
265 AddrLabelSymbols
= 0;
269 MachineModuleInfo::MachineModuleInfo()
270 : ImmutablePass(ID
), Context(*(MCAsmInfo
*)0, NULL
) {
271 assert(0 && "This MachineModuleInfo constructor should never be called, MMI "
272 "should always be explicitly constructed by LLVMTargetMachine");
276 MachineModuleInfo::~MachineModuleInfo() {
279 // FIXME: Why isn't doFinalization being called??
280 //assert(AddrLabelSymbols == 0 && "doFinalization not called");
281 delete AddrLabelSymbols
;
282 AddrLabelSymbols
= 0;
285 /// doInitialization - Initialize the state for a new module.
287 bool MachineModuleInfo::doInitialization() {
288 assert(AddrLabelSymbols
== 0 && "Improperly initialized");
292 /// doFinalization - Tear down the state after completion of a module.
294 bool MachineModuleInfo::doFinalization() {
295 delete AddrLabelSymbols
;
296 AddrLabelSymbols
= 0;
300 /// EndFunction - Discard function meta information.
302 void MachineModuleInfo::EndFunction() {
303 // Clean up frame info.
306 // Clean up exception info.
314 VariableDbgInfo
.clear();
317 /// AnalyzeModule - Scan the module for global debug information.
319 void MachineModuleInfo::AnalyzeModule(const Module
&M
) {
320 // Insert functions in the llvm.used array (but not llvm.compiler.used) into
322 const GlobalVariable
*GV
= M
.getGlobalVariable("llvm.used");
323 if (!GV
|| !GV
->hasInitializer()) return;
325 // Should be an array of 'i8*'.
326 const ConstantArray
*InitList
= dyn_cast
<ConstantArray
>(GV
->getInitializer());
327 if (InitList
== 0) return;
329 for (unsigned i
= 0, e
= InitList
->getNumOperands(); i
!= e
; ++i
)
330 if (const Function
*F
=
331 dyn_cast
<Function
>(InitList
->getOperand(i
)->stripPointerCasts()))
332 UsedFunctions
.insert(F
);
335 //===- Address of Block Management ----------------------------------------===//
338 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
339 /// block when its address is taken. This cannot be its normal LBB label
340 /// because the block may be accessed outside its containing function.
341 MCSymbol
*MachineModuleInfo::getAddrLabelSymbol(const BasicBlock
*BB
) {
342 // Lazily create AddrLabelSymbols.
343 if (AddrLabelSymbols
== 0)
344 AddrLabelSymbols
= new MMIAddrLabelMap(Context
);
345 return AddrLabelSymbols
->getAddrLabelSymbol(const_cast<BasicBlock
*>(BB
));
348 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
349 /// basic block when its address is taken. If other blocks were RAUW'd to
350 /// this one, we may have to emit them as well, return the whole set.
351 std::vector
<MCSymbol
*> MachineModuleInfo::
352 getAddrLabelSymbolToEmit(const BasicBlock
*BB
) {
353 // Lazily create AddrLabelSymbols.
354 if (AddrLabelSymbols
== 0)
355 AddrLabelSymbols
= new MMIAddrLabelMap(Context
);
356 return AddrLabelSymbols
->getAddrLabelSymbolToEmit(const_cast<BasicBlock
*>(BB
));
360 /// takeDeletedSymbolsForFunction - If the specified function has had any
361 /// references to address-taken blocks generated, but the block got deleted,
362 /// return the symbol now so we can emit it. This prevents emitting a
363 /// reference to a symbol that has no definition.
364 void MachineModuleInfo::
365 takeDeletedSymbolsForFunction(const Function
*F
,
366 std::vector
<MCSymbol
*> &Result
) {
367 // If no blocks have had their addresses taken, we're done.
368 if (AddrLabelSymbols
== 0) return;
369 return AddrLabelSymbols
->
370 takeDeletedSymbolsForFunction(const_cast<Function
*>(F
), Result
);
373 //===- EH -----------------------------------------------------------------===//
375 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
376 /// specified MachineBasicBlock.
377 LandingPadInfo
&MachineModuleInfo::getOrCreateLandingPadInfo
378 (MachineBasicBlock
*LandingPad
) {
379 unsigned N
= LandingPads
.size();
380 for (unsigned i
= 0; i
< N
; ++i
) {
381 LandingPadInfo
&LP
= LandingPads
[i
];
382 if (LP
.LandingPadBlock
== LandingPad
)
386 LandingPads
.push_back(LandingPadInfo(LandingPad
));
387 return LandingPads
[N
];
390 /// addInvoke - Provide the begin and end labels of an invoke style call and
391 /// associate it with a try landing pad block.
392 void MachineModuleInfo::addInvoke(MachineBasicBlock
*LandingPad
,
393 MCSymbol
*BeginLabel
, MCSymbol
*EndLabel
) {
394 LandingPadInfo
&LP
= getOrCreateLandingPadInfo(LandingPad
);
395 LP
.BeginLabels
.push_back(BeginLabel
);
396 LP
.EndLabels
.push_back(EndLabel
);
399 /// addLandingPad - Provide the label of a try LandingPad block.
401 MCSymbol
*MachineModuleInfo::addLandingPad(MachineBasicBlock
*LandingPad
) {
402 MCSymbol
*LandingPadLabel
= Context
.CreateTempSymbol();
403 LandingPadInfo
&LP
= getOrCreateLandingPadInfo(LandingPad
);
404 LP
.LandingPadLabel
= LandingPadLabel
;
405 return LandingPadLabel
;
408 /// addPersonality - Provide the personality function for the exception
410 void MachineModuleInfo::addPersonality(MachineBasicBlock
*LandingPad
,
411 const Function
*Personality
) {
412 LandingPadInfo
&LP
= getOrCreateLandingPadInfo(LandingPad
);
413 LP
.Personality
= Personality
;
415 for (unsigned i
= 0; i
< Personalities
.size(); ++i
)
416 if (Personalities
[i
] == Personality
)
419 // If this is the first personality we're adding go
420 // ahead and add it at the beginning.
421 if (Personalities
[0] == NULL
)
422 Personalities
[0] = Personality
;
424 Personalities
.push_back(Personality
);
427 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
429 void MachineModuleInfo::addCatchTypeInfo(MachineBasicBlock
*LandingPad
,
430 std::vector
<const GlobalVariable
*> &TyInfo
) {
431 LandingPadInfo
&LP
= getOrCreateLandingPadInfo(LandingPad
);
432 for (unsigned N
= TyInfo
.size(); N
; --N
)
433 LP
.TypeIds
.push_back(getTypeIDFor(TyInfo
[N
- 1]));
436 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
438 void MachineModuleInfo::addFilterTypeInfo(MachineBasicBlock
*LandingPad
,
439 std::vector
<const GlobalVariable
*> &TyInfo
) {
440 LandingPadInfo
&LP
= getOrCreateLandingPadInfo(LandingPad
);
441 std::vector
<unsigned> IdsInFilter(TyInfo
.size());
442 for (unsigned I
= 0, E
= TyInfo
.size(); I
!= E
; ++I
)
443 IdsInFilter
[I
] = getTypeIDFor(TyInfo
[I
]);
444 LP
.TypeIds
.push_back(getFilterIDFor(IdsInFilter
));
447 /// addCleanup - Add a cleanup action for a landing pad.
449 void MachineModuleInfo::addCleanup(MachineBasicBlock
*LandingPad
) {
450 LandingPadInfo
&LP
= getOrCreateLandingPadInfo(LandingPad
);
451 LP
.TypeIds
.push_back(0);
454 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
456 void MachineModuleInfo::TidyLandingPads(DenseMap
<MCSymbol
*, uintptr_t> *LPMap
) {
457 for (unsigned i
= 0; i
!= LandingPads
.size(); ) {
458 LandingPadInfo
&LandingPad
= LandingPads
[i
];
459 if (LandingPad
.LandingPadLabel
&&
460 !LandingPad
.LandingPadLabel
->isDefined() &&
461 (!LPMap
|| (*LPMap
)[LandingPad
.LandingPadLabel
] == 0))
462 LandingPad
.LandingPadLabel
= 0;
464 // Special case: we *should* emit LPs with null LP MBB. This indicates
466 if (!LandingPad
.LandingPadLabel
&& LandingPad
.LandingPadBlock
) {
467 LandingPads
.erase(LandingPads
.begin() + i
);
471 for (unsigned j
= 0, e
= LandingPads
[i
].BeginLabels
.size(); j
!= e
; ++j
) {
472 MCSymbol
*BeginLabel
= LandingPad
.BeginLabels
[j
];
473 MCSymbol
*EndLabel
= LandingPad
.EndLabels
[j
];
474 if ((BeginLabel
->isDefined() ||
475 (LPMap
&& (*LPMap
)[BeginLabel
] != 0)) &&
476 (EndLabel
->isDefined() ||
477 (LPMap
&& (*LPMap
)[EndLabel
] != 0))) continue;
479 LandingPad
.BeginLabels
.erase(LandingPad
.BeginLabels
.begin() + j
);
480 LandingPad
.EndLabels
.erase(LandingPad
.EndLabels
.begin() + j
);
484 // Remove landing pads with no try-ranges.
485 if (LandingPads
[i
].BeginLabels
.empty()) {
486 LandingPads
.erase(LandingPads
.begin() + i
);
490 // If there is no landing pad, ensure that the list of typeids is empty.
491 // If the only typeid is a cleanup, this is the same as having no typeids.
492 if (!LandingPad
.LandingPadBlock
||
493 (LandingPad
.TypeIds
.size() == 1 && !LandingPad
.TypeIds
[0]))
494 LandingPad
.TypeIds
.clear();
499 /// getTypeIDFor - Return the type id for the specified typeinfo. This is
501 unsigned MachineModuleInfo::getTypeIDFor(const GlobalVariable
*TI
) {
502 for (unsigned i
= 0, N
= TypeInfos
.size(); i
!= N
; ++i
)
503 if (TypeInfos
[i
] == TI
) return i
+ 1;
505 TypeInfos
.push_back(TI
);
506 return TypeInfos
.size();
509 /// getFilterIDFor - Return the filter id for the specified typeinfos. This is
511 int MachineModuleInfo::getFilterIDFor(std::vector
<unsigned> &TyIds
) {
512 // If the new filter coincides with the tail of an existing filter, then
513 // re-use the existing filter. Folding filters more than this requires
514 // re-ordering filters and/or their elements - probably not worth it.
515 for (std::vector
<unsigned>::iterator I
= FilterEnds
.begin(),
516 E
= FilterEnds
.end(); I
!= E
; ++I
) {
517 unsigned i
= *I
, j
= TyIds
.size();
520 if (FilterIds
[--i
] != TyIds
[--j
])
524 // The new filter coincides with range [i, end) of the existing filter.
530 // Add the new filter.
531 int FilterID
= -(1 + FilterIds
.size());
532 FilterIds
.reserve(FilterIds
.size() + TyIds
.size() + 1);
533 for (unsigned I
= 0, N
= TyIds
.size(); I
!= N
; ++I
)
534 FilterIds
.push_back(TyIds
[I
]);
535 FilterEnds
.push_back(FilterIds
.size());
536 FilterIds
.push_back(0); // terminator
540 /// getPersonality - Return the personality function for the current function.
541 const Function
*MachineModuleInfo::getPersonality() const {
542 // FIXME: Until PR1414 will be fixed, we're using 1 personality function per
544 return !LandingPads
.empty() ? LandingPads
[0].Personality
: NULL
;
547 /// getPersonalityIndex - Return unique index for current personality
548 /// function. NULL/first personality function should always get zero index.
549 unsigned MachineModuleInfo::getPersonalityIndex() const {
550 const Function
* Personality
= NULL
;
552 // Scan landing pads. If there is at least one non-NULL personality - use it.
553 for (unsigned i
= 0; i
!= LandingPads
.size(); ++i
)
554 if (LandingPads
[i
].Personality
) {
555 Personality
= LandingPads
[i
].Personality
;
559 for (unsigned i
= 0; i
< Personalities
.size(); ++i
) {
560 if (Personalities
[i
] == Personality
)
564 // This will happen if the current personality function is
565 // in the zero index.