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