Adds the x86-64 assembler.

src/IceTargetLoweringX8664Traits.h

-//===- subzero/src/IceTargetLoweringX8632Traits.h - x86-32 traits -*- C++ -*-=//
+//===- subzero/src/IceTargetLoweringX8664Traits.h - x86-64 traits -*- C++ -*-=//
 //
 //                        The Subzero Code Generator
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 ///
 /// \file
-/// This file declares the X8632 Target Lowering Traits.
+/// This file declares the X8664 Target Lowering Traits.
 ///
 //===----------------------------------------------------------------------===//
 
-#ifndef SUBZERO_SRC_ICETARGETLOWERINGX8632TRAITS_H
-#define SUBZERO_SRC_ICETARGETLOWERINGX8632TRAITS_H
+#ifndef SUBZERO_SRC_ICETARGETLOWERINGX8664TRAITS_H
+#define SUBZERO_SRC_ICETARGETLOWERINGX8664TRAITS_H
 
 #include "IceAssembler.h"
-#include "IceConditionCodesX8632.h"
+#include "IceConditionCodesX8664.h"
 #include "IceDefs.h"
 #include "IceInst.h"
-#include "IceInstX8632.def"
+#include "IceInstX8664.def"
 #include "IceOperand.h"
-#include "IceRegistersX8632.h"
-#include "IceTargetLoweringX8632.def"
+#include "IceRegistersX8664.h"
+#include "IceTargetLoweringX8664.def"
 #include "IceTargetLowering.h"
 
 namespace Ice {
 
-class TargetX8632;
+class TargetX8664;
 
-namespace X8632 {
-class AssemblerX8632;
-} // end of namespace X8632
+namespace X8664 {
+class AssemblerX8664;
+} // end of namespace X8664
 
 namespace X86Internal {
 
 template <class Machine> struct Insts;
 template <class Machine> struct MachineTraits;
-template <class Machine> class TargetX86Base;
 
-template <> struct MachineTraits<TargetX8632> {
+template <> struct MachineTraits<TargetX8664> {
   //----------------------------------------------------------------------------
   //     ______  ______  __    __
   //    /\  __ \/\  ___\/\ "-./  \
   //    \ \  __ \ \___  \ \ \-./\ \
   //     \ \_\ \_\/\_____\ \_\ \ \_\
   //      \/_/\/_/\/_____/\/_/  \/_/
   //
   //----------------------------------------------------------------------------
+  static constexpr bool Is64Bit = true;
+  static constexpr bool HasPopa = false;
+  static constexpr bool HasPusha = false;
+  static constexpr bool UsesX87 = false;
+
   enum ScaleFactor { TIMES_1 = 0, TIMES_2 = 1, TIMES_4 = 2, TIMES_8 = 3 };
 
-  using GPRRegister = ::Ice::RegX8632::GPRRegister;
-  using XmmRegister = ::Ice::RegX8632::XmmRegister;
-  using ByteRegister = ::Ice::RegX8632::ByteRegister;
-  using X87STRegister = ::Ice::RegX8632::X87STRegister;
+  using GPRRegister = ::Ice::RegX8664::GPRRegister;
+  using XmmRegister = ::Ice::RegX8664::XmmRegister;
+  using ByteRegister = ::Ice::RegX8664::ByteRegister;
 
-  using Cond = ::Ice::CondX86;
+  using Cond = ::Ice::CondX8664;
 
-  using RegisterSet = ::Ice::RegX8632;
-  static const GPRRegister Encoded_Reg_Accumulator = RegX8632::Encoded_Reg_eax;
-  static const GPRRegister Encoded_Reg_Counter = RegX8632::Encoded_Reg_ecx;
-  static const FixupKind PcRelFixup = llvm::ELF::R_386_PC32;
+  using RegisterSet = ::Ice::RegX8664;
+  static const GPRRegister Encoded_Reg_Accumulator = RegX8664::Encoded_Reg_eax;
+  static const GPRRegister Encoded_Reg_Counter = RegX8664::Encoded_Reg_ecx;
+  static const FixupKind PcRelFixup = llvm::ELF::R_386_PC32; // TODO(jpp): ???

[jvoung (off chromium), 2015/07/23 17:59:36]

FYI the llvm::ELF:: stuff comes from

toolchain_build/src/llvm/include/llvm/Support/ELFRelocs/x86_64.def, for example

but TODO is good for now, until you decide which of those...

[John, 2015/07/27 20:35:58]

Thanks for the pointer.

 
   class Operand {
   public:
     Operand(const Operand &other)
         : fixup_(other.fixup_), length_(other.length_) {
       memmove(&encoding_[0], &other.encoding_[0], other.length_);
     }
 
     Operand &operator=(const Operand &other) {
       length_ = other.length_;
@@ skipping 92 matching lines @@
 
   public:
     Address(const Address &other) : Operand(other) {}
 
     Address &operator=(const Address &other) {
       Operand::operator=(other);
       return *this;
     }
 
     Address(GPRRegister base, int32_t disp) {
-      if (disp == 0 && base != RegX8632::Encoded_Reg_ebp) {
+      if (disp == 0 && base != RegX8664::Encoded_Reg_ebp) {
         SetModRM(0, base);
-        if (base == RegX8632::Encoded_Reg_esp)
-          SetSIB(TIMES_1, RegX8632::Encoded_Reg_esp, base);
+        if (base == RegX8664::Encoded_Reg_esp)
+          SetSIB(TIMES_1, RegX8664::Encoded_Reg_esp, base);
       } else if (Utils::IsInt(8, disp)) {
         SetModRM(1, base);
-        if (base == RegX8632::Encoded_Reg_esp)
-          SetSIB(TIMES_1, RegX8632::Encoded_Reg_esp, base);
+        if (base == RegX8664::Encoded_Reg_esp)
+          SetSIB(TIMES_1, RegX8664::Encoded_Reg_esp, base);
         SetDisp8(disp);
       } else {
         SetModRM(2, base);
-        if (base == RegX8632::Encoded_Reg_esp)
-          SetSIB(TIMES_1, RegX8632::Encoded_Reg_esp, base);
+        if (base == RegX8664::Encoded_Reg_esp)
+          SetSIB(TIMES_1, RegX8664::Encoded_Reg_esp, base);
         SetDisp32(disp);
       }
     }
 
     Address(GPRRegister index, ScaleFactor scale, int32_t disp) {
-      assert(index != RegX8632::Encoded_Reg_esp); // Illegal addressing mode.
-      SetModRM(0, RegX8632::Encoded_Reg_esp);
-      SetSIB(scale, index, RegX8632::Encoded_Reg_ebp);
+      assert(index != RegX8664::Encoded_Reg_esp); // Illegal addressing mode.
+      SetModRM(0, RegX8664::Encoded_Reg_esp);
+      SetSIB(scale, index, RegX8664::Encoded_Reg_ebp);
       SetDisp32(disp);
     }
 
     Address(GPRRegister base, GPRRegister index, ScaleFactor scale,
             int32_t disp) {
-      assert(index != RegX8632::Encoded_Reg_esp); // Illegal addressing mode.
-      if (disp == 0 && base != RegX8632::Encoded_Reg_ebp) {
-        SetModRM(0, RegX8632::Encoded_Reg_esp);
+      assert(index != RegX8664::Encoded_Reg_esp); // Illegal addressing mode.
+      if (disp == 0 && base != RegX8664::Encoded_Reg_ebp) {
+        SetModRM(0, RegX8664::Encoded_Reg_esp);
         SetSIB(scale, index, base);
       } else if (Utils::IsInt(8, disp)) {
-        SetModRM(1, RegX8632::Encoded_Reg_esp);
+        SetModRM(1, RegX8664::Encoded_Reg_esp);
         SetSIB(scale, index, base);
         SetDisp8(disp);
       } else {
-        SetModRM(2, RegX8632::Encoded_Reg_esp);
+        SetModRM(2, RegX8664::Encoded_Reg_esp);
         SetSIB(scale, index, base);
         SetDisp32(disp);
       }
     }
 
     /// AbsoluteTag is a special tag used by clients to create an absolute
     /// Address.
     enum AbsoluteTag { ABSOLUTE };
 
     Address(AbsoluteTag, const uintptr_t Addr) {
-      SetModRM(0, RegX8632::Encoded_Reg_ebp);
+      SetModRM(0, RegX8664::Encoded_Reg_ebp);
       SetDisp32(Addr);
     }
 
     // TODO(jpp): remove this.
     static Address Absolute(const uintptr_t Addr) {
       return Address(ABSOLUTE, Addr);
     }
 
     Address(AbsoluteTag, RelocOffsetT Offset, AssemblerFixup *Fixup) {
-      SetModRM(0, RegX8632::Encoded_Reg_ebp);
+      SetModRM(0, RegX8664::Encoded_Reg_ebp);
       // Use the Offset in the displacement for now. If we decide to process
       // fixups later, we'll need to patch up the emitted displacement.
       SetDisp32(Offset);
       SetFixup(Fixup);
     }
 
     // TODO(jpp): remove this.
     static Address Absolute(RelocOffsetT Offset, AssemblerFixup *Fixup) {
       return Address(ABSOLUTE, Offset, Fixup);
     }
 
     static Address ofConstPool(Assembler *Asm, const Constant *Imm) {
+      // TODO(jpp): ???
       AssemblerFixup *Fixup = Asm->createFixup(llvm::ELF::R_386_32, Imm);
       const RelocOffsetT Offset = 0;
       return Address(ABSOLUTE, Offset, Fixup);
     }
   };
 
+#if 0
+  // The Traits for lowering/insts for x86-64 are very similar to the ones for x86-32, so these are kept here.

[jvoung (off chromium), 2015/07/23 17:59:36]

Just checking, but is the #if 0 necessary?

[John, 2015/07/27 20:35:58]

It would help me out to keep implementing the backend alongside with the code
reviews, but not that big of a deal. Removed.

   //----------------------------------------------------------------------------
   //     __      ______  __     __  ______  ______  __  __   __  ______
   //    /\ \    /\  __ \/\ \  _ \ \/\  ___\/\  == \/\ \/\ "-.\ \/\  ___\
   //    \ \ \___\ \ \/\ \ \ \/ ".\ \ \  __\\ \  __<\ \ \ \ \-.  \ \ \__ \
   //     \ \_____\ \_____\ \__/".~\_\ \_____\ \_\ \_\ \_\ \_\\"\_\ \_____\
   //      \/_____/\/_____/\/_/   \/_/\/_____/\/_/ /_/\/_/\/_/ \/_/\/_____/
   //
   //----------------------------------------------------------------------------
   enum InstructionSet {
     Begin,
     // SSE2 is the PNaCl baseline instruction set.
     SSE2 = Begin,
     SSE4_1,
     End
   };
 
   static const char *TargetName;
 
   static IceString getRegName(SizeT RegNum, Type Ty) {
     assert(RegNum < RegisterSet::Reg_NUM);
     static const char *RegNames8[] = {
 #define X(val, encode, name, name16, name8, scratch, preserved, stackptr,      \
           frameptr, isI8, isInt, isFP)                                         \
   name8,
-        REGX8632_TABLE
+        REGX8664_TABLE
 #undef X
     };
 
     static const char *RegNames16[] = {
 #define X(val, encode, name, name16, name8, scratch, preserved, stackptr,      \
           frameptr, isI8, isInt, isFP)                                         \
   name16,
-        REGX8632_TABLE
+        REGX8664_TABLE
 #undef X
     };
 
     static const char *RegNames[] = {
 #define X(val, encode, name, name16, name8, scratch, preserved, stackptr,      \
           frameptr, isI8, isInt, isFP)                                         \
   name,
-        REGX8632_TABLE
+        REGX8664_TABLE
 #undef X
     };
 
     switch (Ty) {
     case IceType_i1:
     case IceType_i8:
       return RegNames8[RegNum];
     case IceType_i16:
       return RegNames16[RegNum];
     default:
       return RegNames[RegNum];
     }
   }
 
   static void initRegisterSet(llvm::SmallBitVector *IntegerRegisters,
                               llvm::SmallBitVector *IntegerRegistersI8,
                               llvm::SmallBitVector *FloatRegisters,
                               llvm::SmallBitVector *VectorRegisters,
                               llvm::SmallBitVector *ScratchRegs) {
 #define X(val, encode, name, name16, name8, scratch, preserved, stackptr,      \
           frameptr, isI8, isInt, isFP)                                         \
   (*IntegerRegisters)[RegisterSet::val] = isInt;                               \
   (*IntegerRegistersI8)[RegisterSet::val] = isI8;                              \
   (*FloatRegisters)[RegisterSet::val] = isFP;                                  \
   (*VectorRegisters)[RegisterSet::val] = isFP;                                 \
   (*ScratchRegs)[RegisterSet::val] = scratch;
-    REGX8632_TABLE;
+    REGX8664_TABLE;
 #undef X
   }
 
   static llvm::SmallBitVector
   getRegisterSet(TargetLowering::RegSetMask Include,
                  TargetLowering::RegSetMask Exclude) {
     llvm::SmallBitVector Registers(RegisterSet::Reg_NUM);
 
 #define X(val, encode, name, name16, name8, scratch, preserved, stackptr,      \
           frameptr, isI8, isInt, isFP)                                         \
   if (scratch && (Include & ::Ice::TargetLowering::RegSet_CallerSave))         \
     Registers[RegisterSet::val] = true;                                        \
   if (preserved && (Include & ::Ice::TargetLowering::RegSet_CalleeSave))       \
     Registers[RegisterSet::val] = true;                                        \
   if (stackptr && (Include & ::Ice::TargetLowering::RegSet_StackPointer))      \
     Registers[RegisterSet::val] = true;                                        \
   if (frameptr && (Include & ::Ice::TargetLowering::RegSet_FramePointer))      \
     Registers[RegisterSet::val] = true;                                        \
   if (scratch && (Exclude & ::Ice::TargetLowering::RegSet_CallerSave))         \
     Registers[RegisterSet::val] = false;                                       \
   if (preserved && (Exclude & ::Ice::TargetLowering::RegSet_CalleeSave))       \
     Registers[RegisterSet::val] = false;                                       \
   if (stackptr && (Exclude & ::Ice::TargetLowering::RegSet_StackPointer))      \
     Registers[RegisterSet::val] = false;                                       \
   if (frameptr && (Exclude & ::Ice::TargetLowering::RegSet_FramePointer))      \
     Registers[RegisterSet::val] = false;
 
-    REGX8632_TABLE
+    REGX8664_TABLE
 
 #undef X
 
     return Registers;
   }
 
   static void
   makeRandomRegisterPermutation(GlobalContext *Ctx, Cfg *Func,
                                 llvm::SmallVectorImpl<int32_t> &Permutation,
                                 const llvm::SmallBitVector &ExcludeRegisters) {
     // TODO(stichnot): Declaring Permutation this way loses type/size
     // information.  Fix this in conjunction with the caller-side TODO.
     assert(Permutation.size() >= RegisterSet::Reg_NUM);
     // Expected upper bound on the number of registers in a single equivalence
-    // class.  For x86-32, this would comprise the 8 XMM registers.  This is for
+    // class.  For x86-64, this would comprise the 8 XMM registers.  This is for
     // performance, not correctness.
     static const unsigned MaxEquivalenceClassSize = 8;
     typedef llvm::SmallVector<int32_t, MaxEquivalenceClassSize> RegisterList;
     typedef std::map<uint32_t, RegisterList> EquivalenceClassMap;
     EquivalenceClassMap EquivalenceClasses;
     SizeT NumShuffled = 0, NumPreserved = 0;
 
 // Build up the equivalence classes of registers by looking at the register
 // properties as well as whether the registers should be explicitly excluded
 // from shuffling.
 #define X(val, encode, name, name16, name8, scratch, preserved, stackptr,      \
           frameptr, isI8, isInt, isFP)                                         \
   if (ExcludeRegisters[RegisterSet::val]) {                                    \
     /* val stays the same in the resulting permutation. */                     \
     Permutation[RegisterSet::val] = RegisterSet::val;                          \
     ++NumPreserved;                                                            \
   } else {                                                                     \
     const uint32_t Index = (scratch << 0) | (preserved << 1) | (isI8 << 2) |   \
                            (isInt << 3) | (isFP << 4);                         \
     /* val is assigned to an equivalence class based on its properties. */     \
     EquivalenceClasses[Index].push_back(RegisterSet::val);                     \
   }
-    REGX8632_TABLE
+    REGX8664_TABLE
 #undef X
 
     RandomNumberGeneratorWrapper RNG(Ctx->getRNG());
 
     // Shuffle the resulting equivalence classes.
     for (auto I : EquivalenceClasses) {
       const RegisterList &List = I.second;
       RegisterList Shuffled(List);
       RandomShuffle(Shuffled.begin(), Shuffled.end(), RNG);
       for (size_t SI = 0, SE = Shuffled.size(); SI < SE; ++SI) {
@@ skipping 20 matching lines @@
         }
         Str << "}\n";
       }
     }
   }
 
   /// The maximum number of arguments to pass in XMM registers
   static const uint32_t X86_MAX_XMM_ARGS = 4;
   /// The number of bits in a byte
   static const uint32_t X86_CHAR_BIT = 8;
-  /// Stack alignment. This is defined in IceTargetLoweringX8632.cpp because it
+  /// Stack alignment. This is defined in IceTargetLoweringX8664.cpp because it
   /// is used as an argument to std::max(), and the default std::less<T> has an
   /// operator(T const&, T const&) which requires this member to have an
   /// address.
   static const uint32_t X86_STACK_ALIGNMENT_BYTES;
   /// Size of the return address on the stack
   static const uint32_t X86_RET_IP_SIZE_BYTES = 4;
   /// The number of different NOP instructions
   static const uint32_t X86_NUM_NOP_VARIANTS = 5;
 
   /// Value is in bytes. Return Value adjusted to the next highest multiple
   /// of the stack alignment.
   static uint32_t applyStackAlignment(uint32_t Value) {
     return Utils::applyAlignment(Value, X86_STACK_ALIGNMENT_BYTES);
   }
 
   /// Return the type which the elements of the vector have in the X86
   /// representation of the vector.
   static Type getInVectorElementType(Type Ty) {
     assert(isVectorType(Ty));
     size_t Index = static_cast<size_t>(Ty);
     (void)Index;
-    assert(Index < TableTypeX8632AttributesSize);
-    return TableTypeX8632Attributes[Ty].InVectorElementType;
+    assert(Index < TableTypeX8664AttributesSize);
+    return TableTypeX8664Attributes[Ty].InVectorElementType;
   }
 
   // Note: The following data structures are defined in
-  // IceTargetLoweringX8632.cpp.
+  // IceTargetLoweringX8664.cpp.
 
   /// The following table summarizes the logic for lowering the fcmp
   /// instruction. There is one table entry for each of the 16 conditions.
   ///
   /// The first four columns describe the case when the operands are floating
   /// point scalar values.  A comment in lowerFcmp() describes the lowering
   /// template.  In the most general case, there is a compare followed by two
   /// conditional branches, because some fcmp conditions don't map to a single
   /// x86 conditional branch.  However, in many cases it is possible to swap the
   /// operands in the comparison and have a single conditional branch.  Since
@@ skipping 34 matching lines @@
   } TableIcmp64[];
   static const size_t TableIcmp64Size;
   /// @}
 
   static Cond::BrCond getIcmp32Mapping(InstIcmp::ICond Cond) {
     size_t Index = static_cast<size_t>(Cond);
     assert(Index < TableIcmp32Size);
     return TableIcmp32[Index].Mapping;
   }
 
-  static const struct TableTypeX8632AttributesType {
+  static const struct TableTypeX8664AttributesType {
     Type InVectorElementType;
-  } TableTypeX8632Attributes[];
-  static const size_t TableTypeX8632AttributesSize;
+  } TableTypeX8664Attributes[];
+  static const size_t TableTypeX8664AttributesSize;
 
   //----------------------------------------------------------------------------
   //      __  __   __  ______  ______
   //    /\ \/\ "-.\ \/\  ___\/\__  _\
   //    \ \ \ \ \-.  \ \___  \/_/\ \/
   //     \ \_\ \_\\"\_\/\_____\ \ \_\
   //      \/_/\/_/ \/_/\/_____/  \/_/
   //
   //----------------------------------------------------------------------------
-  using Insts = ::Ice::X86Internal::Insts<TargetX8632>;
+  using Insts = ::Ice::X86Internal::Insts<TargetX8664>;
 
-  using TargetLowering = ::Ice::X86Internal::TargetX86Base<TargetX8632>;
-  using Assembler = X8632::AssemblerX8632;
+  using TargetLowering = TargetX8664;
+  using Assembler = X8664::AssemblerX8664;
 
   /// X86Operand extends the Operand hierarchy.  Its subclasses are
   /// X86OperandMem and VariableSplit.
   class X86Operand : public ::Ice::Operand {
     X86Operand() = delete;
     X86Operand(const X86Operand &) = delete;
     X86Operand &operator=(const X86Operand &) = delete;
 
   public:
-    enum OperandKindX8632 { k__Start = ::Ice::Operand::kTarget, kMem, kSplit };
+    enum OperandKindX8664 { k__Start = ::Ice::Operand::kTarget, kMem, kSplit };
     using ::Ice::Operand::dump;
 
     void dump(const Cfg *, Ostream &Str) const override;
 
   protected:
-    X86Operand(OperandKindX8632 Kind, Type Ty)
+    X86Operand(OperandKindX8664 Kind, Type Ty)
         : Operand(static_cast<::Ice::Operand::OperandKind>(Kind), Ty) {}
   };
 
   /// X86OperandMem represents the m32 addressing mode, with optional base and
   /// index registers, a constant offset, and a fixed shift value for the index
   /// register.
   class X86OperandMem : public X86Operand {
     X86OperandMem() = delete;
     X86OperandMem(const X86OperandMem &) = delete;
     X86OperandMem &operator=(const X86OperandMem &) = delete;
 
   public:
     enum SegmentRegisters {
       DefaultSegment = -1,
 #define X(val, name, prefix) val,
-      SEG_REGX8632_TABLE
+      SEG_REGX8664_TABLE
 #undef X
           SegReg_NUM
     };
     static X86OperandMem *create(Cfg *Func, Type Ty, Variable *Base,
                                  Constant *Offset, Variable *Index = nullptr,
                                  uint16_t Shift = 0,
                                  SegmentRegisters SegmentReg = DefaultSegment) {
       return new (Func->allocate<X86OperandMem>())
           X86OperandMem(Func, Ty, Base, Offset, Index, Shift, SegmentReg);
     }
@@ skipping 96 matching lines @@
     void setLinkedTo(Variable *Var) { LinkedTo = Var; }
     Variable *getLinkedTo() const { return LinkedTo; }
     // Inherit dump() and emit() from Variable.
 
   private:
     SpillVariable(Type Ty, SizeT Index)
         : Variable(SpillVariableKind, Ty, Index), LinkedTo(nullptr) {}
     Variable *LinkedTo;
   };
 
-  // Note: The following data structures are defined in IceInstX8632.cpp.
+  // Note: The following data structures are defined in IceInstX8664.cpp.
 
   static const struct InstBrAttributesType {
     Cond::BrCond Opposite;
     const char *DisplayString;
     const char *EmitString;
   } InstBrAttributes[];
 
   static const struct InstCmppsAttributesType {
     const char *EmitString;
   } InstCmppsAttributes[];
 
   static const struct TypeAttributesType {
     const char *CvtString;   // i (integer), s (single FP), d (double FP)
     const char *SdSsString;  // ss, sd, or <blank>
     const char *PackString;  // b, w, d, or <blank>
     const char *WidthString; // b, w, l, q, or <blank>
     const char *FldString;   // s, l, or <blank>
   } TypeAttributes[];
 
   static const char *InstSegmentRegNames[];
 
   static uint8_t InstSegmentPrefixes[];
+#endif // 0
 };
 
 } // end of namespace X86Internal
 
-namespace X8632 {
-using Traits = ::Ice::X86Internal::MachineTraits<TargetX8632>;
-} // end of namespace X8632
+namespace X8664 {
+using Traits = ::Ice::X86Internal::MachineTraits<TargetX8664>;
+} // end of namespace X8664
 
 } // end of namespace Ice
 
-#endif // SUBZERO_SRC_ICETARGETLOWERINGX8632TRAITS_H
+#endif // SUBZERO_SRC_ICETARGETLOWERINGX8664TRAITS_H