lib/Target/X86/X86InstrInfo.h

   1 //===- X86InstrInfo.h - X86 Instruction Information ------------*- C++ -*- ===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the X86 implementation of the TargetInstrInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef X86INSTRUCTIONINFO_H
  15 #define X86INSTRUCTIONINFO_H
  16
  17 #include "llvm/Target/TargetInstrInfo.h"
  18 #include "X86RegisterInfo.h"
  19
  20 namespace llvm {
  21
  22 /// X86II - This namespace holds all of the target specific flags that
  23 /// instruction info tracks.
  24 ///
  25 namespace X86II {
  26   enum {
  27     //===------------------------------------------------------------------===//
  28     // Instruction types.  These are the standard/most common forms for X86
  29     // instructions.
  30     //
  31
  32     // PseudoFrm - This represents an instruction that is a pseudo instruction
  33     // or one that has not been implemented yet.  It is illegal to code generate
  34     // it, but tolerated for intermediate implementation stages.
  35     Pseudo         = 0,
  36
  37     /// Raw - This form is for instructions that don't have any operands, so
  38     /// they are just a fixed opcode value, like 'leave'.
  39     RawFrm         = 1,
  40
  41     /// AddRegFrm - This form is used for instructions like 'push r32' that have
  42     /// their one register operand added to their opcode.
  43     AddRegFrm      = 2,
  44
  45     /// MRMDestReg - This form is used for instructions that use the Mod/RM byte
  46     /// to specify a destination, which in this case is a register.
  47     ///
  48     MRMDestReg     = 3,
  49
  50     /// MRMDestMem - This form is used for instructions that use the Mod/RM byte
  51     /// to specify a destination, which in this case is memory.
  52     ///
  53     MRMDestMem     = 4,
  54
  55     /// MRMSrcReg - This form is used for instructions that use the Mod/RM byte
  56     /// to specify a source, which in this case is a register.
  57     ///
  58     MRMSrcReg      = 5,
  59
  60     /// MRMSrcMem - This form is used for instructions that use the Mod/RM byte
  61     /// to specify a source, which in this case is memory.
  62     ///
  63     MRMSrcMem      = 6,
  64
  65     /// MRMS[0-7][rm] - These forms are used to represent instructions that use
  66     /// a Mod/RM byte, and use the middle field to hold extended opcode
  67     /// information.  In the intel manual these are represented as /0, /1, ...
  68     ///
  69
  70     // First, instructions that operate on a register r/m operand...
  71     MRMS0r = 16,  MRMS1r = 17,  MRMS2r = 18,  MRMS3r = 19, // Format /0 /1 /2 /3
  72     MRMS4r = 20,  MRMS5r = 21,  MRMS6r = 22,  MRMS7r = 23, // Format /4 /5 /6 /7
  73
  74     // Next, instructions that operate on a memory r/m operand...
  75     MRMS0m = 24,  MRMS1m = 25,  MRMS2m = 26,  MRMS3m = 27, // Format /0 /1 /2 /3
  76     MRMS4m = 28,  MRMS5m = 29,  MRMS6m = 30,  MRMS7m = 31, // Format /4 /5 /6 /7
  77
  78     FormMask       = 31,
  79
  80     //===------------------------------------------------------------------===//
  81     // Actual flags...
  82
  83     // OpSize - Set if this instruction requires an operand size prefix (0x66),
  84     // which most often indicates that the instruction operates on 16 bit data
  85     // instead of 32 bit data.
  86     OpSize      = 1 << 5,
  87
  88     // Op0Mask - There are several prefix bytes that are used to form two byte
  89     // opcodes.  These are currently 0x0F, and 0xD8-0xDF.  This mask is used to
  90     // obtain the setting of this field.  If no bits in this field is set, there
  91     // is no prefix byte for obtaining a multibyte opcode.
  92     //
  93     Op0Shift    = 6,
  94     Op0Mask     = 0xF << Op0Shift,
  95
  96     // TB - TwoByte - Set if this instruction has a two byte opcode, which
  97     // starts with a 0x0F byte before the real opcode.
  98     TB          = 1 << Op0Shift,
  99
 100     // D8-DF - These escape opcodes are used by the floating point unit.  These
 101     // values must remain sequential.
 102     D8 = 2 << Op0Shift,   D9 = 3 << Op0Shift,
 103     DA = 4 << Op0Shift,   DB = 5 << Op0Shift,
 104     DC = 6 << Op0Shift,   DD = 7 << Op0Shift,
 105     DE = 8 << Op0Shift,   DF = 9 << Op0Shift,
 106
 107     //===------------------------------------------------------------------===//
 108     // This three-bit field describes the size of a memory operand.  Zero is
 109     // unused so that we can tell if we forgot to set a value.
 110     ArgShift = 10,
 111     ArgMask  = 7 << ArgShift,
 112     Arg8     = 1 << ArgShift,
 113     Arg16    = 2 << ArgShift,
 114     Arg32    = 3 << ArgShift,
 115     Arg64    = 4 << ArgShift,  // 64 bit int argument for FILD64
 116     ArgF32   = 5 << ArgShift,
 117     ArgF64   = 6 << ArgShift,
 118     ArgF80   = 7 << ArgShift,
 119
 120     //===------------------------------------------------------------------===//
 121     // FP Instruction Classification...  Zero is non-fp instruction.
 122
 123     // FPTypeMask - Mask for all of the FP types...
 124     FPTypeShift = 13,
 125     FPTypeMask  = 7 << FPTypeShift,
 126
 127     // NotFP - The default, set for instructions that do not use FP registers.
 128     NotFP      = 0 << FPTypeShift,
 129
 130     // ZeroArgFP - 0 arg FP instruction which implicitly pushes ST(0), f.e. fld0
 131     ZeroArgFP  = 1 << FPTypeShift,
 132
 133     // OneArgFP - 1 arg FP instructions which implicitly read ST(0), such as fst
 134     OneArgFP   = 2 << FPTypeShift,
 135
 136     // OneArgFPRW - 1 arg FP instruction which implicitly read ST(0) and write a
 137     // result back to ST(0).  For example, fcos, fsqrt, etc.
 138     //
 139     OneArgFPRW = 3 << FPTypeShift,
 140
 141     // TwoArgFP - 2 arg FP instructions which implicitly read ST(0), and an
 142     // explicit argument, storing the result to either ST(0) or the implicit
 143     // argument.  For example: fadd, fsub, fmul, etc...
 144     TwoArgFP   = 4 << FPTypeShift,
 145
 146     // SpecialFP - Special instruction forms.  Dispatch by opcode explicitly.
 147     SpecialFP  = 5 << FPTypeShift,
 148
 149     // PrintImplUses - Print out implicit uses in the assembly output.
 150     PrintImplUses = 1 << 16,
 151
 152     OpcodeShift   = 17,
 153     OpcodeMask    = 0xFF << OpcodeShift,
 154     // Bits 25 -> 31 are unused
 155   };
 156 }
 157
 158 class X86InstrInfo : public TargetInstrInfo {
 159   const X86RegisterInfo RI;
 160 public:
 161   X86InstrInfo();
 162
 163   /// getRegisterInfo - TargetInstrInfo is a superset of MRegister info.  As
 164   /// such, whenever a client has an instance of instruction info, it should
 165   /// always be able to get register info as well (through this method).
 166   ///
 167   virtual const MRegisterInfo &getRegisterInfo() const { return RI; }
 168
 169   /// createNOPinstr - returns the target's implementation of NOP, which is
 170   /// usually a pseudo-instruction, implemented by a degenerate version of
 171   /// another instruction, e.g. X86: `xchg ax, ax'; SparcV9: `sethi r0, r0, r0'
 172   ///
 173   MachineInstr* createNOPinstr() const;
 174
 175   //
 176   // Return true if the instruction is a register to register move and
 177   // leave the source and dest operands in the passed parameters.
 178   //
 179   virtual bool isMoveInstr(const MachineInstr& MI,
 180                            unsigned& sourceReg,
 181                            unsigned& destReg) const;
 182
 183   /// isNOPinstr - not having a special NOP opcode, we need to know if a given
 184   /// instruction is interpreted as an `official' NOP instr, i.e., there may be
 185   /// more than one way to `do nothing' but only one canonical way to slack off.
 186   ///
 187   bool isNOPinstr(const MachineInstr &MI) const;
 188
 189   // getBaseOpcodeFor - This function returns the "base" X86 opcode for the
 190   // specified opcode number.
 191   //
 192   unsigned char getBaseOpcodeFor(unsigned Opcode) const {
 193     return get(Opcode).TSFlags >> X86II::OpcodeShift;
 194   }
 195 };
 196
 197 } // End llvm namespace
 198
 199 #endif