really kill off the last MRMInitReg inst, remove logic from encoder.
[oota-llvm.git] / lib / Target / X86 / X86MCCodeEmitter.cpp
1 //===-- X86/X86MCCodeEmitter.cpp - Convert X86 code to machine code -------===//
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 implements the X86MCCodeEmitter class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "x86-emitter"
15 #include "X86.h"
16 #include "X86InstrInfo.h"
17 #include "llvm/MC/MCCodeEmitter.h"
18 #include "llvm/MC/MCInst.h"
19 #include "llvm/Support/raw_ostream.h"
20 using namespace llvm;
21
22 namespace {
23 class X86MCCodeEmitter : public MCCodeEmitter {
24   X86MCCodeEmitter(const X86MCCodeEmitter &); // DO NOT IMPLEMENT
25   void operator=(const X86MCCodeEmitter &); // DO NOT IMPLEMENT
26   const TargetMachine &TM;
27   const TargetInstrInfo &TII;
28   bool Is64BitMode;
29 public:
30   X86MCCodeEmitter(TargetMachine &tm) 
31     : TM(tm), TII(*TM.getInstrInfo()) {
32     // FIXME: Get this from the right place.
33     Is64BitMode = false;
34   }
35
36   ~X86MCCodeEmitter() {}
37   
38   static unsigned GetX86RegNum(const MCOperand &MO) {
39     return X86RegisterInfo::getX86RegNum(MO.getReg());
40   }
41   
42   void EmitByte(unsigned char C, raw_ostream &OS) const {
43     OS << (char)C;
44   }
45   
46   void EmitConstant(uint64_t Val, unsigned Size, raw_ostream &OS) const {
47     // Output the constant in little endian byte order.
48     for (unsigned i = 0; i != Size; ++i) {
49       EmitByte(Val & 255, OS);
50       Val >>= 8;
51     }
52   }
53
54   void EmitDisplacementField(const MCOperand *RelocOp, int DispVal,
55                              int64_t Adj, bool IsPCRel, raw_ostream &OS) const;
56   
57   inline static unsigned char ModRMByte(unsigned Mod, unsigned RegOpcode,
58                                         unsigned RM) {
59     assert(Mod < 4 && RegOpcode < 8 && RM < 8 && "ModRM Fields out of range!");
60     return RM | (RegOpcode << 3) | (Mod << 6);
61   }
62   
63   void EmitRegModRMByte(const MCOperand &ModRMReg, unsigned RegOpcodeFld,
64                         raw_ostream &OS) const {
65     EmitByte(ModRMByte(3, RegOpcodeFld, GetX86RegNum(ModRMReg)), OS);
66   }
67   
68   void EmitSIBByte(unsigned SS, unsigned Index, unsigned Base,
69                    raw_ostream &OS) const {
70     // SIB byte is in the same format as the ModRMByte...
71     EmitByte(ModRMByte(SS, Index, Base), OS);
72   }
73   
74   
75   void EmitMemModRMByte(const MCInst &MI, unsigned Op,
76                         unsigned RegOpcodeField, intptr_t PCAdj,
77                         raw_ostream &OS) const;
78   
79   void EncodeInstruction(const MCInst &MI, raw_ostream &OS) const;
80   
81 };
82
83 } // end anonymous namespace
84
85
86 MCCodeEmitter *llvm::createX86MCCodeEmitter(const Target &,
87                                             TargetMachine &TM) {
88   return new X86MCCodeEmitter(TM);
89 }
90
91
92 /// isDisp8 - Return true if this signed displacement fits in a 8-bit 
93 /// sign-extended field. 
94 static bool isDisp8(int Value) {
95   return Value == (signed char)Value;
96 }
97
98 void X86MCCodeEmitter::
99 EmitDisplacementField(const MCOperand *RelocOp, int DispVal,
100                       int64_t Adj, bool IsPCRel, raw_ostream &OS) const {
101   // If this is a simple integer displacement that doesn't require a relocation,
102   // emit it now.
103   if (!RelocOp) {
104     EmitConstant(DispVal, 4, OS);
105     return;
106   }
107   
108   assert(0 && "Reloc not handled yet");
109 #if 0
110   // Otherwise, this is something that requires a relocation.  Emit it as such
111   // now.
112   unsigned RelocType = Is64BitMode ?
113   (IsPCRel ? X86::reloc_pcrel_word : X86::reloc_absolute_word_sext)
114   : (IsPIC ? X86::reloc_picrel_word : X86::reloc_absolute_word);
115   if (RelocOp->isGlobal()) {
116     // In 64-bit static small code model, we could potentially emit absolute.
117     // But it's probably not beneficial. If the MCE supports using RIP directly
118     // do it, otherwise fallback to absolute (this is determined by IsPCRel). 
119     //  89 05 00 00 00 00     mov    %eax,0(%rip)  # PC-relative
120     //  89 04 25 00 00 00 00  mov    %eax,0x0      # Absolute
121     bool Indirect = gvNeedsNonLazyPtr(*RelocOp, TM);
122     emitGlobalAddress(RelocOp->getGlobal(), RelocType, RelocOp->getOffset(),
123                       Adj, Indirect);
124   } else if (RelocOp->isSymbol()) {
125     emitExternalSymbolAddress(RelocOp->getSymbolName(), RelocType);
126   } else if (RelocOp->isCPI()) {
127     emitConstPoolAddress(RelocOp->getIndex(), RelocType,
128                          RelocOp->getOffset(), Adj);
129   } else {
130     assert(RelocOp->isJTI() && "Unexpected machine operand!");
131     emitJumpTableAddress(RelocOp->getIndex(), RelocType, Adj);
132   }
133 #endif
134 }
135
136
137 void X86MCCodeEmitter::EmitMemModRMByte(const MCInst &MI, unsigned Op,
138                                         unsigned RegOpcodeField,
139                                         intptr_t PCAdj,
140                                         raw_ostream &OS) const {
141   const MCOperand &Op3 = MI.getOperand(Op+3);
142   int DispVal = 0;
143   const MCOperand *DispForReloc = 0;
144   
145   // Figure out what sort of displacement we have to handle here.
146   if (Op3.isImm()) {
147     DispVal = Op3.getImm();
148   } else {
149     assert(0 && "relocatable operand");
150 #if 0
151   if (Op3.isGlobal()) {
152     DispForReloc = &Op3;
153   } else if (Op3.isSymbol()) {
154     DispForReloc = &Op3;
155   } else if (Op3.isCPI()) {
156     if (!MCE.earlyResolveAddresses() || Is64BitMode || IsPIC) {
157       DispForReloc = &Op3;
158     } else {
159       DispVal += MCE.getConstantPoolEntryAddress(Op3.getIndex());
160       DispVal += Op3.getOffset();
161     }
162   } else {
163     assert(Op3.isJTI());
164     if (!MCE.earlyResolveAddresses() || Is64BitMode || IsPIC) {
165       DispForReloc = &Op3;
166     } else {
167       DispVal += MCE.getJumpTableEntryAddress(Op3.getIndex());
168     }
169 #endif
170   }
171   
172   const MCOperand &Base     = MI.getOperand(Op);
173   const MCOperand &Scale    = MI.getOperand(Op+1);
174   const MCOperand &IndexReg = MI.getOperand(Op+2);
175   unsigned BaseReg = Base.getReg();
176
177   // FIXME: Eliminate!
178   bool IsPCRel = false;
179
180   // Is a SIB byte needed?
181   // If no BaseReg, issue a RIP relative instruction only if the MCE can 
182   // resolve addresses on-the-fly, otherwise use SIB (Intel Manual 2A, table
183   // 2-7) and absolute references.
184   if ((!Is64BitMode || DispForReloc || BaseReg != 0) &&
185       IndexReg.getReg() == 0 && 
186       (BaseReg == X86::RIP || (BaseReg != 0 && BaseReg != X86::ESP))) {
187     if (BaseReg == 0 || BaseReg == X86::RIP) {  // Just a displacement?
188       // Emit special case [disp32] encoding
189       EmitByte(ModRMByte(0, RegOpcodeField, 5), OS);
190       EmitDisplacementField(DispForReloc, DispVal, PCAdj, true, OS);
191     } else {
192       unsigned BaseRegNo = GetX86RegNum(Base);
193       if (!DispForReloc && DispVal == 0 && BaseRegNo != N86::EBP) {
194         // Emit simple indirect register encoding... [EAX] f.e.
195         EmitByte(ModRMByte(0, RegOpcodeField, BaseRegNo), OS);
196       } else if (!DispForReloc && isDisp8(DispVal)) {
197         // Emit the disp8 encoding... [REG+disp8]
198         EmitByte(ModRMByte(1, RegOpcodeField, BaseRegNo), OS);
199         EmitConstant(DispVal, 1, OS);
200       } else {
201         // Emit the most general non-SIB encoding: [REG+disp32]
202         EmitByte(ModRMByte(2, RegOpcodeField, BaseRegNo), OS);
203         EmitDisplacementField(DispForReloc, DispVal, PCAdj, IsPCRel, OS);
204       }
205     }
206     return;
207   }
208     
209   // We need a SIB byte, so start by outputting the ModR/M byte first
210   assert(IndexReg.getReg() != X86::ESP &&
211          IndexReg.getReg() != X86::RSP && "Cannot use ESP as index reg!");
212   
213   bool ForceDisp32 = false;
214   bool ForceDisp8  = false;
215   if (BaseReg == 0) {
216     // If there is no base register, we emit the special case SIB byte with
217     // MOD=0, BASE=5, to JUST get the index, scale, and displacement.
218     EmitByte(ModRMByte(0, RegOpcodeField, 4), OS);
219     ForceDisp32 = true;
220   } else if (DispForReloc) {
221     // Emit the normal disp32 encoding.
222     EmitByte(ModRMByte(2, RegOpcodeField, 4), OS);
223     ForceDisp32 = true;
224   } else if (DispVal == 0 && BaseReg != X86::EBP) {
225     // Emit no displacement ModR/M byte
226     EmitByte(ModRMByte(0, RegOpcodeField, 4), OS);
227   } else if (isDisp8(DispVal)) {
228     // Emit the disp8 encoding.
229     EmitByte(ModRMByte(1, RegOpcodeField, 4), OS);
230     ForceDisp8 = true;           // Make sure to force 8 bit disp if Base=EBP
231   } else {
232     // Emit the normal disp32 encoding.
233     EmitByte(ModRMByte(2, RegOpcodeField, 4), OS);
234   }
235   
236   // Calculate what the SS field value should be...
237   static const unsigned SSTable[] = { ~0, 0, 1, ~0, 2, ~0, ~0, ~0, 3 };
238   unsigned SS = SSTable[Scale.getImm()];
239   
240   if (BaseReg == 0) {
241     // Handle the SIB byte for the case where there is no base, see Intel 
242     // Manual 2A, table 2-7. The displacement has already been output.
243     unsigned IndexRegNo;
244     if (IndexReg.getReg())
245       IndexRegNo = GetX86RegNum(IndexReg);
246     else // Examples: [ESP+1*<noreg>+4] or [scaled idx]+disp32 (MOD=0,BASE=5)
247       IndexRegNo = 4;
248     EmitSIBByte(SS, IndexRegNo, 5, OS);
249   } else {
250     unsigned IndexRegNo;
251     if (IndexReg.getReg())
252       IndexRegNo = GetX86RegNum(IndexReg);
253     else
254       IndexRegNo = 4;   // For example [ESP+1*<noreg>+4]
255     EmitSIBByte(SS, IndexRegNo, GetX86RegNum(Base), OS);
256   }
257   
258   // Do we need to output a displacement?
259   if (ForceDisp8)
260     EmitConstant(DispVal, 1, OS);
261   else if (DispVal != 0 || ForceDisp32)
262     EmitDisplacementField(DispForReloc, DispVal, PCAdj, IsPCRel, OS);
263 }
264
265
266 void X86MCCodeEmitter::
267 EncodeInstruction(const MCInst &MI, raw_ostream &OS) const {
268   unsigned Opcode = MI.getOpcode();
269   const TargetInstrDesc &Desc = TII.get(Opcode);
270   unsigned TSFlags = Desc.TSFlags;
271
272   // FIXME: We should emit the prefixes in exactly the same order as GAS does,
273   // in order to provide diffability.
274
275   // Emit the lock opcode prefix as needed.
276   if (TSFlags & X86II::LOCK)
277     EmitByte(0xF0, OS);
278   
279   // Emit segment override opcode prefix as needed.
280   switch (TSFlags & X86II::SegOvrMask) {
281   default: assert(0 && "Invalid segment!");
282   case 0: break;  // No segment override!
283   case X86II::FS:
284     EmitByte(0x64, OS);
285     break;
286   case X86II::GS:
287     EmitByte(0x65, OS);
288     break;
289   }
290   
291   // Emit the repeat opcode prefix as needed.
292   if ((TSFlags & X86II::Op0Mask) == X86II::REP)
293     EmitByte(0xF3, OS);
294   
295   // Emit the operand size opcode prefix as needed.
296   if (TSFlags & X86II::OpSize)
297     EmitByte(0x66, OS);
298   
299   // Emit the address size opcode prefix as needed.
300   if (TSFlags & X86II::AdSize)
301     EmitByte(0x67, OS);
302   
303   bool Need0FPrefix = false;
304   switch (TSFlags & X86II::Op0Mask) {
305   default: assert(0 && "Invalid prefix!");
306   case 0: break;  // No prefix!
307   case X86II::REP: break; // already handled.
308   case X86II::TB:  // Two-byte opcode prefix
309   case X86II::T8:  // 0F 38
310   case X86II::TA:  // 0F 3A
311     Need0FPrefix = true;
312     break;
313   case X86II::TF: // F2 0F 38
314     EmitByte(0xF2, OS);
315     Need0FPrefix = true;
316     break;
317   case X86II::XS:   // F3 0F
318     EmitByte(0xF3, OS);
319     Need0FPrefix = true;
320     break;
321   case X86II::XD:   // F2 0F
322     EmitByte(0xF2, OS);
323     Need0FPrefix = true;
324     break;
325   case X86II::D8: EmitByte(0xD8, OS); break;
326   case X86II::D9: EmitByte(0xD9, OS); break;
327   case X86II::DA: EmitByte(0xDA, OS); break;
328   case X86II::DB: EmitByte(0xDB, OS); break;
329   case X86II::DC: EmitByte(0xDC, OS); break;
330   case X86II::DD: EmitByte(0xDD, OS); break;
331   case X86II::DE: EmitByte(0xDE, OS); break;
332   case X86II::DF: EmitByte(0xDF, OS); break;
333   }
334   
335   // Handle REX prefix.
336 #if 0 // FIXME: Add in, also, can this come before F2 etc to simplify emission?
337   if (Is64BitMode) {
338     if (unsigned REX = X86InstrInfo::determineREX(MI))
339       EmitByte(0x40 | REX, OS);
340   }
341 #endif
342   
343   // 0x0F escape code must be emitted just before the opcode.
344   if (Need0FPrefix)
345     EmitByte(0x0F, OS);
346   
347   // FIXME: Pull this up into previous switch if REX can be moved earlier.
348   switch (TSFlags & X86II::Op0Mask) {
349   case X86II::TF:    // F2 0F 38
350   case X86II::T8:    // 0F 38
351     EmitByte(0x38, OS);
352     break;
353   case X86II::TA:    // 0F 3A
354     EmitByte(0x3A, OS);
355     break;
356   }
357   
358   // If this is a two-address instruction, skip one of the register operands.
359   unsigned NumOps = Desc.getNumOperands();
360   unsigned CurOp = 0;
361   if (NumOps > 1 && Desc.getOperandConstraint(1, TOI::TIED_TO) != -1)
362     ++CurOp;
363   else if (NumOps > 2 && Desc.getOperandConstraint(NumOps-1, TOI::TIED_TO)== 0)
364     // Skip the last source operand that is tied_to the dest reg. e.g. LXADD32
365     --NumOps;
366   
367   unsigned char BaseOpcode = X86II::getBaseOpcodeFor(TSFlags);
368   switch (TSFlags & X86II::FormMask) {
369   case X86II::MRMInitReg:
370     assert(0 && "FIXME: Remove this form when the JIT moves to MCCodeEmitter!");
371   default: errs() << "FORM: " << (TSFlags & X86II::FormMask) << "\n";
372       assert(0 && "Unknown FormMask value in X86MCCodeEmitter!");
373   case X86II::RawFrm: {
374     EmitByte(BaseOpcode, OS);
375     
376     if (CurOp == NumOps)
377       break;
378     
379     assert(0 && "Unimpl RawFrm expr");
380     break;
381   }
382       
383   case X86II::AddRegFrm: {
384     EmitByte(BaseOpcode + GetX86RegNum(MI.getOperand(CurOp++)),OS);
385     if (CurOp == NumOps)
386       break;
387
388     const MCOperand &MO1 = MI.getOperand(CurOp++);
389     if (MO1.isImm()) {
390       unsigned Size = X86II::getSizeOfImm(TSFlags);
391       EmitConstant(MO1.getImm(), Size, OS);
392       break;
393     }
394
395     assert(0 && "Unimpl AddRegFrm expr");
396     break;
397   }
398       
399   case X86II::MRMDestReg:
400     EmitByte(BaseOpcode, OS);
401     EmitRegModRMByte(MI.getOperand(CurOp),
402                      GetX86RegNum(MI.getOperand(CurOp+1)), OS);
403     CurOp += 2;
404     if (CurOp != NumOps)
405       EmitConstant(MI.getOperand(CurOp++).getImm(),
406                    X86II::getSizeOfImm(TSFlags), OS);
407     break;
408   
409   case X86II::MRMDestMem:
410     EmitByte(BaseOpcode, OS);
411     EmitMemModRMByte(MI, CurOp,
412                      GetX86RegNum(MI.getOperand(CurOp + X86AddrNumOperands)),
413                      0, OS);
414     CurOp += X86AddrNumOperands + 1;
415     if (CurOp != NumOps)
416       EmitConstant(MI.getOperand(CurOp++).getImm(),
417                    X86II::getSizeOfImm(TSFlags), OS);
418     break;
419       
420   case X86II::MRMSrcReg:
421     EmitByte(BaseOpcode, OS);
422     EmitRegModRMByte(MI.getOperand(CurOp+1), GetX86RegNum(MI.getOperand(CurOp)),
423                      OS);
424     CurOp += 2;
425     if (CurOp != NumOps)
426       EmitConstant(MI.getOperand(CurOp++).getImm(),
427                    X86II::getSizeOfImm(TSFlags), OS);
428     break;
429     
430   case X86II::MRMSrcMem: {
431     EmitByte(BaseOpcode, OS);
432
433     // FIXME: Maybe lea should have its own form?  This is a horrible hack.
434     int AddrOperands;
435     if (Opcode == X86::LEA64r || Opcode == X86::LEA64_32r ||
436         Opcode == X86::LEA16r || Opcode == X86::LEA32r)
437       AddrOperands = X86AddrNumOperands - 1; // No segment register
438     else
439       AddrOperands = X86AddrNumOperands;
440     
441     // FIXME: What is this actually doing?
442     intptr_t PCAdj = (CurOp + AddrOperands + 1 != NumOps) ?
443        X86II::getSizeOfImm(TSFlags) : 0;
444     
445     EmitMemModRMByte(MI, CurOp+1, GetX86RegNum(MI.getOperand(CurOp)),
446                      PCAdj, OS);
447     CurOp += AddrOperands + 1;
448     if (CurOp != NumOps)
449       EmitConstant(MI.getOperand(CurOp++).getImm(),
450                    X86II::getSizeOfImm(TSFlags), OS);
451     break;
452   }
453
454   case X86II::MRM0r: case X86II::MRM1r:
455   case X86II::MRM2r: case X86II::MRM3r:
456   case X86II::MRM4r: case X86II::MRM5r:
457   case X86II::MRM6r: case X86II::MRM7r: {
458     EmitByte(BaseOpcode, OS);
459
460     // Special handling of lfence, mfence, monitor, and mwait.
461     // FIXME: This is terrible, they should get proper encoding bits in TSFlags.
462     if (Opcode == X86::LFENCE || Opcode == X86::MFENCE ||
463         Opcode == X86::MONITOR || Opcode == X86::MWAIT) {
464       EmitByte(ModRMByte(3, (TSFlags & X86II::FormMask)-X86II::MRM0r, 0), OS);
465
466       switch (Opcode) {
467       default: break;
468       case X86::MONITOR: EmitByte(0xC8, OS); break;
469       case X86::MWAIT:   EmitByte(0xC9, OS); break;
470       }
471     } else {
472       EmitRegModRMByte(MI.getOperand(CurOp++),
473                        (TSFlags & X86II::FormMask)-X86II::MRM0r,
474                        OS);
475     }
476
477     if (CurOp == NumOps)
478       break;
479     
480     const MCOperand &MO1 = MI.getOperand(CurOp++);
481     if (MO1.isImm()) {
482       EmitConstant(MO1.getImm(), X86II::getSizeOfImm(TSFlags), OS);
483       break;
484     }
485
486     assert(0 && "relo unimpl");
487 #if 0
488     unsigned rt = Is64BitMode ? X86::reloc_pcrel_word
489       : (IsPIC ? X86::reloc_picrel_word : X86::reloc_absolute_word);
490     if (Opcode == X86::MOV64ri32)
491       rt = X86::reloc_absolute_word_sext;  // FIXME: add X86II flag?
492     if (MO1.isGlobal()) {
493       bool Indirect = gvNeedsNonLazyPtr(MO1, TM);
494       emitGlobalAddress(MO1.getGlobal(), rt, MO1.getOffset(), 0,
495                         Indirect);
496     } else if (MO1.isSymbol())
497       emitExternalSymbolAddress(MO1.getSymbolName(), rt);
498     else if (MO1.isCPI())
499       emitConstPoolAddress(MO1.getIndex(), rt);
500     else if (MO1.isJTI())
501       emitJumpTableAddress(MO1.getIndex(), rt);
502     break;
503 #endif
504   }
505   case X86II::MRM0m: case X86II::MRM1m:
506   case X86II::MRM2m: case X86II::MRM3m:
507   case X86II::MRM4m: case X86II::MRM5m:
508   case X86II::MRM6m: case X86II::MRM7m: {
509     intptr_t PCAdj = 0;
510     if (CurOp + X86AddrNumOperands != NumOps) {
511       if (MI.getOperand(CurOp+X86AddrNumOperands).isImm())
512         PCAdj = X86II::getSizeOfImm(TSFlags);
513       else
514         PCAdj = 4;
515     }
516
517     EmitByte(BaseOpcode, OS);
518     EmitMemModRMByte(MI, CurOp, (TSFlags & X86II::FormMask)-X86II::MRM0m,
519                      PCAdj, OS);
520     CurOp += X86AddrNumOperands;
521     
522     if (CurOp == NumOps)
523       break;
524     
525     const MCOperand &MO = MI.getOperand(CurOp++);
526     if (MO.isImm()) {
527       EmitConstant(MO.getImm(), X86II::getSizeOfImm(TSFlags), OS);
528       break;
529     }
530     
531     assert(0 && "relo not handled");
532 #if 0
533     unsigned rt = Is64BitMode ? X86::reloc_pcrel_word
534     : (IsPIC ? X86::reloc_picrel_word : X86::reloc_absolute_word);
535     if (Opcode == X86::MOV64mi32)
536       rt = X86::reloc_absolute_word_sext;  // FIXME: add X86II flag?
537     if (MO.isGlobal()) {
538       bool Indirect = gvNeedsNonLazyPtr(MO, TM);
539       emitGlobalAddress(MO.getGlobal(), rt, MO.getOffset(), 0,
540                         Indirect);
541     } else if (MO.isSymbol())
542       emitExternalSymbolAddress(MO.getSymbolName(), rt);
543     else if (MO.isCPI())
544       emitConstPoolAddress(MO.getIndex(), rt);
545     else if (MO.isJTI())
546       emitJumpTableAddress(MO.getIndex(), rt);
547 #endif
548     break;
549   }
550   }
551   
552 #ifndef NDEBUG
553   // FIXME: Verify.
554   if (/*!Desc.isVariadic() &&*/ CurOp != NumOps) {
555     errs() << "Cannot encode all operands of: ";
556     MI.dump();
557     errs() << '\n';
558     abort();
559   }
560 #endif
561 }