1f22ef01cSRoman Divacky //===-- llvm/CodeGen/MachineModuleInfo.cpp ----------------------*- C++ -*-===//
2f22ef01cSRoman Divacky //
3f22ef01cSRoman Divacky //                     The LLVM Compiler Infrastructure
4f22ef01cSRoman Divacky //
5f22ef01cSRoman Divacky // This file is distributed under the University of Illinois Open Source
6f22ef01cSRoman Divacky // License. See LICENSE.TXT for details.
7f22ef01cSRoman Divacky //
8f22ef01cSRoman Divacky //===----------------------------------------------------------------------===//
9f22ef01cSRoman Divacky 
10f22ef01cSRoman Divacky #include "llvm/CodeGen/MachineModuleInfo.h"
11139f7f9bSDimitry Andric #include "llvm/ADT/PointerUnion.h"
12ff0cc061SDimitry Andric #include "llvm/Analysis/LibCallSemantics.h"
13f22ef01cSRoman Divacky #include "llvm/Analysis/ValueTracking.h"
14f22ef01cSRoman Divacky #include "llvm/CodeGen/MachineFunction.h"
15139f7f9bSDimitry Andric #include "llvm/CodeGen/MachineFunctionPass.h"
16f22ef01cSRoman Divacky #include "llvm/CodeGen/Passes.h"
17ff0cc061SDimitry Andric #include "llvm/CodeGen/WinEHFuncInfo.h"
18139f7f9bSDimitry Andric #include "llvm/IR/Constants.h"
19139f7f9bSDimitry Andric #include "llvm/IR/DerivedTypes.h"
20139f7f9bSDimitry Andric #include "llvm/IR/GlobalVariable.h"
21139f7f9bSDimitry Andric #include "llvm/IR/Module.h"
226122f3e6SDimitry Andric #include "llvm/MC/MCObjectFileInfo.h"
23f22ef01cSRoman Divacky #include "llvm/MC/MCSymbol.h"
24f22ef01cSRoman Divacky #include "llvm/Support/Dwarf.h"
25f22ef01cSRoman Divacky #include "llvm/Support/ErrorHandling.h"
26f22ef01cSRoman Divacky using namespace llvm;
27f22ef01cSRoman Divacky using namespace llvm::dwarf;
28f22ef01cSRoman Divacky 
293861d79fSDimitry Andric // Handle the Pass registration stuff necessary to use DataLayout's.
30e580952dSDimitry Andric INITIALIZE_PASS(MachineModuleInfo, "machinemoduleinfo",
312754fe60SDimitry Andric                 "Machine Module Information", false, false)
32f22ef01cSRoman Divacky char MachineModuleInfo::ID = 0;
33f22ef01cSRoman Divacky 
34f22ef01cSRoman Divacky // Out of line virtual method.
35f22ef01cSRoman Divacky MachineModuleInfoImpl::~MachineModuleInfoImpl() {}
36f22ef01cSRoman Divacky 
37f22ef01cSRoman Divacky namespace llvm {
38f22ef01cSRoman Divacky class MMIAddrLabelMapCallbackPtr : CallbackVH {
39f22ef01cSRoman Divacky   MMIAddrLabelMap *Map;
40f22ef01cSRoman Divacky public:
4191bc56edSDimitry Andric   MMIAddrLabelMapCallbackPtr() : Map(nullptr) {}
4291bc56edSDimitry Andric   MMIAddrLabelMapCallbackPtr(Value *V) : CallbackVH(V), Map(nullptr) {}
43f22ef01cSRoman Divacky 
44f22ef01cSRoman Divacky   void setPtr(BasicBlock *BB) {
45f22ef01cSRoman Divacky     ValueHandleBase::operator=(BB);
46f22ef01cSRoman Divacky   }
47f22ef01cSRoman Divacky 
48f22ef01cSRoman Divacky   void setMap(MMIAddrLabelMap *map) { Map = map; }
49f22ef01cSRoman Divacky 
5091bc56edSDimitry Andric   void deleted() override;
5191bc56edSDimitry Andric   void allUsesReplacedWith(Value *V2) override;
52f22ef01cSRoman Divacky };
53f22ef01cSRoman Divacky 
54f22ef01cSRoman Divacky class MMIAddrLabelMap {
55f22ef01cSRoman Divacky   MCContext &Context;
56f22ef01cSRoman Divacky   struct AddrLabelSymEntry {
57f22ef01cSRoman Divacky     /// Symbols - The symbols for the label.  This is a pointer union that is
58f22ef01cSRoman Divacky     /// either one symbol (the common case) or a list of symbols.
59f22ef01cSRoman Divacky     PointerUnion<MCSymbol *, std::vector<MCSymbol*>*> Symbols;
60f22ef01cSRoman Divacky 
61f22ef01cSRoman Divacky     Function *Fn;   // The containing function of the BasicBlock.
62f22ef01cSRoman Divacky     unsigned Index; // The index in BBCallbacks for the BasicBlock.
63f22ef01cSRoman Divacky   };
64f22ef01cSRoman Divacky 
65f22ef01cSRoman Divacky   DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry> AddrLabelSymbols;
66f22ef01cSRoman Divacky 
67f22ef01cSRoman Divacky   /// BBCallbacks - Callbacks for the BasicBlock's that we have entries for.  We
68f22ef01cSRoman Divacky   /// use this so we get notified if a block is deleted or RAUWd.
69f22ef01cSRoman Divacky   std::vector<MMIAddrLabelMapCallbackPtr> BBCallbacks;
70f22ef01cSRoman Divacky 
71f22ef01cSRoman Divacky   /// DeletedAddrLabelsNeedingEmission - This is a per-function list of symbols
72f22ef01cSRoman Divacky   /// whose corresponding BasicBlock got deleted.  These symbols need to be
73f22ef01cSRoman Divacky   /// emitted at some point in the file, so AsmPrinter emits them after the
74f22ef01cSRoman Divacky   /// function body.
75f22ef01cSRoman Divacky   DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >
76f22ef01cSRoman Divacky     DeletedAddrLabelsNeedingEmission;
77f22ef01cSRoman Divacky public:
78f22ef01cSRoman Divacky 
79f22ef01cSRoman Divacky   MMIAddrLabelMap(MCContext &context) : Context(context) {}
80f22ef01cSRoman Divacky   ~MMIAddrLabelMap() {
81f22ef01cSRoman Divacky     assert(DeletedAddrLabelsNeedingEmission.empty() &&
82f22ef01cSRoman Divacky            "Some labels for deleted blocks never got emitted");
83f22ef01cSRoman Divacky 
84f22ef01cSRoman Divacky     // Deallocate any of the 'list of symbols' case.
85f22ef01cSRoman Divacky     for (DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry>::iterator
86f22ef01cSRoman Divacky          I = AddrLabelSymbols.begin(), E = AddrLabelSymbols.end(); I != E; ++I)
87f22ef01cSRoman Divacky       if (I->second.Symbols.is<std::vector<MCSymbol*>*>())
88f22ef01cSRoman Divacky         delete I->second.Symbols.get<std::vector<MCSymbol*>*>();
89f22ef01cSRoman Divacky   }
90f22ef01cSRoman Divacky 
91f22ef01cSRoman Divacky   MCSymbol *getAddrLabelSymbol(BasicBlock *BB);
92f22ef01cSRoman Divacky   std::vector<MCSymbol*> getAddrLabelSymbolToEmit(BasicBlock *BB);
93f22ef01cSRoman Divacky 
94f22ef01cSRoman Divacky   void takeDeletedSymbolsForFunction(Function *F,
95f22ef01cSRoman Divacky                                      std::vector<MCSymbol*> &Result);
96f22ef01cSRoman Divacky 
97f22ef01cSRoman Divacky   void UpdateForDeletedBlock(BasicBlock *BB);
98f22ef01cSRoman Divacky   void UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New);
99f22ef01cSRoman Divacky };
100f22ef01cSRoman Divacky }
101f22ef01cSRoman Divacky 
102f22ef01cSRoman Divacky MCSymbol *MMIAddrLabelMap::getAddrLabelSymbol(BasicBlock *BB) {
103f22ef01cSRoman Divacky   assert(BB->hasAddressTaken() &&
104f22ef01cSRoman Divacky          "Shouldn't get label for block without address taken");
105f22ef01cSRoman Divacky   AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
106f22ef01cSRoman Divacky 
107f22ef01cSRoman Divacky   // If we already had an entry for this block, just return it.
108f22ef01cSRoman Divacky   if (!Entry.Symbols.isNull()) {
109f22ef01cSRoman Divacky     assert(BB->getParent() == Entry.Fn && "Parent changed");
110f22ef01cSRoman Divacky     if (Entry.Symbols.is<MCSymbol*>())
111f22ef01cSRoman Divacky       return Entry.Symbols.get<MCSymbol*>();
112f22ef01cSRoman Divacky     return (*Entry.Symbols.get<std::vector<MCSymbol*>*>())[0];
113f22ef01cSRoman Divacky   }
114f22ef01cSRoman Divacky 
115f22ef01cSRoman Divacky   // Otherwise, this is a new entry, create a new symbol for it and add an
116f22ef01cSRoman Divacky   // entry to BBCallbacks so we can be notified if the BB is deleted or RAUWd.
117f22ef01cSRoman Divacky   BBCallbacks.push_back(BB);
118f22ef01cSRoman Divacky   BBCallbacks.back().setMap(this);
119f22ef01cSRoman Divacky   Entry.Index = BBCallbacks.size()-1;
120f22ef01cSRoman Divacky   Entry.Fn = BB->getParent();
121ff0cc061SDimitry Andric   MCSymbol *Result = Context.createTempSymbol();
122f22ef01cSRoman Divacky   Entry.Symbols = Result;
123f22ef01cSRoman Divacky   return Result;
124f22ef01cSRoman Divacky }
125f22ef01cSRoman Divacky 
126f22ef01cSRoman Divacky std::vector<MCSymbol*>
127f22ef01cSRoman Divacky MMIAddrLabelMap::getAddrLabelSymbolToEmit(BasicBlock *BB) {
128f22ef01cSRoman Divacky   assert(BB->hasAddressTaken() &&
129f22ef01cSRoman Divacky          "Shouldn't get label for block without address taken");
130f22ef01cSRoman Divacky   AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
131f22ef01cSRoman Divacky 
132f22ef01cSRoman Divacky   std::vector<MCSymbol*> Result;
133f22ef01cSRoman Divacky 
134f22ef01cSRoman Divacky   // If we already had an entry for this block, just return it.
135f22ef01cSRoman Divacky   if (Entry.Symbols.isNull())
136f22ef01cSRoman Divacky     Result.push_back(getAddrLabelSymbol(BB));
137f22ef01cSRoman Divacky   else if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>())
138f22ef01cSRoman Divacky     Result.push_back(Sym);
139f22ef01cSRoman Divacky   else
140f22ef01cSRoman Divacky     Result = *Entry.Symbols.get<std::vector<MCSymbol*>*>();
141f22ef01cSRoman Divacky   return Result;
142f22ef01cSRoman Divacky }
143f22ef01cSRoman Divacky 
144f22ef01cSRoman Divacky 
145f22ef01cSRoman Divacky /// takeDeletedSymbolsForFunction - If we have any deleted symbols for F, return
146f22ef01cSRoman Divacky /// them.
147f22ef01cSRoman Divacky void MMIAddrLabelMap::
148f22ef01cSRoman Divacky takeDeletedSymbolsForFunction(Function *F, std::vector<MCSymbol*> &Result) {
149f22ef01cSRoman Divacky   DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >::iterator I =
150f22ef01cSRoman Divacky     DeletedAddrLabelsNeedingEmission.find(F);
151f22ef01cSRoman Divacky 
152f22ef01cSRoman Divacky   // If there are no entries for the function, just return.
153f22ef01cSRoman Divacky   if (I == DeletedAddrLabelsNeedingEmission.end()) return;
154f22ef01cSRoman Divacky 
155f22ef01cSRoman Divacky   // Otherwise, take the list.
156f22ef01cSRoman Divacky   std::swap(Result, I->second);
157f22ef01cSRoman Divacky   DeletedAddrLabelsNeedingEmission.erase(I);
158f22ef01cSRoman Divacky }
159f22ef01cSRoman Divacky 
160f22ef01cSRoman Divacky 
161f22ef01cSRoman Divacky void MMIAddrLabelMap::UpdateForDeletedBlock(BasicBlock *BB) {
162f22ef01cSRoman Divacky   // If the block got deleted, there is no need for the symbol.  If the symbol
163f22ef01cSRoman Divacky   // was already emitted, we can just forget about it, otherwise we need to
164f22ef01cSRoman Divacky   // queue it up for later emission when the function is output.
165f22ef01cSRoman Divacky   AddrLabelSymEntry Entry = AddrLabelSymbols[BB];
166f22ef01cSRoman Divacky   AddrLabelSymbols.erase(BB);
167f22ef01cSRoman Divacky   assert(!Entry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
16891bc56edSDimitry Andric   BBCallbacks[Entry.Index] = nullptr;  // Clear the callback.
169f22ef01cSRoman Divacky 
17091bc56edSDimitry Andric   assert((BB->getParent() == nullptr || BB->getParent() == Entry.Fn) &&
171f22ef01cSRoman Divacky          "Block/parent mismatch");
172f22ef01cSRoman Divacky 
173f22ef01cSRoman Divacky   // Handle both the single and the multiple symbols cases.
174f22ef01cSRoman Divacky   if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>()) {
175f22ef01cSRoman Divacky     if (Sym->isDefined())
176f22ef01cSRoman Divacky       return;
177f22ef01cSRoman Divacky 
178f22ef01cSRoman Divacky     // If the block is not yet defined, we need to emit it at the end of the
179f22ef01cSRoman Divacky     // function.  Add the symbol to the DeletedAddrLabelsNeedingEmission list
180f22ef01cSRoman Divacky     // for the containing Function.  Since the block is being deleted, its
181f22ef01cSRoman Divacky     // parent may already be removed, we have to get the function from 'Entry'.
182f22ef01cSRoman Divacky     DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
183f22ef01cSRoman Divacky   } else {
184f22ef01cSRoman Divacky     std::vector<MCSymbol*> *Syms = Entry.Symbols.get<std::vector<MCSymbol*>*>();
185f22ef01cSRoman Divacky 
186f22ef01cSRoman Divacky     for (unsigned i = 0, e = Syms->size(); i != e; ++i) {
187f22ef01cSRoman Divacky       MCSymbol *Sym = (*Syms)[i];
188f22ef01cSRoman Divacky       if (Sym->isDefined()) continue;  // Ignore already emitted labels.
189f22ef01cSRoman Divacky 
190f22ef01cSRoman Divacky       // If the block is not yet defined, we need to emit it at the end of the
191f22ef01cSRoman Divacky       // function.  Add the symbol to the DeletedAddrLabelsNeedingEmission list
192f22ef01cSRoman Divacky       // for the containing Function.  Since the block is being deleted, its
193f22ef01cSRoman Divacky       // parent may already be removed, we have to get the function from
194f22ef01cSRoman Divacky       // 'Entry'.
195f22ef01cSRoman Divacky       DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
196f22ef01cSRoman Divacky     }
197f22ef01cSRoman Divacky 
198f22ef01cSRoman Divacky     // The entry is deleted, free the memory associated with the symbol list.
199f22ef01cSRoman Divacky     delete Syms;
200f22ef01cSRoman Divacky   }
201f22ef01cSRoman Divacky }
202f22ef01cSRoman Divacky 
203f22ef01cSRoman Divacky void MMIAddrLabelMap::UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New) {
204f22ef01cSRoman Divacky   // Get the entry for the RAUW'd block and remove it from our map.
205f22ef01cSRoman Divacky   AddrLabelSymEntry OldEntry = AddrLabelSymbols[Old];
206f22ef01cSRoman Divacky   AddrLabelSymbols.erase(Old);
207f22ef01cSRoman Divacky   assert(!OldEntry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
208f22ef01cSRoman Divacky 
209f22ef01cSRoman Divacky   AddrLabelSymEntry &NewEntry = AddrLabelSymbols[New];
210f22ef01cSRoman Divacky 
211f22ef01cSRoman Divacky   // If New is not address taken, just move our symbol over to it.
212f22ef01cSRoman Divacky   if (NewEntry.Symbols.isNull()) {
213f22ef01cSRoman Divacky     BBCallbacks[OldEntry.Index].setPtr(New);    // Update the callback.
214f22ef01cSRoman Divacky     NewEntry = OldEntry;     // Set New's entry.
215f22ef01cSRoman Divacky     return;
216f22ef01cSRoman Divacky   }
217f22ef01cSRoman Divacky 
21891bc56edSDimitry Andric   BBCallbacks[OldEntry.Index] = nullptr;    // Update the callback.
219f22ef01cSRoman Divacky 
220f22ef01cSRoman Divacky   // Otherwise, we need to add the old symbol to the new block's set.  If it is
221f22ef01cSRoman Divacky   // just a single entry, upgrade it to a symbol list.
222f22ef01cSRoman Divacky   if (MCSymbol *PrevSym = NewEntry.Symbols.dyn_cast<MCSymbol*>()) {
223f22ef01cSRoman Divacky     std::vector<MCSymbol*> *SymList = new std::vector<MCSymbol*>();
224f22ef01cSRoman Divacky     SymList->push_back(PrevSym);
225f22ef01cSRoman Divacky     NewEntry.Symbols = SymList;
226f22ef01cSRoman Divacky   }
227f22ef01cSRoman Divacky 
228f22ef01cSRoman Divacky   std::vector<MCSymbol*> *SymList =
229f22ef01cSRoman Divacky     NewEntry.Symbols.get<std::vector<MCSymbol*>*>();
230f22ef01cSRoman Divacky 
231f22ef01cSRoman Divacky   // If the old entry was a single symbol, add it.
232f22ef01cSRoman Divacky   if (MCSymbol *Sym = OldEntry.Symbols.dyn_cast<MCSymbol*>()) {
233f22ef01cSRoman Divacky     SymList->push_back(Sym);
234f22ef01cSRoman Divacky     return;
235f22ef01cSRoman Divacky   }
236f22ef01cSRoman Divacky 
237f22ef01cSRoman Divacky   // Otherwise, concatenate the list.
238f22ef01cSRoman Divacky   std::vector<MCSymbol*> *Syms =OldEntry.Symbols.get<std::vector<MCSymbol*>*>();
239f22ef01cSRoman Divacky   SymList->insert(SymList->end(), Syms->begin(), Syms->end());
240f22ef01cSRoman Divacky   delete Syms;
241f22ef01cSRoman Divacky }
242f22ef01cSRoman Divacky 
243f22ef01cSRoman Divacky 
244f22ef01cSRoman Divacky void MMIAddrLabelMapCallbackPtr::deleted() {
245f22ef01cSRoman Divacky   Map->UpdateForDeletedBlock(cast<BasicBlock>(getValPtr()));
246f22ef01cSRoman Divacky }
247f22ef01cSRoman Divacky 
248f22ef01cSRoman Divacky void MMIAddrLabelMapCallbackPtr::allUsesReplacedWith(Value *V2) {
249f22ef01cSRoman Divacky   Map->UpdateForRAUWBlock(cast<BasicBlock>(getValPtr()), cast<BasicBlock>(V2));
250f22ef01cSRoman Divacky }
251f22ef01cSRoman Divacky 
252f22ef01cSRoman Divacky 
253f22ef01cSRoman Divacky //===----------------------------------------------------------------------===//
254f22ef01cSRoman Divacky 
2552754fe60SDimitry Andric MachineModuleInfo::MachineModuleInfo(const MCAsmInfo &MAI,
2566122f3e6SDimitry Andric                                      const MCRegisterInfo &MRI,
2576122f3e6SDimitry Andric                                      const MCObjectFileInfo *MOFI)
25891bc56edSDimitry Andric   : ImmutablePass(ID), Context(&MAI, &MRI, MOFI, nullptr, false) {
2592754fe60SDimitry Andric   initializeMachineModuleInfoPass(*PassRegistry::getPassRegistry());
260f22ef01cSRoman Divacky }
261f22ef01cSRoman Divacky 
262f22ef01cSRoman Divacky MachineModuleInfo::MachineModuleInfo()
26391bc56edSDimitry Andric   : ImmutablePass(ID), Context(nullptr, nullptr, nullptr) {
264dff0c46cSDimitry Andric   llvm_unreachable("This MachineModuleInfo constructor should never be called, "
265dff0c46cSDimitry Andric                    "MMI should always be explicitly constructed by "
266dff0c46cSDimitry Andric                    "LLVMTargetMachine");
267f22ef01cSRoman Divacky }
268f22ef01cSRoman Divacky 
269f22ef01cSRoman Divacky MachineModuleInfo::~MachineModuleInfo() {
270f22ef01cSRoman Divacky }
271f22ef01cSRoman Divacky 
272139f7f9bSDimitry Andric bool MachineModuleInfo::doInitialization(Module &M) {
273139f7f9bSDimitry Andric 
27491bc56edSDimitry Andric   ObjFileMMI = nullptr;
275139f7f9bSDimitry Andric   CurCallSite = 0;
276139f7f9bSDimitry Andric   CallsEHReturn = 0;
277139f7f9bSDimitry Andric   CallsUnwindInit = 0;
27839d628a0SDimitry Andric   DbgInfoAvailable = UsesVAFloatArgument = UsesMorestackAddr = false;
279139f7f9bSDimitry Andric   // Always emit some info, by default "no personality" info.
28091bc56edSDimitry Andric   Personalities.push_back(nullptr);
281ff0cc061SDimitry Andric   PersonalityTypeCache = EHPersonality::Unknown;
28291bc56edSDimitry Andric   AddrLabelSymbols = nullptr;
28391bc56edSDimitry Andric   TheModule = nullptr;
284139f7f9bSDimitry Andric 
285f22ef01cSRoman Divacky   return false;
286f22ef01cSRoman Divacky }
287f22ef01cSRoman Divacky 
288139f7f9bSDimitry Andric bool MachineModuleInfo::doFinalization(Module &M) {
289139f7f9bSDimitry Andric 
290139f7f9bSDimitry Andric   Personalities.clear();
291139f7f9bSDimitry Andric 
292f22ef01cSRoman Divacky   delete AddrLabelSymbols;
29391bc56edSDimitry Andric   AddrLabelSymbols = nullptr;
294139f7f9bSDimitry Andric 
295139f7f9bSDimitry Andric   Context.reset();
296139f7f9bSDimitry Andric 
297139f7f9bSDimitry Andric   delete ObjFileMMI;
29891bc56edSDimitry Andric   ObjFileMMI = nullptr;
299139f7f9bSDimitry Andric 
300f22ef01cSRoman Divacky   return false;
301f22ef01cSRoman Divacky }
302f22ef01cSRoman Divacky 
303f22ef01cSRoman Divacky /// EndFunction - Discard function meta information.
304f22ef01cSRoman Divacky ///
305f22ef01cSRoman Divacky void MachineModuleInfo::EndFunction() {
306f22ef01cSRoman Divacky   // Clean up frame info.
307f785676fSDimitry Andric   FrameInstructions.clear();
308f22ef01cSRoman Divacky 
309f22ef01cSRoman Divacky   // Clean up exception info.
310f22ef01cSRoman Divacky   LandingPads.clear();
311f22ef01cSRoman Divacky   CallSiteMap.clear();
312f22ef01cSRoman Divacky   TypeInfos.clear();
313f22ef01cSRoman Divacky   FilterIds.clear();
314f22ef01cSRoman Divacky   FilterEnds.clear();
315f22ef01cSRoman Divacky   CallsEHReturn = 0;
316f22ef01cSRoman Divacky   CallsUnwindInit = 0;
31791bc56edSDimitry Andric   VariableDbgInfos.clear();
318f22ef01cSRoman Divacky }
319f22ef01cSRoman Divacky 
320f22ef01cSRoman Divacky /// AnalyzeModule - Scan the module for global debug information.
321f22ef01cSRoman Divacky ///
322f22ef01cSRoman Divacky void MachineModuleInfo::AnalyzeModule(const Module &M) {
323f22ef01cSRoman Divacky   // Insert functions in the llvm.used array (but not llvm.compiler.used) into
324f22ef01cSRoman Divacky   // UsedFunctions.
325f22ef01cSRoman Divacky   const GlobalVariable *GV = M.getGlobalVariable("llvm.used");
326f22ef01cSRoman Divacky   if (!GV || !GV->hasInitializer()) return;
327f22ef01cSRoman Divacky 
328f22ef01cSRoman Divacky   // Should be an array of 'i8*'.
329284c1978SDimitry Andric   const ConstantArray *InitList = cast<ConstantArray>(GV->getInitializer());
330f22ef01cSRoman Divacky 
331f22ef01cSRoman Divacky   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
332f22ef01cSRoman Divacky     if (const Function *F =
333f22ef01cSRoman Divacky           dyn_cast<Function>(InitList->getOperand(i)->stripPointerCasts()))
334f22ef01cSRoman Divacky       UsedFunctions.insert(F);
335f22ef01cSRoman Divacky }
336f22ef01cSRoman Divacky 
337f22ef01cSRoman Divacky //===- Address of Block Management ----------------------------------------===//
338f22ef01cSRoman Divacky 
339f22ef01cSRoman Divacky 
340f22ef01cSRoman Divacky /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
341f22ef01cSRoman Divacky /// block when its address is taken.  This cannot be its normal LBB label
342f22ef01cSRoman Divacky /// because the block may be accessed outside its containing function.
343f22ef01cSRoman Divacky MCSymbol *MachineModuleInfo::getAddrLabelSymbol(const BasicBlock *BB) {
344f22ef01cSRoman Divacky   // Lazily create AddrLabelSymbols.
34591bc56edSDimitry Andric   if (!AddrLabelSymbols)
346f22ef01cSRoman Divacky     AddrLabelSymbols = new MMIAddrLabelMap(Context);
347f22ef01cSRoman Divacky   return AddrLabelSymbols->getAddrLabelSymbol(const_cast<BasicBlock*>(BB));
348f22ef01cSRoman Divacky }
349f22ef01cSRoman Divacky 
350f22ef01cSRoman Divacky /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
351f22ef01cSRoman Divacky /// basic block when its address is taken.  If other blocks were RAUW'd to
352f22ef01cSRoman Divacky /// this one, we may have to emit them as well, return the whole set.
353f22ef01cSRoman Divacky std::vector<MCSymbol*> MachineModuleInfo::
354f22ef01cSRoman Divacky getAddrLabelSymbolToEmit(const BasicBlock *BB) {
355f22ef01cSRoman Divacky   // Lazily create AddrLabelSymbols.
35691bc56edSDimitry Andric   if (!AddrLabelSymbols)
357f22ef01cSRoman Divacky     AddrLabelSymbols = new MMIAddrLabelMap(Context);
358f22ef01cSRoman Divacky  return AddrLabelSymbols->getAddrLabelSymbolToEmit(const_cast<BasicBlock*>(BB));
359f22ef01cSRoman Divacky }
360f22ef01cSRoman Divacky 
361f22ef01cSRoman Divacky 
362f22ef01cSRoman Divacky /// takeDeletedSymbolsForFunction - If the specified function has had any
363f22ef01cSRoman Divacky /// references to address-taken blocks generated, but the block got deleted,
364f22ef01cSRoman Divacky /// return the symbol now so we can emit it.  This prevents emitting a
365f22ef01cSRoman Divacky /// reference to a symbol that has no definition.
366f22ef01cSRoman Divacky void MachineModuleInfo::
367f22ef01cSRoman Divacky takeDeletedSymbolsForFunction(const Function *F,
368f22ef01cSRoman Divacky                               std::vector<MCSymbol*> &Result) {
369f22ef01cSRoman Divacky   // If no blocks have had their addresses taken, we're done.
37091bc56edSDimitry Andric   if (!AddrLabelSymbols) return;
371f22ef01cSRoman Divacky   return AddrLabelSymbols->
372f22ef01cSRoman Divacky      takeDeletedSymbolsForFunction(const_cast<Function*>(F), Result);
373f22ef01cSRoman Divacky }
374f22ef01cSRoman Divacky 
375f22ef01cSRoman Divacky //===- EH -----------------------------------------------------------------===//
376f22ef01cSRoman Divacky 
377f22ef01cSRoman Divacky /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
378f22ef01cSRoman Divacky /// specified MachineBasicBlock.
379f22ef01cSRoman Divacky LandingPadInfo &MachineModuleInfo::getOrCreateLandingPadInfo
380f22ef01cSRoman Divacky     (MachineBasicBlock *LandingPad) {
381f22ef01cSRoman Divacky   unsigned N = LandingPads.size();
382f22ef01cSRoman Divacky   for (unsigned i = 0; i < N; ++i) {
383f22ef01cSRoman Divacky     LandingPadInfo &LP = LandingPads[i];
384f22ef01cSRoman Divacky     if (LP.LandingPadBlock == LandingPad)
385f22ef01cSRoman Divacky       return LP;
386f22ef01cSRoman Divacky   }
387f22ef01cSRoman Divacky 
388f22ef01cSRoman Divacky   LandingPads.push_back(LandingPadInfo(LandingPad));
389f22ef01cSRoman Divacky   return LandingPads[N];
390f22ef01cSRoman Divacky }
391f22ef01cSRoman Divacky 
392f22ef01cSRoman Divacky /// addInvoke - Provide the begin and end labels of an invoke style call and
393f22ef01cSRoman Divacky /// associate it with a try landing pad block.
394f22ef01cSRoman Divacky void MachineModuleInfo::addInvoke(MachineBasicBlock *LandingPad,
395f22ef01cSRoman Divacky                                   MCSymbol *BeginLabel, MCSymbol *EndLabel) {
396f22ef01cSRoman Divacky   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
397f22ef01cSRoman Divacky   LP.BeginLabels.push_back(BeginLabel);
398f22ef01cSRoman Divacky   LP.EndLabels.push_back(EndLabel);
399f22ef01cSRoman Divacky }
400f22ef01cSRoman Divacky 
401f22ef01cSRoman Divacky /// addLandingPad - Provide the label of a try LandingPad block.
402f22ef01cSRoman Divacky ///
403f22ef01cSRoman Divacky MCSymbol *MachineModuleInfo::addLandingPad(MachineBasicBlock *LandingPad) {
404ff0cc061SDimitry Andric   MCSymbol *LandingPadLabel = Context.createTempSymbol();
405f22ef01cSRoman Divacky   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
406f22ef01cSRoman Divacky   LP.LandingPadLabel = LandingPadLabel;
407f22ef01cSRoman Divacky   return LandingPadLabel;
408f22ef01cSRoman Divacky }
409f22ef01cSRoman Divacky 
410f22ef01cSRoman Divacky /// addPersonality - Provide the personality function for the exception
411f22ef01cSRoman Divacky /// information.
412f22ef01cSRoman Divacky void MachineModuleInfo::addPersonality(MachineBasicBlock *LandingPad,
413f22ef01cSRoman Divacky                                        const Function *Personality) {
414f22ef01cSRoman Divacky   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
415f22ef01cSRoman Divacky   LP.Personality = Personality;
416f22ef01cSRoman Divacky 
417f22ef01cSRoman Divacky   for (unsigned i = 0; i < Personalities.size(); ++i)
418f22ef01cSRoman Divacky     if (Personalities[i] == Personality)
419f22ef01cSRoman Divacky       return;
420f22ef01cSRoman Divacky 
421f22ef01cSRoman Divacky   // If this is the first personality we're adding go
422f22ef01cSRoman Divacky   // ahead and add it at the beginning.
42391bc56edSDimitry Andric   if (!Personalities[0])
424f22ef01cSRoman Divacky     Personalities[0] = Personality;
425f22ef01cSRoman Divacky   else
426f22ef01cSRoman Divacky     Personalities.push_back(Personality);
427f22ef01cSRoman Divacky }
428f22ef01cSRoman Divacky 
429ff0cc061SDimitry Andric void MachineModuleInfo::addWinEHState(MachineBasicBlock *LandingPad,
430ff0cc061SDimitry Andric                                       int State) {
431ff0cc061SDimitry Andric   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
432ff0cc061SDimitry Andric   LP.WinEHState = State;
433ff0cc061SDimitry Andric }
434ff0cc061SDimitry Andric 
435f22ef01cSRoman Divacky /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
436f22ef01cSRoman Divacky ///
4376122f3e6SDimitry Andric void MachineModuleInfo::
4386122f3e6SDimitry Andric addCatchTypeInfo(MachineBasicBlock *LandingPad,
43939d628a0SDimitry Andric                  ArrayRef<const GlobalValue *> TyInfo) {
440f22ef01cSRoman Divacky   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
441f22ef01cSRoman Divacky   for (unsigned N = TyInfo.size(); N; --N)
442f22ef01cSRoman Divacky     LP.TypeIds.push_back(getTypeIDFor(TyInfo[N - 1]));
443f22ef01cSRoman Divacky }
444f22ef01cSRoman Divacky 
445f22ef01cSRoman Divacky /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
446f22ef01cSRoman Divacky ///
4476122f3e6SDimitry Andric void MachineModuleInfo::
4486122f3e6SDimitry Andric addFilterTypeInfo(MachineBasicBlock *LandingPad,
44939d628a0SDimitry Andric                   ArrayRef<const GlobalValue *> TyInfo) {
450f22ef01cSRoman Divacky   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
451f22ef01cSRoman Divacky   std::vector<unsigned> IdsInFilter(TyInfo.size());
452f22ef01cSRoman Divacky   for (unsigned I = 0, E = TyInfo.size(); I != E; ++I)
453f22ef01cSRoman Divacky     IdsInFilter[I] = getTypeIDFor(TyInfo[I]);
454f22ef01cSRoman Divacky   LP.TypeIds.push_back(getFilterIDFor(IdsInFilter));
455f22ef01cSRoman Divacky }
456f22ef01cSRoman Divacky 
457f22ef01cSRoman Divacky /// addCleanup - Add a cleanup action for a landing pad.
458f22ef01cSRoman Divacky ///
459f22ef01cSRoman Divacky void MachineModuleInfo::addCleanup(MachineBasicBlock *LandingPad) {
460f22ef01cSRoman Divacky   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
461f22ef01cSRoman Divacky   LP.TypeIds.push_back(0);
462f22ef01cSRoman Divacky }
463f22ef01cSRoman Divacky 
464ff0cc061SDimitry Andric void MachineModuleInfo::addSEHCatchHandler(MachineBasicBlock *LandingPad,
465ff0cc061SDimitry Andric                                            const Function *Filter,
466ff0cc061SDimitry Andric                                            const BlockAddress *RecoverBA) {
467ff0cc061SDimitry Andric   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
468ff0cc061SDimitry Andric   SEHHandler Handler;
469ff0cc061SDimitry Andric   Handler.FilterOrFinally = Filter;
470ff0cc061SDimitry Andric   Handler.RecoverBA = RecoverBA;
471ff0cc061SDimitry Andric   LP.SEHHandlers.push_back(Handler);
472ff0cc061SDimitry Andric }
473ff0cc061SDimitry Andric 
474ff0cc061SDimitry Andric void MachineModuleInfo::addSEHCleanupHandler(MachineBasicBlock *LandingPad,
475ff0cc061SDimitry Andric                                              const Function *Cleanup) {
476ff0cc061SDimitry Andric   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
477ff0cc061SDimitry Andric   SEHHandler Handler;
478ff0cc061SDimitry Andric   Handler.FilterOrFinally = Cleanup;
479ff0cc061SDimitry Andric   Handler.RecoverBA = nullptr;
480ff0cc061SDimitry Andric   LP.SEHHandlers.push_back(Handler);
481ff0cc061SDimitry Andric }
482ff0cc061SDimitry Andric 
483f22ef01cSRoman Divacky /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
484f22ef01cSRoman Divacky /// pads.
485f22ef01cSRoman Divacky void MachineModuleInfo::TidyLandingPads(DenseMap<MCSymbol*, uintptr_t> *LPMap) {
486f22ef01cSRoman Divacky   for (unsigned i = 0; i != LandingPads.size(); ) {
487f22ef01cSRoman Divacky     LandingPadInfo &LandingPad = LandingPads[i];
488f22ef01cSRoman Divacky     if (LandingPad.LandingPadLabel &&
489f22ef01cSRoman Divacky         !LandingPad.LandingPadLabel->isDefined() &&
490f22ef01cSRoman Divacky         (!LPMap || (*LPMap)[LandingPad.LandingPadLabel] == 0))
49191bc56edSDimitry Andric       LandingPad.LandingPadLabel = nullptr;
492f22ef01cSRoman Divacky 
493f22ef01cSRoman Divacky     // Special case: we *should* emit LPs with null LP MBB. This indicates
494f22ef01cSRoman Divacky     // "nounwind" case.
495f22ef01cSRoman Divacky     if (!LandingPad.LandingPadLabel && LandingPad.LandingPadBlock) {
496f22ef01cSRoman Divacky       LandingPads.erase(LandingPads.begin() + i);
497f22ef01cSRoman Divacky       continue;
498f22ef01cSRoman Divacky     }
499f22ef01cSRoman Divacky 
500f22ef01cSRoman Divacky     for (unsigned j = 0, e = LandingPads[i].BeginLabels.size(); j != e; ++j) {
501f22ef01cSRoman Divacky       MCSymbol *BeginLabel = LandingPad.BeginLabels[j];
502f22ef01cSRoman Divacky       MCSymbol *EndLabel = LandingPad.EndLabels[j];
503f22ef01cSRoman Divacky       if ((BeginLabel->isDefined() ||
504f22ef01cSRoman Divacky            (LPMap && (*LPMap)[BeginLabel] != 0)) &&
505f22ef01cSRoman Divacky           (EndLabel->isDefined() ||
506f22ef01cSRoman Divacky            (LPMap && (*LPMap)[EndLabel] != 0))) continue;
507f22ef01cSRoman Divacky 
508f22ef01cSRoman Divacky       LandingPad.BeginLabels.erase(LandingPad.BeginLabels.begin() + j);
509f22ef01cSRoman Divacky       LandingPad.EndLabels.erase(LandingPad.EndLabels.begin() + j);
510f22ef01cSRoman Divacky       --j, --e;
511f22ef01cSRoman Divacky     }
512f22ef01cSRoman Divacky 
513f22ef01cSRoman Divacky     // Remove landing pads with no try-ranges.
514f22ef01cSRoman Divacky     if (LandingPads[i].BeginLabels.empty()) {
515f22ef01cSRoman Divacky       LandingPads.erase(LandingPads.begin() + i);
516f22ef01cSRoman Divacky       continue;
517f22ef01cSRoman Divacky     }
518f22ef01cSRoman Divacky 
519f22ef01cSRoman Divacky     // If there is no landing pad, ensure that the list of typeids is empty.
520f22ef01cSRoman Divacky     // If the only typeid is a cleanup, this is the same as having no typeids.
521f22ef01cSRoman Divacky     if (!LandingPad.LandingPadBlock ||
522f22ef01cSRoman Divacky         (LandingPad.TypeIds.size() == 1 && !LandingPad.TypeIds[0]))
523f22ef01cSRoman Divacky       LandingPad.TypeIds.clear();
524f22ef01cSRoman Divacky     ++i;
525f22ef01cSRoman Divacky   }
526f22ef01cSRoman Divacky }
527f22ef01cSRoman Divacky 
5286122f3e6SDimitry Andric /// setCallSiteLandingPad - Map the landing pad's EH symbol to the call site
5296122f3e6SDimitry Andric /// indexes.
5306122f3e6SDimitry Andric void MachineModuleInfo::setCallSiteLandingPad(MCSymbol *Sym,
5316122f3e6SDimitry Andric                                               ArrayRef<unsigned> Sites) {
532dff0c46cSDimitry Andric   LPadToCallSiteMap[Sym].append(Sites.begin(), Sites.end());
5336122f3e6SDimitry Andric }
5346122f3e6SDimitry Andric 
535f22ef01cSRoman Divacky /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
536f22ef01cSRoman Divacky /// function wide.
53739d628a0SDimitry Andric unsigned MachineModuleInfo::getTypeIDFor(const GlobalValue *TI) {
538f22ef01cSRoman Divacky   for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
539f22ef01cSRoman Divacky     if (TypeInfos[i] == TI) return i + 1;
540f22ef01cSRoman Divacky 
541f22ef01cSRoman Divacky   TypeInfos.push_back(TI);
542f22ef01cSRoman Divacky   return TypeInfos.size();
543f22ef01cSRoman Divacky }
544f22ef01cSRoman Divacky 
545f22ef01cSRoman Divacky /// getFilterIDFor - Return the filter id for the specified typeinfos.  This is
546f22ef01cSRoman Divacky /// function wide.
547f22ef01cSRoman Divacky int MachineModuleInfo::getFilterIDFor(std::vector<unsigned> &TyIds) {
548f22ef01cSRoman Divacky   // If the new filter coincides with the tail of an existing filter, then
549f22ef01cSRoman Divacky   // re-use the existing filter.  Folding filters more than this requires
550f22ef01cSRoman Divacky   // re-ordering filters and/or their elements - probably not worth it.
551f22ef01cSRoman Divacky   for (std::vector<unsigned>::iterator I = FilterEnds.begin(),
552f22ef01cSRoman Divacky        E = FilterEnds.end(); I != E; ++I) {
553f22ef01cSRoman Divacky     unsigned i = *I, j = TyIds.size();
554f22ef01cSRoman Divacky 
555f22ef01cSRoman Divacky     while (i && j)
556f22ef01cSRoman Divacky       if (FilterIds[--i] != TyIds[--j])
557f22ef01cSRoman Divacky         goto try_next;
558f22ef01cSRoman Divacky 
559f22ef01cSRoman Divacky     if (!j)
560f22ef01cSRoman Divacky       // The new filter coincides with range [i, end) of the existing filter.
561f22ef01cSRoman Divacky       return -(1 + i);
562f22ef01cSRoman Divacky 
563f22ef01cSRoman Divacky try_next:;
564f22ef01cSRoman Divacky   }
565f22ef01cSRoman Divacky 
566f22ef01cSRoman Divacky   // Add the new filter.
567f22ef01cSRoman Divacky   int FilterID = -(1 + FilterIds.size());
568f22ef01cSRoman Divacky   FilterIds.reserve(FilterIds.size() + TyIds.size() + 1);
569dff0c46cSDimitry Andric   FilterIds.insert(FilterIds.end(), TyIds.begin(), TyIds.end());
570f22ef01cSRoman Divacky   FilterEnds.push_back(FilterIds.size());
571f22ef01cSRoman Divacky   FilterIds.push_back(0); // terminator
572f22ef01cSRoman Divacky   return FilterID;
573f22ef01cSRoman Divacky }
574f22ef01cSRoman Divacky 
575f22ef01cSRoman Divacky /// getPersonality - Return the personality function for the current function.
576f22ef01cSRoman Divacky const Function *MachineModuleInfo::getPersonality() const {
577ff0cc061SDimitry Andric   for (const LandingPadInfo &LPI : LandingPads)
578ff0cc061SDimitry Andric     if (LPI.Personality)
579ff0cc061SDimitry Andric       return LPI.Personality;
580ff0cc061SDimitry Andric   return nullptr;
581ff0cc061SDimitry Andric }
582ff0cc061SDimitry Andric 
583ff0cc061SDimitry Andric EHPersonality MachineModuleInfo::getPersonalityType() {
584ff0cc061SDimitry Andric   if (PersonalityTypeCache == EHPersonality::Unknown) {
585ff0cc061SDimitry Andric     if (const Function *F = getPersonality())
586ff0cc061SDimitry Andric       PersonalityTypeCache = classifyEHPersonality(F);
587ff0cc061SDimitry Andric   }
588ff0cc061SDimitry Andric   return PersonalityTypeCache;
589f22ef01cSRoman Divacky }
590f22ef01cSRoman Divacky 
591f22ef01cSRoman Divacky /// getPersonalityIndex - Return unique index for current personality
592f22ef01cSRoman Divacky /// function. NULL/first personality function should always get zero index.
593f22ef01cSRoman Divacky unsigned MachineModuleInfo::getPersonalityIndex() const {
59491bc56edSDimitry Andric   const Function* Personality = nullptr;
595f22ef01cSRoman Divacky 
596f22ef01cSRoman Divacky   // Scan landing pads. If there is at least one non-NULL personality - use it.
597dff0c46cSDimitry Andric   for (unsigned i = 0, e = LandingPads.size(); i != e; ++i)
598f22ef01cSRoman Divacky     if (LandingPads[i].Personality) {
599f22ef01cSRoman Divacky       Personality = LandingPads[i].Personality;
600f22ef01cSRoman Divacky       break;
601f22ef01cSRoman Divacky     }
602f22ef01cSRoman Divacky 
603dff0c46cSDimitry Andric   for (unsigned i = 0, e = Personalities.size(); i < e; ++i) {
604f22ef01cSRoman Divacky     if (Personalities[i] == Personality)
605f22ef01cSRoman Divacky       return i;
606f22ef01cSRoman Divacky   }
607f22ef01cSRoman Divacky 
608f22ef01cSRoman Divacky   // This will happen if the current personality function is
609f22ef01cSRoman Divacky   // in the zero index.
610f22ef01cSRoman Divacky   return 0;
611f22ef01cSRoman Divacky }
612ff0cc061SDimitry Andric 
613ff0cc061SDimitry Andric const Function *MachineModuleInfo::getWinEHParent(const Function *F) const {
614ff0cc061SDimitry Andric   StringRef WinEHParentName =
615ff0cc061SDimitry Andric       F->getFnAttribute("wineh-parent").getValueAsString();
616ff0cc061SDimitry Andric   if (WinEHParentName.empty() || WinEHParentName == F->getName())
617ff0cc061SDimitry Andric     return F;
618ff0cc061SDimitry Andric   return F->getParent()->getFunction(WinEHParentName);
619ff0cc061SDimitry Andric }
620ff0cc061SDimitry Andric 
621ff0cc061SDimitry Andric WinEHFuncInfo &MachineModuleInfo::getWinEHFuncInfo(const Function *F) {
622ff0cc061SDimitry Andric   auto &Ptr = FuncInfoMap[getWinEHParent(F)];
623ff0cc061SDimitry Andric   if (!Ptr)
624ff0cc061SDimitry Andric     Ptr.reset(new WinEHFuncInfo);
625ff0cc061SDimitry Andric   return *Ptr;
626ff0cc061SDimitry Andric }
627