Classes need to have a prefix name, so that they can be tacked on to the pieces
[oota-llvm.git] / lib / Target / Target.td
index 2dec163c9a9bde887a8f16d05e324a8e1ffe59a8..6fada3452e6068ca5171613b181ad579db9a34f8 100644 (file)
@@ -1,4 +1,11 @@
-//===- Target.td - Target Independent TableGen interface --------*- C++ -*-===//
+//===- Target.td - Target Independent TableGen interface ---*- tablegen -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file defines the target-independent interfaces which should be
 // implemented by each target which is using a TableGen based code generator.
 //===----------------------------------------------------------------------===//
 //
 // Value types - These values correspond to the register types defined in the
-// ValueTypes.h file.
+// ValueTypes.h file.  If you update anything here, you must update it there as
+// well!
 //
-class ValueType<int size> { string Namespace = "MVT"; int Size = size; }
-
-def i1   : ValueType<1>;      // One bit boolean value
-def i8   : ValueType<8>;      // 8-bit integer value
-def i16  : ValueType<16>;     // 16-bit integer value
-def i32  : ValueType<32>;     // 32-bit integer value
-def i64  : ValueType<64>;     // 64-bit integer value
-def i128 : ValueType<128>;    // 128-bit integer value
-def f32  : ValueType<32>;     // 32-bit floating point value
-def f64  : ValueType<64>;     // 64-bit floating point value
-def f80  : ValueType<80>;     // 80-bit floating point value
-def f128 : ValueType<128>;    // 128-bit floating point value
+class ValueType<int size, int value> {
+  string Namespace = "MVT";
+  int Size = size;
+  int Value = value;
+}
 
+def OtherVT: ValueType<0  ,  0>;   // "Other" value
+def i1     : ValueType<1  ,  1>;   // One bit boolean value
+def i8     : ValueType<8  ,  2>;   // 8-bit integer value
+def i16    : ValueType<16 ,  3>;   // 16-bit integer value
+def i32    : ValueType<32 ,  4>;   // 32-bit integer value
+def i64    : ValueType<64 ,  5>;   // 64-bit integer value
+def i128   : ValueType<128,  5>;   // 128-bit integer value
+def f32    : ValueType<32 ,  7>;   // 32-bit floating point value
+def f64    : ValueType<64 ,  8>;   // 64-bit floating point value
+def f80    : ValueType<80 ,  9>;   // 80-bit floating point value
+def f128   : ValueType<128,  9>;   // 128-bit floating point value
+def isVoid : ValueType<0  , 11>;   // Produces no value
 
 //===----------------------------------------------------------------------===//
 // Register file description - These classes are used to fill in the target
@@ -35,6 +48,14 @@ def f128 : ValueType<128>;    // 128-bit floating point value
 //
 class Register {
   string Namespace = "";
+  string Name = "";
+}
+
+// NamedReg - If the name for the 'def' of the register should not become the
+// "name" of the register, you can use this to specify a custom name instead.
+//
+class NamedReg<string n> : Register {
+  let Name = n;
 }
 
 // RegisterAliases - You should define instances of this class to indicate which
@@ -70,25 +91,76 @@ class RegisterClass<ValueType regType, int alignment, list<Register> regList> {
   //
   list<Register> MemberList = regList;
 
-  // allocation_order_* - These methods define the order that the registers
-  // should be allocated.  See the MRegister.h file for more information.
-  //
-  code allocation_order_begin;
-  code allocation_order_end;
+  // Methods - This member can be used to insert arbitrary code into a generated
+  // register class.   The normal usage of this is to overload virtual methods.
+  code Methods = [{}];
+
+  // isDummyClass - If this is set to true, this register class is not really
+  // part of the target, it is just used for other purposes.
+  bit isDummyClass = 0;
 }
 
-// RegisterInfo - This class should only be instantiated once to provide
-// parameters which are global to the the target machine, such as callee safed
-// registers.
+
+//===----------------------------------------------------------------------===//
+// Instruction set description - These classes correspond to the C++ classes in
+// the Target/TargetInstrInfo.h file.
 //
-class RegisterInfo {
-  // ClassName - Specify the name of the class that should be generated by the
-  // register info emitter.  This class may be further subclasses by custom
-  // target code to implement virtual methods as necessary.  Targets must
-  // specify a value for this.
+class Instruction {
+  string Name = "";         // The opcode string for this instruction
+  string Namespace = "";
+  string ClassPrefix = "";
+
+  dag OperandList;          // An dag containing the MI operand list.
+  string AsmString = "";    // The .s format to print the instruction with.
+
+  // Pattern - Set to the DAG pattern for this instruction, if we know of one,
+  // otherwise, uninitialized.
+  list<dag> Pattern;
+
+  // The follow state will eventually be inferred automatically from the
+  // instruction pattern.
+
+  list<Register> Uses = []; // Default to using no non-operand registers
+  list<Register> Defs = []; // Default to modifying no non-operand registers
+
+  // These bits capture information about the high-level semantics of the
+  // instruction.
+  bit isReturn     = 0;     // Is this instruction a return instruction?
+  bit isBranch     = 0;     // Is this instruction a branch instruction?
+  bit isBarrier    = 0;     // Can control flow fall through this instruction?
+  bit isCall       = 0;     // Is this instruction a call instruction?
+  bit isTwoAddress = 0;     // Is this a two address instruction?
+  bit isTerminator = 0;     // Is this part of the terminator for a basic block?
+}
+
+
+// InstrInfo - This class should only be instantiated once to provide parameters
+// which are global to the the target machine.
+//
+class InstrInfo {
+  Instruction PHIInst;
+
+  // If the target wants to associate some target-specific information with each
+  // instruction, it should provide these two lists to indicate how to assemble
+  // the target specific information into the 32 bits available.
   //
-  string ClassName;
+  list<string> TSFlagsFields = [];
+  list<int>    TSFlagsShifts = [];
+}
 
+/// ops definition - This is just a simple marker used to identify the operands
+/// list for an instruction.  This should be used like this:
+///     (ops R32:$dst, R32:$src) or something similar.
+def ops;
+def i8imm;
+def i16imm;
+def i32imm;
+def i64imm;
+
+//===----------------------------------------------------------------------===//
+// Target - This class contains the "global" target information
+//
+class Target {
   // CalleeSavedRegisters - As you might guess, this is a list of the callee
   // saved registers for a target.
   list<Register> CalleeSavedRegisters = [];
@@ -96,25 +168,98 @@ class RegisterInfo {
   // PointerType - Specify the value type to be used to represent pointers in
   // this target.  Typically this is an i32 or i64 type.
   ValueType PointerType;
+
+  // InstructionSet - Instruction set description for this target
+  InstrInfo InstructionSet;
 }
 
 
 //===----------------------------------------------------------------------===//
-// Instruction set description - 
+// DAG node definitions used by the instruction selector.
+//
+// NOTE: all of this is a work-in-progress and should be ignored for now.
 //
 
-class Instruction {
-  string Name;          // The opcode string for this instruction
-  string Namespace = "";
+class Expander<dag pattern, list<dag> result> {
+  dag Pattern      = pattern;
+  list<dag> Result = result;
+}
 
-  list<Register> Uses = [];  // Default to using no non-operand registers
-  list<Register> Defs = [];  // Default to modifying no non-operand registers
+class DagNodeValType;
+def DNVT_any   : DagNodeValType;  // No constraint on tree node
+def DNVT_void  : DagNodeValType;  // Tree node always returns void
+def DNVT_val   : DagNodeValType;  // A non-void type
+def DNVT_arg0  : DagNodeValType;  // Tree node returns same type as Arg0
+def DNVT_arg1  : DagNodeValType;  // Tree node returns same type as Arg1
+def DNVT_ptr   : DagNodeValType;  // The target pointer type
+def DNVT_i8    : DagNodeValType;  // Always have an i8 value
 
-  // These bits capture information about the high-level semantics of the
-  // instruction.
-  bit isReturn     = 0;     // Is this instruction a return instruction?
-  bit isBranch     = 0;     // Is this instruction a branch instruction?
-  bit isCall       = 0;     // Is this instruction a call instruction?
-  bit isTwoAddress = 0;     // Is this a two address instruction?
-  bit isTerminator = 0;     // Is this part of the terminator for a basic block?
+class DagNode<DagNodeValType ret, list<DagNodeValType> args> {
+  DagNodeValType RetType = ret;
+  list<DagNodeValType> ArgTypes = args;
+  string EnumName = ?;
 }
+
+// BuiltinDagNodes are built into the instruction selector and correspond to
+// enum values.
+class BuiltinDagNode<DagNodeValType Ret, list<DagNodeValType> Args,
+                     string Ename> : DagNode<Ret, Args> {
+  let EnumName = Ename;
+}
+
+// Magic nodes...
+def Void       : RegisterClass<isVoid,0,[]> { let isDummyClass = 1; }
+def set        : DagNode<DNVT_void, [DNVT_val, DNVT_arg0]>;
+def chain      : BuiltinDagNode<DNVT_void, [DNVT_void, DNVT_void], "ChainNode">;
+def blockchain : BuiltinDagNode<DNVT_void, [DNVT_void, DNVT_void],
+                                "BlockChainNode">;
+def ChainExpander      : Expander<(chain Void, Void), []>;
+def BlockChainExpander : Expander<(blockchain Void, Void), []>;
+
+
+// Terminals...
+def imm        : BuiltinDagNode<DNVT_val, [], "Constant">;
+def frameidx   : BuiltinDagNode<DNVT_ptr, [], "FrameIndex">;
+def basicblock : BuiltinDagNode<DNVT_ptr, [], "BasicBlock">;
+
+// Arithmetic...
+def plus    : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "Plus">;
+def minus   : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "Minus">;
+def times   : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "Times">;
+def sdiv    : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "SDiv">;
+def udiv    : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "UDiv">;
+def srem    : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "SRem">;
+def urem    : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "URem">;
+def and     : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "And">;
+def or      : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "Or">;
+def xor     : BuiltinDagNode<DNVT_arg0, [DNVT_arg1, DNVT_arg0], "Xor">;
+
+// Comparisons...
+def seteq   : BuiltinDagNode<DNVT_i8  , [DNVT_arg1, DNVT_arg0], "SetEQ">;
+def setne   : BuiltinDagNode<DNVT_i8  , [DNVT_arg1, DNVT_arg0], "SetNE">;
+def setlt   : BuiltinDagNode<DNVT_i8  , [DNVT_arg1, DNVT_arg0], "SetLT">;
+def setle   : BuiltinDagNode<DNVT_i8  , [DNVT_arg1, DNVT_arg0], "SetLE">;
+def setgt   : BuiltinDagNode<DNVT_i8  , [DNVT_arg1, DNVT_arg0], "SetGT">;
+def setge   : BuiltinDagNode<DNVT_i8  , [DNVT_arg1, DNVT_arg0], "SetGE">;
+
+def load    : BuiltinDagNode<DNVT_val, [DNVT_ptr], "Load">;
+//def store   : BuiltinDagNode<DNVT_Void, [DNVT_ptr, DNVT_val]>;
+
+// Other...
+def ret     : BuiltinDagNode<DNVT_void, [DNVT_val], "Ret">;
+def retvoid : BuiltinDagNode<DNVT_void, [], "RetVoid">;
+def br      : BuiltinDagNode<DNVT_void, [DNVT_ptr], "Br">;
+def brcond  : BuiltinDagNode<DNVT_void, [DNVT_i8, DNVT_ptr, DNVT_ptr],
+                             "BrCond">;
+
+def unspec1 : BuiltinDagNode<DNVT_any , [DNVT_val], "Unspec1">;
+def unspec2 : BuiltinDagNode<DNVT_any , [DNVT_val, DNVT_val], "Unspec2">;
+
+//===----------------------------------------------------------------------===//
+// DAG nonterminals definitions used by the instruction selector...
+//
+class Nonterminal<dag pattern> {
+  dag Pattern = pattern;
+  bit BuiltIn = 0;
+}
+