Re-sort includes with sort-includes.py and insert raw_ostream.h where it's used.
[oota-llvm.git] / lib / Target / Mips / Mips16InstrInfo.cpp
1 //===-- Mips16InstrInfo.cpp - Mips16 Instruction Information --------------===//
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 Mips16 implementation of the TargetInstrInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13 #include "Mips16InstrInfo.h"
14 #include "InstPrinter/MipsInstPrinter.h"
15 #include "MipsMachineFunction.h"
16 #include "MipsTargetMachine.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/CodeGen/MachineInstrBuilder.h"
20 #include "llvm/CodeGen/MachineRegisterInfo.h"
21 #include "llvm/CodeGen/RegisterScavenging.h"
22 #include "llvm/MC/MCAsmInfo.h"
23 #include "llvm/Support/CommandLine.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/ErrorHandling.h"
26 #include "llvm/Support/TargetRegistry.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include <cctype>
29
30 using namespace llvm;
31
32 #define DEBUG_TYPE "mips16-instrinfo"
33
34 Mips16InstrInfo::Mips16InstrInfo(const MipsSubtarget &STI)
35     : MipsInstrInfo(STI, Mips::Bimm16), RI() {}
36
37 const MipsRegisterInfo &Mips16InstrInfo::getRegisterInfo() const {
38   return RI;
39 }
40
41 /// isLoadFromStackSlot - If the specified machine instruction is a direct
42 /// load from a stack slot, return the virtual or physical register number of
43 /// the destination along with the FrameIndex of the loaded stack slot.  If
44 /// not, return 0.  This predicate must return 0 if the instruction has
45 /// any side effects other than loading from the stack slot.
46 unsigned Mips16InstrInfo::isLoadFromStackSlot(const MachineInstr *MI,
47                                               int &FrameIndex) const {
48   return 0;
49 }
50
51 /// isStoreToStackSlot - If the specified machine instruction is a direct
52 /// store to a stack slot, return the virtual or physical register number of
53 /// the source reg along with the FrameIndex of the loaded stack slot.  If
54 /// not, return 0.  This predicate must return 0 if the instruction has
55 /// any side effects other than storing to the stack slot.
56 unsigned Mips16InstrInfo::isStoreToStackSlot(const MachineInstr *MI,
57                                              int &FrameIndex) const {
58   return 0;
59 }
60
61 void Mips16InstrInfo::copyPhysReg(MachineBasicBlock &MBB,
62                                   MachineBasicBlock::iterator I, DebugLoc DL,
63                                   unsigned DestReg, unsigned SrcReg,
64                                   bool KillSrc) const {
65   unsigned Opc = 0;
66
67   if (Mips::CPU16RegsRegClass.contains(DestReg) &&
68       Mips::GPR32RegClass.contains(SrcReg))
69     Opc = Mips::MoveR3216;
70   else if (Mips::GPR32RegClass.contains(DestReg) &&
71            Mips::CPU16RegsRegClass.contains(SrcReg))
72     Opc = Mips::Move32R16;
73   else if ((SrcReg == Mips::HI0) &&
74            (Mips::CPU16RegsRegClass.contains(DestReg)))
75     Opc = Mips::Mfhi16, SrcReg = 0;
76
77   else if ((SrcReg == Mips::LO0) &&
78            (Mips::CPU16RegsRegClass.contains(DestReg)))
79     Opc = Mips::Mflo16, SrcReg = 0;
80
81
82   assert(Opc && "Cannot copy registers");
83
84   MachineInstrBuilder MIB = BuildMI(MBB, I, DL, get(Opc));
85
86   if (DestReg)
87     MIB.addReg(DestReg, RegState::Define);
88
89   if (SrcReg)
90     MIB.addReg(SrcReg, getKillRegState(KillSrc));
91 }
92
93 void Mips16InstrInfo::storeRegToStack(MachineBasicBlock &MBB,
94                                       MachineBasicBlock::iterator I,
95                                       unsigned SrcReg, bool isKill, int FI,
96                                       const TargetRegisterClass *RC,
97                                       const TargetRegisterInfo *TRI,
98                                       int64_t Offset) const {
99   DebugLoc DL;
100   if (I != MBB.end()) DL = I->getDebugLoc();
101   MachineMemOperand *MMO = GetMemOperand(MBB, FI, MachineMemOperand::MOStore);
102   unsigned Opc = 0;
103   if (Mips::CPU16RegsRegClass.hasSubClassEq(RC))
104     Opc = Mips::SwRxSpImmX16;
105   assert(Opc && "Register class not handled!");
106   BuildMI(MBB, I, DL, get(Opc)).addReg(SrcReg, getKillRegState(isKill)).
107       addFrameIndex(FI).addImm(Offset)
108       .addMemOperand(MMO);
109 }
110
111 void Mips16InstrInfo::loadRegFromStack(MachineBasicBlock &MBB,
112                                        MachineBasicBlock::iterator I,
113                                        unsigned DestReg, int FI,
114                                        const TargetRegisterClass *RC,
115                                        const TargetRegisterInfo *TRI,
116                                        int64_t Offset) const {
117   DebugLoc DL;
118   if (I != MBB.end()) DL = I->getDebugLoc();
119   MachineMemOperand *MMO = GetMemOperand(MBB, FI, MachineMemOperand::MOLoad);
120   unsigned Opc = 0;
121
122   if (Mips::CPU16RegsRegClass.hasSubClassEq(RC))
123     Opc = Mips::LwRxSpImmX16;
124   assert(Opc && "Register class not handled!");
125   BuildMI(MBB, I, DL, get(Opc), DestReg).addFrameIndex(FI).addImm(Offset)
126     .addMemOperand(MMO);
127 }
128
129 bool Mips16InstrInfo::expandPostRAPseudo(MachineBasicBlock::iterator MI) const {
130   MachineBasicBlock &MBB = *MI->getParent();
131   switch(MI->getDesc().getOpcode()) {
132   default:
133     return false;
134   case Mips::RetRA16:
135     ExpandRetRA16(MBB, MI, Mips::JrcRa16);
136     break;
137   }
138
139   MBB.erase(MI);
140   return true;
141 }
142
143 /// GetOppositeBranchOpc - Return the inverse of the specified
144 /// opcode, e.g. turning BEQ to BNE.
145 unsigned Mips16InstrInfo::getOppositeBranchOpc(unsigned Opc) const {
146   switch (Opc) {
147   case Mips::BeqzRxImmX16: return Mips::BnezRxImmX16;
148   case Mips::BnezRxImmX16: return Mips::BeqzRxImmX16;
149   case Mips::BeqzRxImm16: return Mips::BnezRxImm16;
150   case Mips::BnezRxImm16: return Mips::BeqzRxImm16;
151   case Mips::BteqzT8CmpX16: return Mips::BtnezT8CmpX16;
152   case Mips::BteqzT8SltX16: return Mips::BtnezT8SltX16;
153   case Mips::BteqzT8SltiX16: return Mips::BtnezT8SltiX16;
154   case Mips::Btnez16: return Mips::Bteqz16;
155   case Mips::BtnezX16: return Mips::BteqzX16;
156   case Mips::BtnezT8CmpiX16: return Mips::BteqzT8CmpiX16;
157   case Mips::BtnezT8SltuX16: return Mips::BteqzT8SltuX16;
158   case Mips::BtnezT8SltiuX16: return Mips::BteqzT8SltiuX16;
159   case Mips::Bteqz16: return Mips::Btnez16;
160   case Mips::BteqzX16: return Mips::BtnezX16;
161   case Mips::BteqzT8CmpiX16: return Mips::BtnezT8CmpiX16;
162   case Mips::BteqzT8SltuX16: return Mips::BtnezT8SltuX16;
163   case Mips::BteqzT8SltiuX16: return Mips::BtnezT8SltiuX16;
164   case Mips::BtnezT8CmpX16: return Mips::BteqzT8CmpX16;
165   case Mips::BtnezT8SltX16: return Mips::BteqzT8SltX16;
166   case Mips::BtnezT8SltiX16: return Mips::BteqzT8SltiX16;
167   }
168   llvm_unreachable("Illegal opcode!");
169 }
170
171 static void addSaveRestoreRegs(MachineInstrBuilder &MIB,
172                                const std::vector<CalleeSavedInfo> &CSI,
173                                unsigned Flags = 0) {
174   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
175     // Add the callee-saved register as live-in. Do not add if the register is
176     // RA and return address is taken, because it has already been added in
177     // method MipsTargetLowering::LowerRETURNADDR.
178     // It's killed at the spill, unless the register is RA and return address
179     // is taken.
180     unsigned Reg = CSI[e-i-1].getReg();
181     switch (Reg) {
182     case Mips::RA:
183     case Mips::S0:
184     case Mips::S1:
185       MIB.addReg(Reg, Flags);
186       break;
187     case Mips::S2:
188       break;
189     default:
190       llvm_unreachable("unexpected mips16 callee saved register");
191
192     }
193   }
194 }
195 // Adjust SP by FrameSize bytes. Save RA, S0, S1
196 void Mips16InstrInfo::makeFrame(unsigned SP, int64_t FrameSize,
197                                 MachineBasicBlock &MBB,
198                                 MachineBasicBlock::iterator I) const {
199   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
200   MachineFunction &MF = *MBB.getParent();
201   MachineFrameInfo *MFI    = MF.getFrameInfo();
202   const BitVector Reserved = RI.getReservedRegs(MF);
203   bool SaveS2 = Reserved[Mips::S2];
204   MachineInstrBuilder MIB;
205   unsigned Opc = ((FrameSize <= 128) && !SaveS2)? Mips::Save16:Mips::SaveX16;
206   MIB = BuildMI(MBB, I, DL, get(Opc));
207   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
208   addSaveRestoreRegs(MIB, CSI);
209   if (SaveS2)
210     MIB.addReg(Mips::S2);
211   if (isUInt<11>(FrameSize))
212     MIB.addImm(FrameSize);
213   else {
214     int Base = 2040; // should create template function like isUInt that
215                      // returns largest possible n bit unsigned integer
216     int64_t Remainder = FrameSize - Base;
217     MIB.addImm(Base);
218     if (isInt<16>(-Remainder))
219       BuildAddiuSpImm(MBB, I, -Remainder);
220     else
221       adjustStackPtrBig(SP, -Remainder, MBB, I, Mips::V0, Mips::V1);
222   }
223 }
224
225 // Adjust SP by FrameSize bytes. Restore RA, S0, S1
226 void Mips16InstrInfo::restoreFrame(unsigned SP, int64_t FrameSize,
227                                    MachineBasicBlock &MBB,
228                                    MachineBasicBlock::iterator I) const {
229   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
230   MachineFunction *MF = MBB.getParent();
231   MachineFrameInfo *MFI    = MF->getFrameInfo();
232   const BitVector Reserved = RI.getReservedRegs(*MF);
233   bool SaveS2 = Reserved[Mips::S2];
234   MachineInstrBuilder MIB;
235   unsigned Opc = ((FrameSize <= 128) && !SaveS2)?
236     Mips::Restore16:Mips::RestoreX16;
237
238   if (!isUInt<11>(FrameSize)) {
239     unsigned Base = 2040;
240     int64_t Remainder = FrameSize - Base;
241     FrameSize = Base; // should create template function like isUInt that
242                      // returns largest possible n bit unsigned integer
243
244     if (isInt<16>(Remainder))
245       BuildAddiuSpImm(MBB, I, Remainder);
246     else
247       adjustStackPtrBig(SP, Remainder, MBB, I, Mips::A0, Mips::A1);
248   }
249   MIB = BuildMI(MBB, I, DL, get(Opc));
250   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
251   addSaveRestoreRegs(MIB, CSI, RegState::Define);
252   if (SaveS2)
253     MIB.addReg(Mips::S2, RegState::Define);
254   MIB.addImm(FrameSize);
255 }
256
257 // Adjust SP by Amount bytes where bytes can be up to 32bit number.
258 // This can only be called at times that we know that there is at least one free
259 // register.
260 // This is clearly safe at prologue and epilogue.
261 //
262 void Mips16InstrInfo::adjustStackPtrBig(unsigned SP, int64_t Amount,
263                                         MachineBasicBlock &MBB,
264                                         MachineBasicBlock::iterator I,
265                                         unsigned Reg1, unsigned Reg2) const {
266   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
267   //
268   // li reg1, constant
269   // move reg2, sp
270   // add reg1, reg1, reg2
271   // move sp, reg1
272   //
273   //
274   MachineInstrBuilder MIB1 = BuildMI(MBB, I, DL, get(Mips::LwConstant32), Reg1);
275   MIB1.addImm(Amount).addImm(-1);
276   MachineInstrBuilder MIB2 = BuildMI(MBB, I, DL, get(Mips::MoveR3216), Reg2);
277   MIB2.addReg(Mips::SP, RegState::Kill);
278   MachineInstrBuilder MIB3 = BuildMI(MBB, I, DL, get(Mips::AdduRxRyRz16), Reg1);
279   MIB3.addReg(Reg1);
280   MIB3.addReg(Reg2, RegState::Kill);
281   MachineInstrBuilder MIB4 = BuildMI(MBB, I, DL, get(Mips::Move32R16),
282                                                      Mips::SP);
283   MIB4.addReg(Reg1, RegState::Kill);
284 }
285
286 void Mips16InstrInfo::adjustStackPtrBigUnrestricted(
287     unsigned SP, int64_t Amount, MachineBasicBlock &MBB,
288     MachineBasicBlock::iterator I) const {
289    llvm_unreachable("adjust stack pointer amount exceeded");
290 }
291
292 /// Adjust SP by Amount bytes.
293 void Mips16InstrInfo::adjustStackPtr(unsigned SP, int64_t Amount,
294                                      MachineBasicBlock &MBB,
295                                      MachineBasicBlock::iterator I) const {
296   if (isInt<16>(Amount))  // need to change to addiu sp, ....and isInt<16>
297     BuildAddiuSpImm(MBB, I, Amount);
298   else
299     adjustStackPtrBigUnrestricted(SP, Amount, MBB, I);
300 }
301
302 /// This function generates the sequence of instructions needed to get the
303 /// result of adding register REG and immediate IMM.
304 unsigned Mips16InstrInfo::loadImmediate(unsigned FrameReg, int64_t Imm,
305                                         MachineBasicBlock &MBB,
306                                         MachineBasicBlock::iterator II,
307                                         DebugLoc DL, unsigned &NewImm) const {
308   //
309   // given original instruction is:
310   // Instr rx, T[offset] where offset is too big.
311   //
312   // lo = offset & 0xFFFF
313   // hi = ((offset >> 16) + (lo >> 15)) & 0xFFFF;
314   //
315   // let T = temporary register
316   // li T, hi
317   // shl T, 16
318   // add T, Rx, T
319   //
320   RegScavenger rs;
321   int32_t lo = Imm & 0xFFFF;
322   NewImm = lo;
323   int Reg =0;
324   int SpReg = 0;
325
326   rs.enterBasicBlock(&MBB);
327   rs.forward(II);
328   //
329   // We need to know which registers can be used, in the case where there
330   // are not enough free registers. We exclude all registers that
331   // are used in the instruction that we are helping.
332   //  // Consider all allocatable registers in the register class initially
333   BitVector Candidates =
334       RI.getAllocatableSet
335       (*II->getParent()->getParent(), &Mips::CPU16RegsRegClass);
336   // Exclude all the registers being used by the instruction.
337   for (unsigned i = 0, e = II->getNumOperands(); i != e; ++i) {
338     MachineOperand &MO = II->getOperand(i);
339     if (MO.isReg() && MO.getReg() != 0 && !MO.isDef() &&
340         !TargetRegisterInfo::isVirtualRegister(MO.getReg()))
341       Candidates.reset(MO.getReg());
342   }
343
344   // If the same register was used and defined in an instruction, then
345   // it will not be in the list of candidates.
346   //
347   // we need to analyze the instruction that we are helping.
348   // we need to know if it defines register x but register x is not
349   // present as an operand of the instruction. this tells
350   // whether the register is live before the instruction. if it's not
351   // then we don't need to save it in case there are no free registers.
352   int DefReg = 0;
353   for (unsigned i = 0, e = II->getNumOperands(); i != e; ++i) {
354     MachineOperand &MO = II->getOperand(i);
355     if (MO.isReg() && MO.isDef()) {
356       DefReg = MO.getReg();
357       break;
358     }
359   }
360
361   BitVector Available = rs.getRegsAvailable(&Mips::CPU16RegsRegClass);
362   Available &= Candidates;
363   //
364   // we use T0 for the first register, if we need to save something away.
365   // we use T1 for the second register, if we need to save something away.
366   //
367   unsigned FirstRegSaved =0, SecondRegSaved=0;
368   unsigned FirstRegSavedTo = 0, SecondRegSavedTo = 0;
369
370   Reg = Available.find_first();
371
372   if (Reg == -1) {
373     Reg = Candidates.find_first();
374     Candidates.reset(Reg);
375     if (DefReg != Reg) {
376       FirstRegSaved = Reg;
377       FirstRegSavedTo = Mips::T0;
378       copyPhysReg(MBB, II, DL, FirstRegSavedTo, FirstRegSaved, true);
379     }
380   }
381   else
382     Available.reset(Reg);
383   BuildMI(MBB, II, DL, get(Mips::LwConstant32), Reg).addImm(Imm).addImm(-1);
384   NewImm = 0;
385   if (FrameReg == Mips::SP) {
386     SpReg = Available.find_first();
387     if (SpReg == -1) {
388       SpReg = Candidates.find_first();
389       // Candidates.reset(SpReg); // not really needed
390       if (DefReg!= SpReg) {
391         SecondRegSaved = SpReg;
392         SecondRegSavedTo = Mips::T1;
393       }
394       if (SecondRegSaved)
395         copyPhysReg(MBB, II, DL, SecondRegSavedTo, SecondRegSaved, true);
396     }
397    else
398      Available.reset(SpReg);
399     copyPhysReg(MBB, II, DL, SpReg, Mips::SP, false);
400     BuildMI(MBB, II, DL, get(Mips::  AdduRxRyRz16), Reg).addReg(SpReg, RegState::Kill)
401       .addReg(Reg);
402   }
403   else
404     BuildMI(MBB, II, DL, get(Mips::  AdduRxRyRz16), Reg).addReg(FrameReg)
405       .addReg(Reg, RegState::Kill);
406   if (FirstRegSaved || SecondRegSaved) {
407     II = std::next(II);
408     if (FirstRegSaved)
409       copyPhysReg(MBB, II, DL, FirstRegSaved, FirstRegSavedTo, true);
410     if (SecondRegSaved)
411       copyPhysReg(MBB, II, DL, SecondRegSaved, SecondRegSavedTo, true);
412   }
413   return Reg;
414 }
415
416 unsigned Mips16InstrInfo::getAnalyzableBrOpc(unsigned Opc) const {
417   return (Opc == Mips::BeqzRxImmX16   || Opc == Mips::BimmX16  ||
418           Opc == Mips::Bimm16  ||
419           Opc == Mips::Bteqz16        || Opc == Mips::Btnez16 ||
420           Opc == Mips::BeqzRxImm16    || Opc == Mips::BnezRxImm16   ||
421           Opc == Mips::BnezRxImmX16   || Opc == Mips::BteqzX16 ||
422           Opc == Mips::BteqzT8CmpX16  || Opc == Mips::BteqzT8CmpiX16 ||
423           Opc == Mips::BteqzT8SltX16  || Opc == Mips::BteqzT8SltuX16  ||
424           Opc == Mips::BteqzT8SltiX16 || Opc == Mips::BteqzT8SltiuX16 ||
425           Opc == Mips::BtnezX16       || Opc == Mips::BtnezT8CmpX16 ||
426           Opc == Mips::BtnezT8CmpiX16 || Opc == Mips::BtnezT8SltX16 ||
427           Opc == Mips::BtnezT8SltuX16 || Opc == Mips::BtnezT8SltiX16 ||
428           Opc == Mips::BtnezT8SltiuX16 ) ? Opc : 0;
429 }
430
431 void Mips16InstrInfo::ExpandRetRA16(MachineBasicBlock &MBB,
432                                   MachineBasicBlock::iterator I,
433                                   unsigned Opc) const {
434   BuildMI(MBB, I, I->getDebugLoc(), get(Opc));
435 }
436
437 const MCInstrDesc &Mips16InstrInfo::AddiuSpImm(int64_t Imm) const {
438   if (validSpImm8(Imm))
439     return get(Mips::AddiuSpImm16);
440   else
441     return get(Mips::AddiuSpImmX16);
442 }
443
444 void Mips16InstrInfo::BuildAddiuSpImm
445   (MachineBasicBlock &MBB, MachineBasicBlock::iterator I, int64_t Imm) const {
446   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
447   BuildMI(MBB, I, DL, AddiuSpImm(Imm)).addImm(Imm);
448 }
449
450 const MipsInstrInfo *llvm::createMips16InstrInfo(const MipsSubtarget &STI) {
451   return new Mips16InstrInfo(STI);
452 }
453
454 bool Mips16InstrInfo::validImmediate(unsigned Opcode, unsigned Reg,
455                                      int64_t Amount) {
456   switch (Opcode) {
457   case Mips::LbRxRyOffMemX16:
458   case Mips::LbuRxRyOffMemX16:
459   case Mips::LhRxRyOffMemX16:
460   case Mips::LhuRxRyOffMemX16:
461   case Mips::SbRxRyOffMemX16:
462   case Mips::ShRxRyOffMemX16:
463   case Mips::LwRxRyOffMemX16:
464   case Mips::SwRxRyOffMemX16:
465   case Mips::SwRxSpImmX16:
466   case Mips::LwRxSpImmX16:
467     return isInt<16>(Amount);
468   case Mips::AddiuRxRyOffMemX16:
469     if ((Reg == Mips::PC) || (Reg == Mips::SP))
470       return isInt<16>(Amount);
471     return isInt<15>(Amount);
472   }
473   llvm_unreachable("unexpected Opcode in validImmediate");
474 }
475
476 /// Measure the specified inline asm to determine an approximation of its
477 /// length.
478 /// Comments (which run till the next SeparatorString or newline) do not
479 /// count as an instruction.
480 /// Any other non-whitespace text is considered an instruction, with
481 /// multiple instructions separated by SeparatorString or newlines.
482 /// Variable-length instructions are not handled here; this function
483 /// may be overloaded in the target code to do that.
484 /// We implement the special case of the .space directive taking only an
485 /// integer argument, which is the size in bytes. This is used for creating
486 /// inline code spacing for testing purposes using inline assembly.
487 ///
488 unsigned Mips16InstrInfo::getInlineAsmLength(const char *Str,
489                                              const MCAsmInfo &MAI) const {
490
491   // Count the number of instructions in the asm.
492   bool atInsnStart = true;
493   unsigned Length = 0;
494   for (; *Str; ++Str) {
495     if (*Str == '\n' || strncmp(Str, MAI.getSeparatorString(),
496                                 strlen(MAI.getSeparatorString())) == 0)
497       atInsnStart = true;
498     if (atInsnStart && !std::isspace(static_cast<unsigned char>(*Str))) {
499       if (strncmp(Str, ".space", 6)==0) {
500         char *EStr; int Sz;
501         Sz = strtol(Str+6, &EStr, 10);
502         while (isspace(*EStr)) ++EStr;
503         if (*EStr=='\0') {
504           DEBUG(dbgs() << "parsed .space " << Sz << '\n');
505           return Sz;
506         }
507       }
508       Length += MAI.getMaxInstLength();
509       atInsnStart = false;
510     }
511     if (atInsnStart && strncmp(Str, MAI.getCommentString(),
512                                strlen(MAI.getCommentString())) == 0)
513       atInsnStart = false;
514   }
515
516   return Length;
517 }