Fix command-line option printing to print two spaces where needed,
[oota-llvm.git] / lib / Target / IA64 / IA64RegisterInfo.cpp
1 //===- IA64RegisterInfo.cpp - IA64 Register Information ---------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains the IA64 implementation of the TargetRegisterInfo class.
11 // This file is responsible for the frame pointer elimination optimization
12 // on IA64.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #include "IA64.h"
17 #include "IA64RegisterInfo.h"
18 #include "IA64InstrBuilder.h"
19 #include "IA64MachineFunctionInfo.h"
20 #include "llvm/Constants.h"
21 #include "llvm/Type.h"
22 #include "llvm/CodeGen/ValueTypes.h"
23 #include "llvm/CodeGen/MachineInstrBuilder.h"
24 #include "llvm/CodeGen/MachineFunction.h"
25 #include "llvm/CodeGen/MachineFrameInfo.h"
26 #include "llvm/CodeGen/MachineLocation.h"
27 #include "llvm/CodeGen/MachineRegisterInfo.h"
28 #include "llvm/Target/TargetFrameInfo.h"
29 #include "llvm/Target/TargetMachine.h"
30 #include "llvm/Target/TargetOptions.h"
31 #include "llvm/Target/TargetInstrInfo.h"
32 #include "llvm/ADT/BitVector.h"
33 #include "llvm/ADT/STLExtras.h"
34 using namespace llvm;
35
36 IA64RegisterInfo::IA64RegisterInfo(const TargetInstrInfo &tii)
37   : IA64GenRegisterInfo(IA64::ADJUSTCALLSTACKDOWN, IA64::ADJUSTCALLSTACKUP),
38     TII(tii) {}
39
40 const unsigned* IA64RegisterInfo::getCalleeSavedRegs(const MachineFunction *MF)
41                                                                          const {
42   static const unsigned CalleeSavedRegs[] = {
43     IA64::r5,  0
44   };
45   return CalleeSavedRegs;
46 }
47
48 const TargetRegisterClass* const*
49 IA64RegisterInfo::getCalleeSavedRegClasses(const MachineFunction *MF) const {
50   static const TargetRegisterClass * const CalleeSavedRegClasses[] = {
51     &IA64::GRRegClass,  0
52   };
53   return CalleeSavedRegClasses;
54 }
55
56 BitVector IA64RegisterInfo::getReservedRegs(const MachineFunction &MF) const {
57   BitVector Reserved(getNumRegs());
58   Reserved.set(IA64::r0);
59   Reserved.set(IA64::r1);
60   Reserved.set(IA64::r2);
61   Reserved.set(IA64::r5);
62   Reserved.set(IA64::r12);
63   Reserved.set(IA64::r13);
64   Reserved.set(IA64::r22);
65   Reserved.set(IA64::rp);
66   return Reserved;
67 }
68
69 //===----------------------------------------------------------------------===//
70 // Stack Frame Processing methods
71 //===----------------------------------------------------------------------===//
72
73 // hasFP - Return true if the specified function should have a dedicated frame
74 // pointer register.  This is true if the function has variable sized allocas or
75 // if frame pointer elimination is disabled.
76 //
77 bool IA64RegisterInfo::hasFP(const MachineFunction &MF) const {
78   const MachineFrameInfo *MFI = MF.getFrameInfo();
79   return NoFramePointerElim || MFI->hasVarSizedObjects();
80 }
81
82 void IA64RegisterInfo::
83 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
84                               MachineBasicBlock::iterator I) const {
85   if (hasFP(MF)) {
86     // If we have a frame pointer, turn the adjcallstackup instruction into a
87     // 'sub SP, <amt>' and the adjcallstackdown instruction into 'add SP,
88     // <amt>'
89     MachineInstr *Old = I;
90     unsigned Amount = Old->getOperand(0).getImm();
91     if (Amount != 0) {
92       // We need to keep the stack aligned properly.  To do this, we round the
93       // amount of space needed for the outgoing arguments up to the next
94       // alignment boundary.
95       unsigned Align = MF.getTarget().getFrameInfo()->getStackAlignment();
96       Amount = (Amount+Align-1)/Align*Align;
97
98       // Replace the pseudo instruction with a new instruction...
99       if (Old->getOpcode() == IA64::ADJUSTCALLSTACKDOWN) {
100         BuildMI(MBB, I, TII.get(IA64::ADDIMM22), IA64::r12).addReg(IA64::r12)
101           .addImm(-Amount);
102       } else {
103         assert(Old->getOpcode() == IA64::ADJUSTCALLSTACKUP);
104         BuildMI(MBB, I, TII.get(IA64::ADDIMM22), IA64::r12).addReg(IA64::r12)
105           .addImm(Amount);
106       }
107     }
108   }
109
110   MBB.erase(I);
111 }
112
113 void IA64RegisterInfo::eliminateFrameIndex(MachineBasicBlock::iterator II,
114                                            int SPAdj, RegScavenger *RS)const{
115   assert(SPAdj == 0 && "Unexpected");
116
117   unsigned i = 0;
118   MachineInstr &MI = *II;
119   MachineBasicBlock &MBB = *MI.getParent();
120   MachineFunction &MF = *MBB.getParent();
121
122   bool FP = hasFP(MF);
123
124   while (!MI.getOperand(i).isFI()) {
125     ++i;
126     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
127   }
128
129   int FrameIndex = MI.getOperand(i).getIndex();
130
131   // choose a base register: ( hasFP? framepointer : stack pointer )
132   unsigned BaseRegister = FP ? IA64::r5 : IA64::r12;
133   // Add the base register
134   MI.getOperand(i).ChangeToRegister(BaseRegister, false);
135
136   // Now add the frame object offset to the offset from r1.
137   int Offset = MF.getFrameInfo()->getObjectOffset(FrameIndex);
138
139   // If we're not using a Frame Pointer that has been set to the value of the
140   // SP before having the stack size subtracted from it, then add the stack size
141   // to Offset to get the correct offset.
142   Offset += MF.getFrameInfo()->getStackSize();
143
144   // XXX: we use 'r22' as another hack+slash temporary register here :(
145   if (Offset <= 8191 && Offset >= -8192) { // smallish offset
146     // Fix up the old:
147     MI.getOperand(i).ChangeToRegister(IA64::r22, false);
148     //insert the new
149     BuildMI(MBB, II, TII.get(IA64::ADDIMM22), IA64::r22)
150       .addReg(BaseRegister).addImm(Offset);
151   } else { // it's big
152     //fix up the old:
153     MI.getOperand(i).ChangeToRegister(IA64::r22, false);
154     BuildMI(MBB, II, TII.get(IA64::MOVLIMM64), IA64::r22).addImm(Offset);
155     BuildMI(MBB, II, TII.get(IA64::ADD), IA64::r22).addReg(BaseRegister)
156       .addReg(IA64::r22);
157   }
158
159 }
160
161 void IA64RegisterInfo::emitPrologue(MachineFunction &MF) const {
162   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
163   MachineBasicBlock::iterator MBBI = MBB.begin();
164   MachineFrameInfo *MFI = MF.getFrameInfo();
165   bool FP = hasFP(MF);
166
167   // first, we handle the 'alloc' instruction, that should be right up the
168   // top of any function
169   static const unsigned RegsInOrder[96] = { // there are 96 GPRs the
170                                             // RSE worries about
171         IA64::r32, IA64::r33, IA64::r34, IA64::r35,
172         IA64::r36, IA64::r37, IA64::r38, IA64::r39, IA64::r40, IA64::r41,
173         IA64::r42, IA64::r43, IA64::r44, IA64::r45, IA64::r46, IA64::r47,
174         IA64::r48, IA64::r49, IA64::r50, IA64::r51, IA64::r52, IA64::r53,
175         IA64::r54, IA64::r55, IA64::r56, IA64::r57, IA64::r58, IA64::r59,
176         IA64::r60, IA64::r61, IA64::r62, IA64::r63, IA64::r64, IA64::r65,
177         IA64::r66, IA64::r67, IA64::r68, IA64::r69, IA64::r70, IA64::r71,
178         IA64::r72, IA64::r73, IA64::r74, IA64::r75, IA64::r76, IA64::r77,
179         IA64::r78, IA64::r79, IA64::r80, IA64::r81, IA64::r82, IA64::r83,
180         IA64::r84, IA64::r85, IA64::r86, IA64::r87, IA64::r88, IA64::r89,
181         IA64::r90, IA64::r91, IA64::r92, IA64::r93, IA64::r94, IA64::r95,
182         IA64::r96, IA64::r97, IA64::r98, IA64::r99, IA64::r100, IA64::r101,
183         IA64::r102, IA64::r103, IA64::r104, IA64::r105, IA64::r106, IA64::r107,
184         IA64::r108, IA64::r109, IA64::r110, IA64::r111, IA64::r112, IA64::r113,
185         IA64::r114, IA64::r115, IA64::r116, IA64::r117, IA64::r118, IA64::r119,
186         IA64::r120, IA64::r121, IA64::r122, IA64::r123, IA64::r124, IA64::r125,
187         IA64::r126, IA64::r127 };
188
189   unsigned numStackedGPRsUsed=0;
190   for (int i=0; i != 96; i++) {
191     if (MF.getRegInfo().isPhysRegUsed(RegsInOrder[i]))
192       numStackedGPRsUsed=i+1; // (i+1 and not ++ - consider fn(fp, fp, int)
193   }
194
195   unsigned numOutRegsUsed=MF.getInfo<IA64FunctionInfo>()->outRegsUsed;
196
197   // XXX FIXME : this code should be a bit more reliable (in case there _isn't_
198   // a pseudo_alloc in the MBB)
199   unsigned dstRegOfPseudoAlloc;
200   for(MBBI = MBB.begin(); /*MBBI->getOpcode() != IA64::PSEUDO_ALLOC*/; ++MBBI) {
201     assert(MBBI != MBB.end());
202     if(MBBI->getOpcode() == IA64::PSEUDO_ALLOC) {
203       dstRegOfPseudoAlloc=MBBI->getOperand(0).getReg();
204       break;
205     }
206   }
207
208   BuildMI(MBB, MBBI, TII.get(IA64::ALLOC)).
209      addReg(dstRegOfPseudoAlloc).addImm(0).
210      addImm(numStackedGPRsUsed).addImm(numOutRegsUsed).addImm(0);
211
212   // Get the number of bytes to allocate from the FrameInfo
213   unsigned NumBytes = MFI->getStackSize();
214
215   if(FP)
216     NumBytes += 8; // reserve space for the old FP
217
218   // Do we need to allocate space on the stack?
219   if (NumBytes == 0)
220     return;
221
222   // Add 16 bytes at the bottom of the stack (scratch area)
223   // and round the size to a multiple of the alignment.
224   unsigned Align = MF.getTarget().getFrameInfo()->getStackAlignment();
225   unsigned Size = 16 + (FP ? 8 : 0);
226   NumBytes = (NumBytes+Size+Align-1)/Align*Align;
227
228   // Update frame info to pretend that this is part of the stack...
229   MFI->setStackSize(NumBytes);
230
231   // adjust stack pointer: r12 -= numbytes
232   if (NumBytes <= 8191) {
233     BuildMI(MBB, MBBI, TII.get(IA64::ADDIMM22),IA64::r12).addReg(IA64::r12).
234       addImm(-NumBytes);
235   } else { // we use r22 as a scratch register here
236     // first load the decrement into r22
237     BuildMI(MBB, MBBI, TII.get(IA64::MOVLIMM64), IA64::r22).addImm(-NumBytes);
238     // FIXME: MOVLSI32 expects a _u_32imm
239     // then add (subtract) it to r12 (stack ptr)
240     BuildMI(MBB, MBBI, TII.get(IA64::ADD), IA64::r12)
241       .addReg(IA64::r12).addReg(IA64::r22);
242     
243   }
244
245   // now if we need to, save the old FP and set the new
246   if (FP) {
247     BuildMI(MBB, MBBI, TII.get(IA64::ST8)).addReg(IA64::r12).addReg(IA64::r5);
248     // this must be the last instr in the prolog ?  (XXX: why??)
249     BuildMI(MBB, MBBI, TII.get(IA64::MOV), IA64::r5).addReg(IA64::r12);
250   }
251
252 }
253
254 void IA64RegisterInfo::emitEpilogue(MachineFunction &MF,
255                                    MachineBasicBlock &MBB) const {
256   const MachineFrameInfo *MFI = MF.getFrameInfo();
257   MachineBasicBlock::iterator MBBI = prior(MBB.end());
258   assert(MBBI->getOpcode() == IA64::RET &&
259          "Can only insert epilog into returning blocks");
260
261   bool FP = hasFP(MF);
262
263   // Get the number of bytes allocated from the FrameInfo...
264   unsigned NumBytes = MFI->getStackSize();
265
266   //now if we need to, restore the old FP
267   if (FP)
268   {
269     //copy the FP into the SP (discards allocas)
270     BuildMI(MBB, MBBI, TII.get(IA64::MOV), IA64::r12).addReg(IA64::r5);
271     //restore the FP
272     BuildMI(MBB, MBBI, TII.get(IA64::LD8), IA64::r5).addReg(IA64::r5);
273   }
274
275   if (NumBytes != 0)
276   {
277     if (NumBytes <= 8191) {
278       BuildMI(MBB, MBBI, TII.get(IA64::ADDIMM22),IA64::r12).addReg(IA64::r12).
279         addImm(NumBytes);
280     } else {
281       BuildMI(MBB, MBBI, TII.get(IA64::MOVLIMM64), IA64::r22).
282         addImm(NumBytes);
283       BuildMI(MBB, MBBI, TII.get(IA64::ADD), IA64::r12).addReg(IA64::r12).
284         addReg(IA64::r22);
285     }
286   }
287
288 }
289
290 unsigned IA64RegisterInfo::getRARegister() const {
291   assert(0 && "What is the return address register");
292   return 0;
293 }
294
295 unsigned IA64RegisterInfo::getFrameRegister(MachineFunction &MF) const {
296   return hasFP(MF) ? IA64::r5 : IA64::r12;
297 }
298
299 unsigned IA64RegisterInfo::getEHExceptionRegister() const {
300   assert(0 && "What is the exception register");
301   return 0;
302 }
303
304 unsigned IA64RegisterInfo::getEHHandlerRegister() const {
305   assert(0 && "What is the exception handler register");
306   return 0;
307 }
308
309 int IA64RegisterInfo::getDwarfRegNum(unsigned RegNum, bool isEH) const {
310   assert(0 && "What is the dwarf register number");
311   return -1;
312 }
313
314 #include "IA64GenRegisterInfo.inc"
315