1 //===-- MachineFunction.cpp -----------------------------------------------===//
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 // Collect native machine code information for a function. This allows
11 // target-specific information about the generated code to be stored with each
14 //===----------------------------------------------------------------------===//
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Function.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/Config/config.h"
21 #include "llvm/CodeGen/MachineConstantPool.h"
22 #include "llvm/CodeGen/MachineFunction.h"
23 #include "llvm/CodeGen/MachineFunctionPass.h"
24 #include "llvm/CodeGen/MachineFrameInfo.h"
25 #include "llvm/CodeGen/MachineInstr.h"
26 #include "llvm/CodeGen/MachineJumpTableInfo.h"
27 #include "llvm/CodeGen/MachineRegisterInfo.h"
28 #include "llvm/CodeGen/Passes.h"
29 #include "llvm/Target/TargetData.h"
30 #include "llvm/Target/TargetLowering.h"
31 #include "llvm/Target/TargetMachine.h"
32 #include "llvm/Target/TargetFrameInfo.h"
33 #include "llvm/Support/Compiler.h"
34 #include "llvm/Support/GraphWriter.h"
35 #include "llvm/Support/raw_ostream.h"
39 struct VISIBILITY_HIDDEN Printer : public MachineFunctionPass {
43 const std::string Banner;
45 Printer(raw_ostream &os, const std::string &banner)
46 : MachineFunctionPass(&ID), OS(os), Banner(banner) {}
48 const char *getPassName() const { return "MachineFunction Printer"; }
50 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
52 MachineFunctionPass::getAnalysisUsage(AU);
55 bool runOnMachineFunction(MachineFunction &MF) {
64 /// Returns a newly-created MachineFunction Printer pass. The default banner is
67 FunctionPass *llvm::createMachineFunctionPrinterPass(raw_ostream &OS,
68 const std::string &Banner){
69 return new Printer(OS, Banner);
72 //===---------------------------------------------------------------------===//
73 // MachineFunction implementation
74 //===---------------------------------------------------------------------===//
76 // Out of line virtual method.
77 MachineFunctionInfo::~MachineFunctionInfo() {}
79 void ilist_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
80 MBB->getParent()->DeleteMachineBasicBlock(MBB);
83 MachineFunction::MachineFunction(Function *F,
84 const TargetMachine &TM)
86 if (TM.getRegisterInfo())
87 RegInfo = new (Allocator.Allocate<MachineRegisterInfo>())
88 MachineRegisterInfo(*TM.getRegisterInfo());
92 FrameInfo = new (Allocator.Allocate<MachineFrameInfo>())
93 MachineFrameInfo(*TM.getFrameInfo());
94 ConstantPool = new (Allocator.Allocate<MachineConstantPool>())
95 MachineConstantPool(TM.getTargetData());
96 Alignment = TM.getTargetLowering()->getFunctionAlignment(F);
99 const TargetData &TD = *TM.getTargetData();
100 bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
101 unsigned EntrySize = IsPic ? 4 : TD.getPointerSize();
102 unsigned TyAlignment = IsPic ?
103 TD.getABITypeAlignment(Type::getInt32Ty(F->getContext()))
104 : TD.getPointerABIAlignment();
105 JumpTableInfo = new (Allocator.Allocate<MachineJumpTableInfo>())
106 MachineJumpTableInfo(EntrySize, TyAlignment);
109 MachineFunction::~MachineFunction() {
111 InstructionRecycler.clear(Allocator);
112 BasicBlockRecycler.clear(Allocator);
114 RegInfo->~MachineRegisterInfo();
115 Allocator.Deallocate(RegInfo);
118 MFInfo->~MachineFunctionInfo();
119 Allocator.Deallocate(MFInfo);
121 FrameInfo->~MachineFrameInfo(); Allocator.Deallocate(FrameInfo);
122 ConstantPool->~MachineConstantPool(); Allocator.Deallocate(ConstantPool);
123 JumpTableInfo->~MachineJumpTableInfo(); Allocator.Deallocate(JumpTableInfo);
127 /// RenumberBlocks - This discards all of the MachineBasicBlock numbers and
128 /// recomputes them. This guarantees that the MBB numbers are sequential,
129 /// dense, and match the ordering of the blocks within the function. If a
130 /// specific MachineBasicBlock is specified, only that block and those after
131 /// it are renumbered.
132 void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
133 if (empty()) { MBBNumbering.clear(); return; }
134 MachineFunction::iterator MBBI, E = end();
140 // Figure out the block number this should have.
141 unsigned BlockNo = 0;
143 BlockNo = prior(MBBI)->getNumber()+1;
145 for (; MBBI != E; ++MBBI, ++BlockNo) {
146 if (MBBI->getNumber() != (int)BlockNo) {
147 // Remove use of the old number.
148 if (MBBI->getNumber() != -1) {
149 assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
150 "MBB number mismatch!");
151 MBBNumbering[MBBI->getNumber()] = 0;
154 // If BlockNo is already taken, set that block's number to -1.
155 if (MBBNumbering[BlockNo])
156 MBBNumbering[BlockNo]->setNumber(-1);
158 MBBNumbering[BlockNo] = MBBI;
159 MBBI->setNumber(BlockNo);
163 // Okay, all the blocks are renumbered. If we have compactified the block
164 // numbering, shrink MBBNumbering now.
165 assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
166 MBBNumbering.resize(BlockNo);
169 /// CreateMachineInstr - Allocate a new MachineInstr. Use this instead
170 /// of `new MachineInstr'.
173 MachineFunction::CreateMachineInstr(const TargetInstrDesc &TID,
174 DebugLoc DL, bool NoImp) {
175 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
176 MachineInstr(TID, DL, NoImp);
179 /// CloneMachineInstr - Create a new MachineInstr which is a copy of the
180 /// 'Orig' instruction, identical in all ways except the the instruction
181 /// has no parent, prev, or next.
184 MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
185 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
186 MachineInstr(*this, *Orig);
189 /// DeleteMachineInstr - Delete the given MachineInstr.
192 MachineFunction::DeleteMachineInstr(MachineInstr *MI) {
194 InstructionRecycler.Deallocate(Allocator, MI);
197 /// CreateMachineBasicBlock - Allocate a new MachineBasicBlock. Use this
198 /// instead of `new MachineBasicBlock'.
201 MachineFunction::CreateMachineBasicBlock(const BasicBlock *bb) {
202 return new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
203 MachineBasicBlock(*this, bb);
206 /// DeleteMachineBasicBlock - Delete the given MachineBasicBlock.
209 MachineFunction::DeleteMachineBasicBlock(MachineBasicBlock *MBB) {
210 assert(MBB->getParent() == this && "MBB parent mismatch!");
211 MBB->~MachineBasicBlock();
212 BasicBlockRecycler.Deallocate(Allocator, MBB);
216 MachineFunction::getMachineMemOperand(const Value *v, unsigned f,
217 int64_t o, uint64_t s,
218 unsigned base_alignment) {
219 return new (Allocator.Allocate<MachineMemOperand>())
220 MachineMemOperand(v, f, o, s, base_alignment);
224 MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
225 int64_t Offset, uint64_t Size) {
226 return new (Allocator.Allocate<MachineMemOperand>())
227 MachineMemOperand(MMO->getValue(), MMO->getFlags(),
228 int64_t(uint64_t(MMO->getOffset()) +
230 Size, MMO->getBaseAlignment());
233 MachineInstr::mmo_iterator
234 MachineFunction::allocateMemRefsArray(unsigned long Num) {
235 return Allocator.Allocate<MachineMemOperand *>(Num);
238 void MachineFunction::dump() const {
242 void MachineFunction::print(raw_ostream &OS) const {
243 OS << "# Machine code for " << Fn->getName() << "():\n";
245 // Print Frame Information
246 FrameInfo->print(*this, OS);
248 // Print JumpTable Information
249 JumpTableInfo->print(OS);
251 // Print Constant Pool
252 ConstantPool->print(OS);
254 const TargetRegisterInfo *TRI = getTarget().getRegisterInfo();
256 if (RegInfo && !RegInfo->livein_empty()) {
258 for (MachineRegisterInfo::livein_iterator
259 I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
261 OS << " " << TRI->getName(I->first);
263 OS << " Reg #" << I->first;
266 OS << " in VR#" << I->second << ' ';
270 if (RegInfo && !RegInfo->liveout_empty()) {
272 for (MachineRegisterInfo::liveout_iterator
273 I = RegInfo->liveout_begin(), E = RegInfo->liveout_end(); I != E; ++I)
275 OS << ' ' << TRI->getName(*I);
277 OS << " Reg #" << *I;
281 for (const_iterator BB = begin(), E = end(); BB != E; ++BB)
284 OS << "\n# End machine code for " << Fn->getName() << "().\n\n";
289 struct DOTGraphTraits<const MachineFunction*> : public DefaultDOTGraphTraits {
290 static std::string getGraphName(const MachineFunction *F) {
291 return "CFG for '" + F->getFunction()->getNameStr() + "' function";
294 static std::string getNodeLabel(const MachineBasicBlock *Node,
295 const MachineFunction *Graph,
297 if (ShortNames && Node->getBasicBlock() &&
298 !Node->getBasicBlock()->getName().empty())
299 return Node->getBasicBlock()->getNameStr() + ":";
303 raw_string_ostream OSS(OutStr);
306 OSS << Node->getNumber() << ':';
311 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
313 // Process string output to make it nicer...
314 for (unsigned i = 0; i != OutStr.length(); ++i)
315 if (OutStr[i] == '\n') { // Left justify
317 OutStr.insert(OutStr.begin()+i+1, 'l');
324 void MachineFunction::viewCFG() const
327 ViewGraph(this, "mf" + getFunction()->getNameStr());
329 errs() << "SelectionDAG::viewGraph is only available in debug builds on "
330 << "systems with Graphviz or gv!\n";
334 void MachineFunction::viewCFGOnly() const
337 ViewGraph(this, "mf" + getFunction()->getNameStr(), true);
339 errs() << "SelectionDAG::viewGraph is only available in debug builds on "
340 << "systems with Graphviz or gv!\n";
344 /// addLiveIn - Add the specified physical register as a live-in value and
345 /// create a corresponding virtual register for it.
346 unsigned MachineFunction::addLiveIn(unsigned PReg,
347 const TargetRegisterClass *RC) {
348 assert(RC->contains(PReg) && "Not the correct regclass!");
349 unsigned VReg = getRegInfo().createVirtualRegister(RC);
350 getRegInfo().addLiveIn(PReg, VReg);
354 /// getOrCreateDebugLocID - Look up the DebugLocTuple index with the given
355 /// source file, line, and column. If none currently exists, create a new
356 /// DebugLocTuple, and insert it into the DebugIdMap.
357 unsigned MachineFunction::getOrCreateDebugLocID(MDNode *CompileUnit,
358 unsigned Line, unsigned Col) {
359 DebugLocTuple Tuple(CompileUnit, Line, Col);
360 DenseMap<DebugLocTuple, unsigned>::iterator II
361 = DebugLocInfo.DebugIdMap.find(Tuple);
362 if (II != DebugLocInfo.DebugIdMap.end())
365 unsigned Id = DebugLocInfo.DebugLocations.size();
366 DebugLocInfo.DebugLocations.push_back(Tuple);
367 DebugLocInfo.DebugIdMap[Tuple] = Id;
371 /// getDebugLocTuple - Get the DebugLocTuple for a given DebugLoc object.
372 DebugLocTuple MachineFunction::getDebugLocTuple(DebugLoc DL) const {
373 unsigned Idx = DL.getIndex();
374 assert(Idx < DebugLocInfo.DebugLocations.size() &&
375 "Invalid index into debug locations!");
376 return DebugLocInfo.DebugLocations[Idx];
379 //===----------------------------------------------------------------------===//
380 // MachineFrameInfo implementation
381 //===----------------------------------------------------------------------===//
383 /// CreateFixedObject - Create a new object at a fixed location on the stack.
384 /// All fixed objects should be created before other objects are created for
385 /// efficiency. By default, fixed objects are immutable. This returns an
386 /// index with a negative value.
388 int MachineFrameInfo::CreateFixedObject(uint64_t Size, int64_t SPOffset,
390 assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
391 Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset, Immutable));
392 return -++NumFixedObjects;
397 MachineFrameInfo::getPristineRegs(const MachineBasicBlock *MBB) const {
398 assert(MBB && "MBB must be valid");
399 const MachineFunction *MF = MBB->getParent();
400 assert(MF && "MBB must be part of a MachineFunction");
401 const TargetMachine &TM = MF->getTarget();
402 const TargetRegisterInfo *TRI = TM.getRegisterInfo();
403 BitVector BV(TRI->getNumRegs());
405 // Before CSI is calculated, no registers are considered pristine. They can be
406 // freely used and PEI will make sure they are saved.
407 if (!isCalleeSavedInfoValid())
410 for (const unsigned *CSR = TRI->getCalleeSavedRegs(MF); CSR && *CSR; ++CSR)
413 // The entry MBB always has all CSRs pristine.
414 if (MBB == &MF->front())
417 // On other MBBs the saved CSRs are not pristine.
418 const std::vector<CalleeSavedInfo> &CSI = getCalleeSavedInfo();
419 for (std::vector<CalleeSavedInfo>::const_iterator I = CSI.begin(),
420 E = CSI.end(); I != E; ++I)
421 BV.reset(I->getReg());
427 void MachineFrameInfo::print(const MachineFunction &MF, raw_ostream &OS) const{
428 const TargetFrameInfo *FI = MF.getTarget().getFrameInfo();
429 int ValOffset = (FI ? FI->getOffsetOfLocalArea() : 0);
431 for (unsigned i = 0, e = Objects.size(); i != e; ++i) {
432 const StackObject &SO = Objects[i];
433 OS << " <fi#" << (int)(i-NumFixedObjects) << ">: ";
434 if (SO.Size == ~0ULL) {
439 OS << "variable sized";
441 OS << "size is " << SO.Size << " byte" << (SO.Size != 1 ? "s," : ",");
442 OS << " alignment is " << SO.Alignment << " byte"
443 << (SO.Alignment != 1 ? "s," : ",");
445 if (i < NumFixedObjects)
447 if (i < NumFixedObjects || SO.SPOffset != -1) {
448 int64_t Off = SO.SPOffset - ValOffset;
449 OS << " at location [SP";
459 if (HasVarSizedObjects)
460 OS << " Stack frame contains variable sized objects\n";
463 void MachineFrameInfo::dump(const MachineFunction &MF) const {
467 //===----------------------------------------------------------------------===//
468 // MachineJumpTableInfo implementation
469 //===----------------------------------------------------------------------===//
471 /// getJumpTableIndex - Create a new jump table entry in the jump table info
472 /// or return an existing one.
474 unsigned MachineJumpTableInfo::getJumpTableIndex(
475 const std::vector<MachineBasicBlock*> &DestBBs) {
476 assert(!DestBBs.empty() && "Cannot create an empty jump table!");
477 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i)
478 if (JumpTables[i].MBBs == DestBBs)
481 JumpTables.push_back(MachineJumpTableEntry(DestBBs));
482 return JumpTables.size()-1;
485 /// ReplaceMBBInJumpTables - If Old is the target of any jump tables, update
486 /// the jump tables to branch to New instead.
488 MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
489 MachineBasicBlock *New) {
490 assert(Old != New && "Not making a change?");
491 bool MadeChange = false;
492 for (size_t i = 0, e = JumpTables.size(); i != e; ++i) {
493 MachineJumpTableEntry &JTE = JumpTables[i];
494 for (size_t j = 0, e = JTE.MBBs.size(); j != e; ++j)
495 if (JTE.MBBs[j] == Old) {
503 void MachineJumpTableInfo::print(raw_ostream &OS) const {
504 // FIXME: this is lame, maybe we could print out the MBB numbers or something
505 // like {1, 2, 4, 5, 3, 0}
506 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
507 OS << " <jt#" << i << "> has " << JumpTables[i].MBBs.size()
512 void MachineJumpTableInfo::dump() const { print(errs()); }
515 //===----------------------------------------------------------------------===//
516 // MachineConstantPool implementation
517 //===----------------------------------------------------------------------===//
519 const Type *MachineConstantPoolEntry::getType() const {
520 if (isMachineConstantPoolEntry())
521 return Val.MachineCPVal->getType();
522 return Val.ConstVal->getType();
526 unsigned MachineConstantPoolEntry::getRelocationInfo() const {
527 if (isMachineConstantPoolEntry())
528 return Val.MachineCPVal->getRelocationInfo();
529 return Val.ConstVal->getRelocationInfo();
532 MachineConstantPool::~MachineConstantPool() {
533 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
534 if (Constants[i].isMachineConstantPoolEntry())
535 delete Constants[i].Val.MachineCPVal;
538 /// getConstantPoolIndex - Create a new entry in the constant pool or return
539 /// an existing one. User must specify the log2 of the minimum required
540 /// alignment for the object.
542 unsigned MachineConstantPool::getConstantPoolIndex(Constant *C,
543 unsigned Alignment) {
544 assert(Alignment && "Alignment must be specified!");
545 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
547 // Check to see if we already have this constant.
549 // FIXME, this could be made much more efficient for large constant pools.
550 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
551 if (Constants[i].Val.ConstVal == C &&
552 (Constants[i].getAlignment() & (Alignment - 1)) == 0)
555 Constants.push_back(MachineConstantPoolEntry(C, Alignment));
556 return Constants.size()-1;
559 unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
560 unsigned Alignment) {
561 assert(Alignment && "Alignment must be specified!");
562 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
564 // Check to see if we already have this constant.
566 // FIXME, this could be made much more efficient for large constant pools.
567 int Idx = V->getExistingMachineCPValue(this, Alignment);
569 return (unsigned)Idx;
571 Constants.push_back(MachineConstantPoolEntry(V, Alignment));
572 return Constants.size()-1;
575 void MachineConstantPool::print(raw_ostream &OS) const {
576 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
577 OS << " <cp#" << i << "> is";
578 if (Constants[i].isMachineConstantPoolEntry())
579 Constants[i].Val.MachineCPVal->print(OS);
581 OS << *(Value*)Constants[i].Val.ConstVal;
582 OS << " , alignment=" << Constants[i].getAlignment();
587 void MachineConstantPool::dump() const { print(errs()); }