333711b80b1cd62602c3cb94c1de11e1dba7e76c
[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 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/BitVector.h"
32 #include "llvm/ADT/STLExtras.h"
33 using namespace llvm;
34
35 IA64RegisterInfo::IA64RegisterInfo(const TargetInstrInfo &tii)
36   : IA64GenRegisterInfo(IA64::ADJUSTCALLSTACKDOWN, IA64::ADJUSTCALLSTACKUP),
37     TII(tii) {}
38
39 void IA64RegisterInfo::storeRegToStackSlot(MachineBasicBlock &MBB,
40                                            MachineBasicBlock::iterator MI,
41                                            unsigned SrcReg, bool isKill,
42                                            int FrameIdx,
43                                            const TargetRegisterClass *RC) const{
44
45   if (RC == IA64::FPRegisterClass) {
46     BuildMI(MBB, MI, TII.get(IA64::STF_SPILL)).addFrameIndex(FrameIdx)
47       .addReg(SrcReg, false, false, isKill);
48   } else if (RC == IA64::GRRegisterClass) {
49     BuildMI(MBB, MI, TII.get(IA64::ST8)).addFrameIndex(FrameIdx)
50       .addReg(SrcReg, false, false, isKill);
51   } else if (RC == IA64::PRRegisterClass) {
52     /* we use IA64::r2 as a temporary register for doing this hackery. */
53     // first we load 0:
54     BuildMI(MBB, MI, TII.get(IA64::MOV), IA64::r2).addReg(IA64::r0);
55     // then conditionally add 1:
56     BuildMI(MBB, MI, TII.get(IA64::CADDIMM22), IA64::r2).addReg(IA64::r2)
57       .addImm(1).addReg(SrcReg, false, false, isKill);
58     // and then store it to the stack
59     BuildMI(MBB, MI, TII.get(IA64::ST8)).addFrameIndex(FrameIdx).addReg(IA64::r2);
60   } else assert(0 &&
61       "sorry, I don't know how to store this sort of reg in the stack\n");
62 }
63
64 void IA64RegisterInfo::storeRegToAddr(MachineFunction &MF, unsigned SrcReg,
65                                       bool isKill,
66                                       SmallVectorImpl<MachineOperand> &Addr,
67                                       const TargetRegisterClass *RC,
68                                  SmallVectorImpl<MachineInstr*> &NewMIs) const {
69   unsigned Opc = 0;
70   if (RC == IA64::FPRegisterClass) {
71     Opc = IA64::STF8;
72   } else if (RC == IA64::GRRegisterClass) {
73     Opc = IA64::ST8;
74   } else if (RC == IA64::PRRegisterClass) {
75     Opc = IA64::ST1;
76   } else {
77     assert(0 &&
78       "sorry, I don't know how to store this sort of reg\n");
79   }
80
81   MachineInstrBuilder MIB = BuildMI(TII.get(Opc));
82   for (unsigned i = 0, e = Addr.size(); i != e; ++i) {
83     MachineOperand &MO = Addr[i];
84     if (MO.isRegister())
85       MIB.addReg(MO.getReg());
86     else if (MO.isImmediate())
87       MIB.addImm(MO.getImm());
88     else
89       MIB.addFrameIndex(MO.getFrameIndex());
90   }
91   MIB.addReg(SrcReg, false, false, isKill);
92   NewMIs.push_back(MIB);
93   return;
94
95 }
96
97 void IA64RegisterInfo::loadRegFromStackSlot(MachineBasicBlock &MBB,
98                                             MachineBasicBlock::iterator MI,
99                                             unsigned DestReg, int FrameIdx,
100                                             const TargetRegisterClass *RC)const{
101
102   if (RC == IA64::FPRegisterClass) {
103     BuildMI(MBB, MI, TII.get(IA64::LDF_FILL), DestReg).addFrameIndex(FrameIdx);
104   } else if (RC == IA64::GRRegisterClass) {
105     BuildMI(MBB, MI, TII.get(IA64::LD8), DestReg).addFrameIndex(FrameIdx);
106  } else if (RC == IA64::PRRegisterClass) {
107    // first we load a byte from the stack into r2, our 'predicate hackery'
108    // scratch reg
109    BuildMI(MBB, MI, TII.get(IA64::LD8), IA64::r2).addFrameIndex(FrameIdx);
110    // then we compare it to zero. If it _is_ zero, compare-not-equal to
111    // r0 gives us 0, which is what we want, so that's nice.
112    BuildMI(MBB, MI, TII.get(IA64::CMPNE), DestReg).addReg(IA64::r2).addReg(IA64::r0);
113  } else assert(0 &&
114      "sorry, I don't know how to load this sort of reg from the stack\n");
115 }
116
117 void IA64RegisterInfo::loadRegFromAddr(MachineFunction &MF, unsigned DestReg,
118                                        SmallVectorImpl<MachineOperand> &Addr,
119                                        const TargetRegisterClass *RC,
120                                  SmallVectorImpl<MachineInstr*> &NewMIs) const {
121   unsigned Opc = 0;
122   if (RC == IA64::FPRegisterClass) {
123     Opc = IA64::LDF8;
124   } else if (RC == IA64::GRRegisterClass) {
125     Opc = IA64::LD8;
126   } else if (RC == IA64::PRRegisterClass) {
127     Opc = IA64::LD1;
128   } else {
129     assert(0 &&
130       "sorry, I don't know how to store this sort of reg\n");
131   }
132
133   MachineInstrBuilder MIB = BuildMI(TII.get(Opc), DestReg);
134   for (unsigned i = 0, e = Addr.size(); i != e; ++i) {
135     MachineOperand &MO = Addr[i];
136     if (MO.isRegister())
137       MIB.addReg(MO.getReg());
138     else if (MO.isImmediate())
139       MIB.addImm(MO.getImm());
140     else
141       MIB.addFrameIndex(MO.getFrameIndex());
142   }
143   NewMIs.push_back(MIB);
144   return;
145 }
146
147 void IA64RegisterInfo::copyRegToReg(MachineBasicBlock &MBB,
148                                    MachineBasicBlock::iterator MI,
149                                    unsigned DestReg, unsigned SrcReg,
150                                    const TargetRegisterClass *DestRC,
151                                    const TargetRegisterClass *SrcRC) const {
152   if (DestRC != SrcRC) {
153     cerr << "Not yet supported!";
154     abort();
155   }
156
157   if(DestRC == IA64::PRRegisterClass ) // if a bool, we use pseudocode
158     // (SrcReg) DestReg = cmp.eq.unc(r0, r0)
159     BuildMI(MBB, MI, TII.get(IA64::PCMPEQUNC), DestReg)
160       .addReg(IA64::r0).addReg(IA64::r0).addReg(SrcReg);
161   else // otherwise, MOV works (for both gen. regs and FP regs)
162     BuildMI(MBB, MI, TII.get(IA64::MOV), DestReg).addReg(SrcReg);
163 }
164
165 void IA64RegisterInfo::reMaterialize(MachineBasicBlock &MBB,
166                                      MachineBasicBlock::iterator I,
167                                      unsigned DestReg,
168                                      const MachineInstr *Orig) const {
169   MachineInstr *MI = Orig->clone();
170   MI->getOperand(0).setReg(DestReg);
171   MBB.insert(I, MI);
172 }
173
174 const unsigned* IA64RegisterInfo::getCalleeSavedRegs(const MachineFunction *MF)
175                                                                          const {
176   static const unsigned CalleeSavedRegs[] = {
177     IA64::r5,  0
178   };
179   return CalleeSavedRegs;
180 }
181
182 const TargetRegisterClass* const*
183 IA64RegisterInfo::getCalleeSavedRegClasses(const MachineFunction *MF) const {
184   static const TargetRegisterClass * const CalleeSavedRegClasses[] = {
185     &IA64::GRRegClass,  0
186   };
187   return CalleeSavedRegClasses;
188 }
189
190 BitVector IA64RegisterInfo::getReservedRegs(const MachineFunction &MF) const {
191   BitVector Reserved(getNumRegs());
192   Reserved.set(IA64::r0);
193   Reserved.set(IA64::r1);
194   Reserved.set(IA64::r2);
195   Reserved.set(IA64::r5);
196   Reserved.set(IA64::r12);
197   Reserved.set(IA64::r13);
198   Reserved.set(IA64::r22);
199   Reserved.set(IA64::rp);
200   return Reserved;
201 }
202
203 //===----------------------------------------------------------------------===//
204 // Stack Frame Processing methods
205 //===----------------------------------------------------------------------===//
206
207 // hasFP - Return true if the specified function should have a dedicated frame
208 // pointer register.  This is true if the function has variable sized allocas or
209 // if frame pointer elimination is disabled.
210 //
211 bool IA64RegisterInfo::hasFP(const MachineFunction &MF) const {
212   return NoFramePointerElim || MF.getFrameInfo()->hasVarSizedObjects();
213 }
214
215 void IA64RegisterInfo::
216 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
217                               MachineBasicBlock::iterator I) const {
218   if (hasFP(MF)) {
219     // If we have a frame pointer, turn the adjcallstackup instruction into a
220     // 'sub SP, <amt>' and the adjcallstackdown instruction into 'add SP,
221     // <amt>'
222     MachineInstr *Old = I;
223     unsigned Amount = Old->getOperand(0).getImm();
224     if (Amount != 0) {
225       // We need to keep the stack aligned properly.  To do this, we round the
226       // amount of space needed for the outgoing arguments up to the next
227       // alignment boundary.
228       unsigned Align = MF.getTarget().getFrameInfo()->getStackAlignment();
229       Amount = (Amount+Align-1)/Align*Align;
230
231       MachineInstr *New;
232       if (Old->getOpcode() == IA64::ADJUSTCALLSTACKDOWN) {
233         New=BuildMI(TII.get(IA64::ADDIMM22), IA64::r12).addReg(IA64::r12)
234           .addImm(-Amount);
235       } else {
236         assert(Old->getOpcode() == IA64::ADJUSTCALLSTACKUP);
237         New=BuildMI(TII.get(IA64::ADDIMM22), IA64::r12).addReg(IA64::r12)
238           .addImm(Amount);
239       }
240
241       // Replace the pseudo instruction with a new instruction...
242       MBB.insert(I, New);
243     }
244   }
245
246   MBB.erase(I);
247 }
248
249 void IA64RegisterInfo::eliminateFrameIndex(MachineBasicBlock::iterator II,
250                                            int SPAdj, RegScavenger *RS)const{
251   assert(SPAdj == 0 && "Unexpected");
252
253   unsigned i = 0;
254   MachineInstr &MI = *II;
255   MachineBasicBlock &MBB = *MI.getParent();
256   MachineFunction &MF = *MBB.getParent();
257
258   bool FP = hasFP(MF);
259
260   while (!MI.getOperand(i).isFrameIndex()) {
261     ++i;
262     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
263   }
264
265   int FrameIndex = MI.getOperand(i).getFrameIndex();
266
267   // choose a base register: ( hasFP? framepointer : stack pointer )
268   unsigned BaseRegister = FP ? IA64::r5 : IA64::r12;
269   // Add the base register
270   MI.getOperand(i).ChangeToRegister(BaseRegister, false);
271
272   // Now add the frame object offset to the offset from r1.
273   int Offset = MF.getFrameInfo()->getObjectOffset(FrameIndex);
274
275   // If we're not using a Frame Pointer that has been set to the value of the
276   // SP before having the stack size subtracted from it, then add the stack size
277   // to Offset to get the correct offset.
278   Offset += MF.getFrameInfo()->getStackSize();
279
280   // XXX: we use 'r22' as another hack+slash temporary register here :(
281   if (Offset <= 8191 && Offset >= -8192) { // smallish offset
282     // Fix up the old:
283     MI.getOperand(i).ChangeToRegister(IA64::r22, false);
284     //insert the new
285     MachineInstr* nMI=BuildMI(TII.get(IA64::ADDIMM22), IA64::r22)
286       .addReg(BaseRegister).addImm(Offset);
287     MBB.insert(II, nMI);
288   } else { // it's big
289     //fix up the old:
290     MI.getOperand(i).ChangeToRegister(IA64::r22, false);
291     MachineInstr* nMI;
292     nMI=BuildMI(TII.get(IA64::MOVLIMM64), IA64::r22).addImm(Offset);
293     MBB.insert(II, nMI);
294     nMI=BuildMI(TII.get(IA64::ADD), IA64::r22).addReg(BaseRegister)
295       .addReg(IA64::r22);
296     MBB.insert(II, nMI);
297   }
298
299 }
300
301 void IA64RegisterInfo::emitPrologue(MachineFunction &MF) const {
302   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
303   MachineBasicBlock::iterator MBBI = MBB.begin();
304   MachineFrameInfo *MFI = MF.getFrameInfo();
305   MachineInstr *MI;
306   bool FP = hasFP(MF);
307
308   // first, we handle the 'alloc' instruction, that should be right up the
309   // top of any function
310   static const unsigned RegsInOrder[96] = { // there are 96 GPRs the
311                                             // RSE worries about
312         IA64::r32, IA64::r33, IA64::r34, IA64::r35,
313         IA64::r36, IA64::r37, IA64::r38, IA64::r39, IA64::r40, IA64::r41,
314         IA64::r42, IA64::r43, IA64::r44, IA64::r45, IA64::r46, IA64::r47,
315         IA64::r48, IA64::r49, IA64::r50, IA64::r51, IA64::r52, IA64::r53,
316         IA64::r54, IA64::r55, IA64::r56, IA64::r57, IA64::r58, IA64::r59,
317         IA64::r60, IA64::r61, IA64::r62, IA64::r63, IA64::r64, IA64::r65,
318         IA64::r66, IA64::r67, IA64::r68, IA64::r69, IA64::r70, IA64::r71,
319         IA64::r72, IA64::r73, IA64::r74, IA64::r75, IA64::r76, IA64::r77,
320         IA64::r78, IA64::r79, IA64::r80, IA64::r81, IA64::r82, IA64::r83,
321         IA64::r84, IA64::r85, IA64::r86, IA64::r87, IA64::r88, IA64::r89,
322         IA64::r90, IA64::r91, IA64::r92, IA64::r93, IA64::r94, IA64::r95,
323         IA64::r96, IA64::r97, IA64::r98, IA64::r99, IA64::r100, IA64::r101,
324         IA64::r102, IA64::r103, IA64::r104, IA64::r105, IA64::r106, IA64::r107,
325         IA64::r108, IA64::r109, IA64::r110, IA64::r111, IA64::r112, IA64::r113,
326         IA64::r114, IA64::r115, IA64::r116, IA64::r117, IA64::r118, IA64::r119,
327         IA64::r120, IA64::r121, IA64::r122, IA64::r123, IA64::r124, IA64::r125,
328         IA64::r126, IA64::r127 };
329
330   unsigned numStackedGPRsUsed=0;
331   for(int i=0; i<96; i++) {
332     if(MF.isPhysRegUsed(RegsInOrder[i]))
333       numStackedGPRsUsed=i+1; // (i+1 and not ++ - consider fn(fp, fp, int)
334   }
335
336   unsigned numOutRegsUsed=MF.getInfo<IA64FunctionInfo>()->outRegsUsed;
337
338   // XXX FIXME : this code should be a bit more reliable (in case there _isn't_
339   // a pseudo_alloc in the MBB)
340   unsigned dstRegOfPseudoAlloc;
341   for(MBBI = MBB.begin(); /*MBBI->getOpcode() != IA64::PSEUDO_ALLOC*/; ++MBBI) {
342     assert(MBBI != MBB.end());
343     if(MBBI->getOpcode() == IA64::PSEUDO_ALLOC) {
344       dstRegOfPseudoAlloc=MBBI->getOperand(0).getReg();
345       break;
346     }
347   }
348
349   MI=BuildMI(TII.get(IA64::ALLOC)).addReg(dstRegOfPseudoAlloc).addImm(0).  \
350      addImm(numStackedGPRsUsed).addImm(numOutRegsUsed).addImm(0);
351   MBB.insert(MBBI, MI);
352
353   // Get the number of bytes to allocate from the FrameInfo
354   unsigned NumBytes = MFI->getStackSize();
355
356   if(FP)
357     NumBytes += 8; // reserve space for the old FP
358
359   // Do we need to allocate space on the stack?
360   if (NumBytes == 0)
361     return;
362
363   // Add 16 bytes at the bottom of the stack (scratch area)
364   // and round the size to a multiple of the alignment.
365   unsigned Align = MF.getTarget().getFrameInfo()->getStackAlignment();
366   unsigned Size = 16 + (FP ? 8 : 0);
367   NumBytes = (NumBytes+Size+Align-1)/Align*Align;
368
369   // Update frame info to pretend that this is part of the stack...
370   MFI->setStackSize(NumBytes);
371
372   // adjust stack pointer: r12 -= numbytes
373   if (NumBytes <= 8191) {
374     MI=BuildMI(TII.get(IA64::ADDIMM22),IA64::r12).addReg(IA64::r12).
375       addImm(-NumBytes);
376     MBB.insert(MBBI, MI);
377   } else { // we use r22 as a scratch register here
378     MI=BuildMI(TII.get(IA64::MOVLIMM64), IA64::r22).addImm(-NumBytes);
379     // FIXME: MOVLSI32 expects a _u_32imm
380     MBB.insert(MBBI, MI);  // first load the decrement into r22
381     MI=BuildMI(TII.get(IA64::ADD), IA64::r12).addReg(IA64::r12).addReg(IA64::r22);
382     MBB.insert(MBBI, MI);  // then add (subtract) it to r12 (stack ptr)
383   }
384
385   // now if we need to, save the old FP and set the new
386   if (FP) {
387     MI = BuildMI(TII.get(IA64::ST8)).addReg(IA64::r12).addReg(IA64::r5);
388     MBB.insert(MBBI, MI);
389     // this must be the last instr in the prolog ?  (XXX: why??)
390     MI = BuildMI(TII.get(IA64::MOV), IA64::r5).addReg(IA64::r12);
391     MBB.insert(MBBI, MI);
392   }
393
394 }
395
396 void IA64RegisterInfo::emitEpilogue(MachineFunction &MF,
397                                    MachineBasicBlock &MBB) const {
398   const MachineFrameInfo *MFI = MF.getFrameInfo();
399   MachineBasicBlock::iterator MBBI = prior(MBB.end());
400   MachineInstr *MI;
401   assert(MBBI->getOpcode() == IA64::RET &&
402          "Can only insert epilog into returning blocks");
403
404   bool FP = hasFP(MF);
405
406   // Get the number of bytes allocated from the FrameInfo...
407   unsigned NumBytes = MFI->getStackSize();
408
409   //now if we need to, restore the old FP
410   if (FP)
411   {
412     //copy the FP into the SP (discards allocas)
413     MI=BuildMI(TII.get(IA64::MOV), IA64::r12).addReg(IA64::r5);
414     MBB.insert(MBBI, MI);
415     //restore the FP
416     MI=BuildMI(TII.get(IA64::LD8), IA64::r5).addReg(IA64::r5);
417     MBB.insert(MBBI, MI);
418   }
419
420   if (NumBytes != 0)
421   {
422     if (NumBytes <= 8191) {
423       MI=BuildMI(TII.get(IA64::ADDIMM22),IA64::r12).addReg(IA64::r12).
424         addImm(NumBytes);
425       MBB.insert(MBBI, MI);
426     } else {
427       MI=BuildMI(TII.get(IA64::MOVLIMM64), IA64::r22).addImm(NumBytes);
428       MBB.insert(MBBI, MI);
429       MI=BuildMI(TII.get(IA64::ADD), IA64::r12).addReg(IA64::r12).
430         addReg(IA64::r22);
431       MBB.insert(MBBI, MI);
432     }
433   }
434
435 }
436
437 unsigned IA64RegisterInfo::getRARegister() const {
438   assert(0 && "What is the return address register");
439   return 0;
440 }
441
442 unsigned IA64RegisterInfo::getFrameRegister(MachineFunction &MF) const {
443   return hasFP(MF) ? IA64::r5 : IA64::r12;
444 }
445
446 unsigned IA64RegisterInfo::getEHExceptionRegister() const {
447   assert(0 && "What is the exception register");
448   return 0;
449 }
450
451 unsigned IA64RegisterInfo::getEHHandlerRegister() const {
452   assert(0 && "What is the exception handler register");
453   return 0;
454 }
455
456 int IA64RegisterInfo::getDwarfRegNum(unsigned RegNum, bool isEH) const {
457   assert(0 && "What is the dwarf register number");
458   return -1;
459 }
460
461 #include "IA64GenRegisterInfo.inc"
462