Fix typos in comments.
[oota-llvm.git] / include / llvm / Target / TargetInstrInfo.h
index 371f8b2902a4192782aa634728cb300fee7cae4a..963c2d36bb318d443b7d6747e98b47ce0f621ed6 100644 (file)
@@ -1,18 +1,29 @@
 //===-- llvm/Target/TargetInstrInfo.h - Instruction Info --------*- C++ -*-===//
+// 
+//                     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 describes the target machine instructions to the code generator.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_TARGET_MACHINEINSTRINFO_H
-#define LLVM_TARGET_MACHINEINSTRINFO_H
+#ifndef LLVM_TARGET_TARGETINSTRINFO_H
+#define LLVM_TARGET_TARGETINSTRINFO_H
 
 #include "Support/DataTypes.h"
 #include <vector>
+#include <cassert>
+
+namespace llvm {
 
 class MachineInstr;
 class TargetMachine;
 class Value;
+class Type;
 class Instruction;
 class Constant;
 class Function;
@@ -29,14 +40,10 @@ const MachineOpCode INVALID_MACHINE_OPCODE = -1;
 
 
 //---------------------------------------------------------------------------
-// struct MachineInstrDescriptor:
+// struct TargetInstrDescriptor:
 //     Predefined information about each machine instruction.
 //     Designed to initialized statically.
-// 
-// class MachineInstructionInfo
-//     Interface to description of machine instructions
-// 
-//---------------------------------------------------------------------------
+//
 
 const unsigned M_NOP_FLAG              = 1 << 0;
 const unsigned M_BRANCH_FLAG           = 1 << 1;
@@ -66,7 +73,7 @@ struct TargetInstrDescriptor {
   const char *    Name;          // Assembly language mnemonic for the opcode.
   int             numOperands;   // Number of args; -1 if variable #args
   int             resultPos;     // Position of the result; -1 if no result
-  unsigned        maxImmedConst; // Largest +ve constant in IMMMED field or 0.
+  unsigned        maxImmedConst; // Largest +ve constant in IMMED field or 0.
   bool           immedIsSignExtended; // Is IMMED field sign-extended? If so,
                                  //   smallest -ve value is -(maxImmedConst+1).
   unsigned        numDelaySlots; // Number of delay slots after instruction
@@ -78,8 +85,11 @@ struct TargetInstrDescriptor {
   const unsigned *ImplicitDefs;  // Registers implicitly defined by this instr
 };
 
-typedef TargetInstrDescriptor MachineInstrDescriptor;
 
+//---------------------------------------------------------------------------
+/// 
+/// TargetInstrInfo - Interface to description of machine instructions
+/// 
 class TargetInstrInfo {
   const TargetInstrDescriptor* desc;    // raw array to allow static init'n
   unsigned descSize;                    // number of entries in the desc array
@@ -92,11 +102,8 @@ public:
                  unsigned numRealOpCodes);
   virtual ~TargetInstrInfo();
 
-  // Invariant: All instruction sets use opcode #0 as the PHI instruction and
-  // opcode #1 as the noop instruction.
-  enum {
-    PHI = 0, NOOP = 1
-  };
+  // Invariant: All instruction sets use opcode #0 as the PHI instruction
+  enum { PHI = 0 };
   
   unsigned getNumRealOpCodes()  const { return numRealOpCodes; }
   unsigned getNumTotalOpCodes() const { return descSize; }
@@ -109,13 +116,6 @@ public:
     return desc[opCode];
   }
 
-  /// print - Print out the specified machine instruction in the appropriate
-  /// target specific assembly language.  If this method is not overridden, the
-  /// default implementation uses the crummy machine independant printer.
-  ///
-  virtual void print(const MachineInstr *MI, std::ostream &O,
-                     const TargetMachine &TM) const;
-
   const char *getName(MachineOpCode opCode) const {
     return get(opCode).Name;
   }
@@ -135,7 +135,15 @@ public:
   InstrSchedClass getSchedClass(MachineOpCode opCode) const {
     return get(opCode).schedClass;
   }
-  
+
+  const unsigned *getImplicitUses(MachineOpCode opCode) const {
+    return get(opCode).ImplicitUses;
+  }
+
+  const unsigned *getImplicitDefs(MachineOpCode opCode) const {
+    return get(opCode).ImplicitDefs;
+  }
+
   //
   // Query instruction class flags according to the machine-independent
   // flags listed above.
@@ -206,6 +214,16 @@ public:
     return get(Opcode).Flags & M_TERMINATOR_FLAG;
   }
 
+  //
+  // Return true if the instruction is a register to register move and
+  // leave the source and dest operands in the passed parameters.
+  //
+  virtual bool isMoveInstr(const MachineInstr& MI,
+                           unsigned& sourceReg,
+                           unsigned& destReg) const {
+    return false;
+  }
+
   // Check if an instruction can be issued before its operands are ready,
   // or if a subsequent instruction that uses its result can be issued
   // before the results are ready.
@@ -243,7 +261,7 @@ public:
   virtual bool constantFitsInImmedField(MachineOpCode opCode,
                                        int64_t intValue) const;
   
-  // Return the largest +ve constant that can be held in the IMMMED field
+  // Return the largest positive constant that can be held in the IMMED field
   // of this machine instruction.
   // isSignExtended is set to true if the value is sign-extended before use
   // (this is true for all immediate fields in SPARC instructions).
@@ -274,6 +292,19 @@ public:
     return true;                        // safe but very conservative
   }
 
+
+  /// createNOPinstr - returns the target's implementation of NOP, which is
+  /// usually a pseudo-instruction, implemented by a degenerate version of
+  /// another instruction, e.g. X86: xchg ax, ax; SparcV9: sethi g0, 0
+  ///
+  virtual MachineInstr* createNOPinstr() const = 0;
+
+  /// isNOPinstr - not having a special NOP opcode, we need to know if a given
+  /// instruction is interpreted as an `official' NOP instr, i.e., there may be
+  /// more than one way to `do nothing' but only one canonical way to slack off.
+  ///
+  virtual bool isNOPinstr(const MachineInstr &MI) const = 0;
+
   //-------------------------------------------------------------------------
   // Code generation support for creating individual machine instructions
   //
@@ -286,6 +317,21 @@ public:
   // 
   virtual MachineOpCode getNOPOpCode() const { abort(); }
 
+  // Get the value of an integral constant in the form that must
+  // be put into the machine register.  The specified constant is interpreted
+  // as (i.e., converted if necessary to) the specified destination type.  The
+  // result is always returned as an uint64_t, since the representation of
+  // int64_t and uint64_t are identical.  The argument can be any known const.
+  // 
+  // isValidConstant is set to true if a valid constant was found.
+  // 
+  virtual uint64_t ConvertConstantToIntType(const TargetMachine &target,
+                                            const Value *V,
+                                            const Type *destType,
+                                            bool  &isValidConstant) const {
+    abort();
+  }
+
   // Create an instruction sequence to put the constant `val' into
   // the virtual register `dest'.  `val' may be a Constant or a
   // GlobalValue, viz., the constant address of a global variable or function.
@@ -381,6 +427,6 @@ public:
   }
 };
 
-typedef TargetInstrInfo MachineInstrInfo;
+} // End llvm namespace
 
 #endif