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"
11 #include "llvm/ADT/ArrayRef.h"
12 #include "llvm/ADT/DenseMap.h"
13 #include "llvm/ADT/PostOrderIterator.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/ADT/TinyPtrVector.h"
16 #include "llvm/CodeGen/MachineFunction.h"
17 #include "llvm/CodeGen/Passes.h"
18 #include "llvm/IR/BasicBlock.h"
19 #include "llvm/IR/DerivedTypes.h"
20 #include "llvm/IR/Instructions.h"
21 #include "llvm/IR/Module.h"
22 #include "llvm/IR/Value.h"
23 #include "llvm/IR/ValueHandle.h"
24 #include "llvm/MC/MCContext.h"
25 #include "llvm/MC/MCSymbol.h"
26 #include "llvm/Pass.h"
27 #include "llvm/Support/Casting.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Target/TargetLoweringObjectFile.h"
30 #include "llvm/Target/TargetMachine.h"
38 using namespace llvm::dwarf;
40 // Handle the Pass registration stuff necessary to use DataLayout's.
41 INITIALIZE_PASS(MachineModuleInfo, "machinemoduleinfo",
42 "Machine Module Information", false, false)
43 char MachineModuleInfo::ID = 0;
45 // Out of line virtual method.
46 MachineModuleInfoImpl::~MachineModuleInfoImpl() = default;
50 class MMIAddrLabelMapCallbackPtr final : CallbackVH {
51 MMIAddrLabelMap *Map = nullptr;
54 MMIAddrLabelMapCallbackPtr() = default;
55 MMIAddrLabelMapCallbackPtr(Value *V) : CallbackVH(V) {}
57 void setPtr(BasicBlock *BB) {
58 ValueHandleBase::operator=(BB);
61 void setMap(MMIAddrLabelMap *map) { Map = map; }
63 void deleted() override;
64 void allUsesReplacedWith(Value *V2) override;
67 class MMIAddrLabelMap {
69 struct AddrLabelSymEntry {
70 /// The symbols for the label.
71 TinyPtrVector<MCSymbol *> Symbols;
73 Function *Fn; // The containing function of the BasicBlock.
74 unsigned Index; // The index in BBCallbacks for the BasicBlock.
77 DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry> AddrLabelSymbols;
79 /// Callbacks for the BasicBlock's that we have entries for. We use this so
80 /// we get notified if a block is deleted or RAUWd.
81 std::vector<MMIAddrLabelMapCallbackPtr> BBCallbacks;
83 /// This is a per-function list of symbols whose corresponding BasicBlock got
84 /// deleted. These symbols need to be emitted at some point in the file, so
85 /// AsmPrinter emits them after the function body.
86 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*>>
87 DeletedAddrLabelsNeedingEmission;
90 MMIAddrLabelMap(MCContext &context) : Context(context) {}
93 assert(DeletedAddrLabelsNeedingEmission.empty() &&
94 "Some labels for deleted blocks never got emitted");
97 ArrayRef<MCSymbol *> getAddrLabelSymbolToEmit(BasicBlock *BB);
99 void takeDeletedSymbolsForFunction(Function *F,
100 std::vector<MCSymbol*> &Result);
102 void UpdateForDeletedBlock(BasicBlock *BB);
103 void UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New);
106 } // end namespace llvm
108 ArrayRef<MCSymbol *> MMIAddrLabelMap::getAddrLabelSymbolToEmit(BasicBlock *BB) {
109 assert(BB->hasAddressTaken() &&
110 "Shouldn't get label for block without address taken");
111 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
113 // If we already had an entry for this block, just return it.
114 if (!Entry.Symbols.empty()) {
115 assert(BB->getParent() == Entry.Fn && "Parent changed");
116 return Entry.Symbols;
119 // Otherwise, this is a new entry, create a new symbol for it and add an
120 // entry to BBCallbacks so we can be notified if the BB is deleted or RAUWd.
121 BBCallbacks.emplace_back(BB);
122 BBCallbacks.back().setMap(this);
123 Entry.Index = BBCallbacks.size() - 1;
124 Entry.Fn = BB->getParent();
125 Entry.Symbols.push_back(Context.createTempSymbol());
126 return Entry.Symbols;
129 /// If we have any deleted symbols for F, return them.
130 void MMIAddrLabelMap::
131 takeDeletedSymbolsForFunction(Function *F, std::vector<MCSymbol*> &Result) {
132 DenseMap<AssertingVH<Function>, std::vector<MCSymbol*>>::iterator I =
133 DeletedAddrLabelsNeedingEmission.find(F);
135 // If there are no entries for the function, just return.
136 if (I == DeletedAddrLabelsNeedingEmission.end()) return;
138 // Otherwise, take the list.
139 std::swap(Result, I->second);
140 DeletedAddrLabelsNeedingEmission.erase(I);
143 void MMIAddrLabelMap::UpdateForDeletedBlock(BasicBlock *BB) {
144 // If the block got deleted, there is no need for the symbol. If the symbol
145 // was already emitted, we can just forget about it, otherwise we need to
146 // queue it up for later emission when the function is output.
147 AddrLabelSymEntry Entry = std::move(AddrLabelSymbols[BB]);
148 AddrLabelSymbols.erase(BB);
149 assert(!Entry.Symbols.empty() && "Didn't have a symbol, why a callback?");
150 BBCallbacks[Entry.Index] = nullptr; // Clear the callback.
152 assert((BB->getParent() == nullptr || BB->getParent() == Entry.Fn) &&
153 "Block/parent mismatch");
155 for (MCSymbol *Sym : Entry.Symbols) {
156 if (Sym->isDefined())
159 // If the block is not yet defined, we need to emit it at the end of the
160 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
161 // for the containing Function. Since the block is being deleted, its
162 // parent may already be removed, we have to get the function from 'Entry'.
163 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
167 void MMIAddrLabelMap::UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New) {
168 // Get the entry for the RAUW'd block and remove it from our map.
169 AddrLabelSymEntry OldEntry = std::move(AddrLabelSymbols[Old]);
170 AddrLabelSymbols.erase(Old);
171 assert(!OldEntry.Symbols.empty() && "Didn't have a symbol, why a callback?");
173 AddrLabelSymEntry &NewEntry = AddrLabelSymbols[New];
175 // If New is not address taken, just move our symbol over to it.
176 if (NewEntry.Symbols.empty()) {
177 BBCallbacks[OldEntry.Index].setPtr(New); // Update the callback.
178 NewEntry = std::move(OldEntry); // Set New's entry.
182 BBCallbacks[OldEntry.Index] = nullptr; // Update the callback.
184 // Otherwise, we need to add the old symbols to the new block's set.
185 NewEntry.Symbols.insert(NewEntry.Symbols.end(), OldEntry.Symbols.begin(),
186 OldEntry.Symbols.end());
189 void MMIAddrLabelMapCallbackPtr::deleted() {
190 Map->UpdateForDeletedBlock(cast<BasicBlock>(getValPtr()));
193 void MMIAddrLabelMapCallbackPtr::allUsesReplacedWith(Value *V2) {
194 Map->UpdateForRAUWBlock(cast<BasicBlock>(getValPtr()), cast<BasicBlock>(V2));
197 MachineModuleInfo::MachineModuleInfo(const LLVMTargetMachine *TM)
198 : ImmutablePass(ID), TM(*TM),
199 Context(TM->getMCAsmInfo(), TM->getMCRegisterInfo(),
200 TM->getObjFileLowering(), nullptr, false) {
201 initializeMachineModuleInfoPass(*PassRegistry::getPassRegistry());
204 MachineModuleInfo::~MachineModuleInfo() = default;
206 bool MachineModuleInfo::doInitialization(Module &M) {
207 ObjFileMMI = nullptr;
209 UsesVAFloatArgument = UsesMorestackAddr = false;
210 HasSplitStack = HasNosplitStack = false;
211 AddrLabelSymbols = nullptr;
213 DbgInfoAvailable = !empty(M.debug_compile_units());
217 bool MachineModuleInfo::doFinalization(Module &M) {
218 Personalities.clear();
220 delete AddrLabelSymbols;
221 AddrLabelSymbols = nullptr;
226 ObjFileMMI = nullptr;
231 //===- Address of Block Management ----------------------------------------===//
234 MachineModuleInfo::getAddrLabelSymbolToEmit(const BasicBlock *BB) {
235 // Lazily create AddrLabelSymbols.
236 if (!AddrLabelSymbols)
237 AddrLabelSymbols = new MMIAddrLabelMap(Context);
238 return AddrLabelSymbols->getAddrLabelSymbolToEmit(const_cast<BasicBlock*>(BB));
241 void MachineModuleInfo::
242 takeDeletedSymbolsForFunction(const Function *F,
243 std::vector<MCSymbol*> &Result) {
244 // If no blocks have had their addresses taken, we're done.
245 if (!AddrLabelSymbols) return;
246 return AddrLabelSymbols->
247 takeDeletedSymbolsForFunction(const_cast<Function*>(F), Result);
250 /// \name Exception Handling
253 void MachineModuleInfo::addPersonality(const Function *Personality) {
254 for (unsigned i = 0; i < Personalities.size(); ++i)
255 if (Personalities[i] == Personality)
257 Personalities.push_back(Personality);
263 MachineModuleInfo::getMachineFunction(const Function &F) const {
264 auto I = MachineFunctions.find(&F);
265 return I != MachineFunctions.end() ? I->second.get() : nullptr;
269 MachineModuleInfo::getOrCreateMachineFunction(const Function &F) {
270 // Shortcut for the common case where a sequence of MachineFunctionPasses
271 // all query for the same Function.
272 if (LastRequest == &F)
275 auto I = MachineFunctions.insert(
276 std::make_pair(&F, std::unique_ptr<MachineFunction>()));
279 // No pre-existing machine function, create a new one.
280 const TargetSubtargetInfo &STI = *TM.getSubtargetImpl(F);
281 MF = new MachineFunction(F, TM, STI, NextFnNum++, *this);
282 // Update the set entry.
283 I.first->second.reset(MF);
285 MF = I.first->second.get();
293 void MachineModuleInfo::deleteMachineFunctionFor(Function &F) {
294 MachineFunctions.erase(&F);
295 LastRequest = nullptr;
296 LastResult = nullptr;
301 /// This pass frees the MachineFunction object associated with a Function.
302 class FreeMachineFunction : public FunctionPass {
306 FreeMachineFunction() : FunctionPass(ID) {}
308 void getAnalysisUsage(AnalysisUsage &AU) const override {
309 AU.addRequired<MachineModuleInfo>();
310 AU.addPreserved<MachineModuleInfo>();
313 bool runOnFunction(Function &F) override {
314 MachineModuleInfo &MMI = getAnalysis<MachineModuleInfo>();
315 MMI.deleteMachineFunctionFor(F);
319 StringRef getPassName() const override {
320 return "Free MachineFunction";
324 } // end anonymous namespace
326 char FreeMachineFunction::ID;
328 FunctionPass *llvm::createFreeMachineFunctionPass() {
329 return new FreeMachineFunction();
332 //===- MMI building helpers -----------------------------------------------===//
334 void llvm::computeUsesVAFloatArgument(const CallInst &I,
335 MachineModuleInfo &MMI) {
337 cast<FunctionType>(I.getCalledValue()->getType()->getContainedType(0));
338 if (FT->isVarArg() && !MMI.usesVAFloatArgument()) {
339 for (unsigned i = 0, e = I.getNumArgOperands(); i != e; ++i) {
340 Type *T = I.getArgOperand(i)->getType();
341 for (auto i : post_order(T)) {
342 if (i->isFloatingPointTy()) {
343 MMI.setUsesVAFloatArgument(true);