Restore dump() methods to Loop and MachineLoop.
[oota-llvm.git] / include / llvm / InlineAsm.h
index a35825d44a971477f41efc805236b3bbf0f893d8..482e53e3fe24fcd052eeb967b7233502d9442c40 100644 (file)
@@ -2,13 +2,14 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Chris Lattner and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 // This class represents the inline asm strings, which are Value*'s that are
-// used as the callee operand of call instructions.
+// used as the callee operand of call instructions.  InlineAsm's are uniqued
+// like constants, and created via InlineAsm::get(...).
 //
 //===----------------------------------------------------------------------===//
 
 #define LLVM_INLINEASM_H
 
 #include "llvm/Value.h"
+#include <vector>
 
 namespace llvm {
 
-class AssemblyAnnotationWriter;
 class PointerType;
 class FunctionType;
 class Module;
-template<typename SC> struct ilist_traits;
-template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
-         typename SubClass> class SymbolTableListTraits;
 
 class InlineAsm : public Value {
-  friend class SymbolTableListTraits<InlineAsm, Module, Module,
-                                     ilist_traits<InlineAsm> >;
   InlineAsm(const InlineAsm &);             // do not implement
   void operator=(const InlineAsm&);         // do not implement
 
-  void setParent(Module *Parent);
-  InlineAsm *Prev, *Next;
-  void setNext(InlineAsm *N) { Next = N; }
-  void setPrev(InlineAsm *N) { Prev = N; }
-        InlineAsm *getNext()       { return Next; }
-  const InlineAsm *getNext() const { return Next; }
-        InlineAsm *getPrev()       { return Prev; }
-  const InlineAsm *getPrev() const { return Prev; }
-  
-  Module *Parent;
   std::string AsmString, Constraints;
-  bool AsmHasSideEffects;
+  bool HasSideEffects;
+  bool IsAlignStack;
+  
+  InlineAsm(const FunctionType *Ty, StringRef AsmString,
+            StringRef Constraints, bool hasSideEffects,
+            bool isAlignStack = false);
+  virtual ~InlineAsm();
 public:
-  InlineAsm(const FunctionType *Ty, const std::string &AsmString,
-            const std::string &Constraints, bool hasSideEffects,
-            const std::string &Name = "", Module *ParentModule = 0);
+
+  /// InlineAsm::get - Return the the specified uniqued inline asm string.
+  ///
+  static InlineAsm *get(const FunctionType *Ty, StringRef AsmString,
+                        StringRef Constraints, bool hasSideEffects,
+                        bool isAlignStack = false);
   
-  bool getHasSideEffects() const { return AsmHasSideEffects; }
-  void setSideEffects(bool X) { AsmHasSideEffects = X; }
+  bool hasSideEffects() const { return HasSideEffects; }
+  bool isAlignStack() const { return IsAlignStack; }
   
   /// getType - InlineAsm's are always pointers.
   ///
@@ -62,26 +57,98 @@ public:
   /// getFunctionType - InlineAsm's are always pointers to functions.
   ///
   const FunctionType *getFunctionType() const;
+  
+  const std::string &getAsmString() const { return AsmString; }
+  const std::string &getConstraintString() const { return Constraints; }
 
-  /// getParent - Get the module that this global value is contained inside
-  /// of...
-  Module *getParent() { return Parent; }
-  const Module *getParent() const { return Parent; }
+  /// Verify - This static method can be used by the parser to check to see if
+  /// the specified constraint string is legal for the type.  This returns true
+  /// if legal, false if not.
+  ///
+  static bool Verify(const FunctionType *Ty, StringRef Constraints);
 
+  // Constraint String Parsing 
+  enum ConstraintPrefix {
+    isInput,            // 'x'
+    isOutput,           // '=x'
+    isClobber           // '~x'
+  };
   
-  /// removeFromParent/eraseFromParent - Unlink and unlink/delete this object
-  /// from the module it is embedded into.
-  void removeFromParent();
-  void eraseFromParent();
+  struct ConstraintInfo {
+    /// Type - The basic type of the constraint: input/output/clobber
+    ///
+    ConstraintPrefix Type;
+    
+    /// isEarlyClobber - "&": output operand writes result before inputs are all
+    /// read.  This is only ever set for an output operand.
+    bool isEarlyClobber; 
+    
+    /// MatchingInput - If this is not -1, this is an output constraint where an
+    /// input constraint is required to match it (e.g. "0").  The value is the
+    /// constraint number that matches this one (for example, if this is
+    /// constraint #0 and constraint #4 has the value "0", this will be 4).
+    signed char MatchingInput;
+    
+    /// hasMatchingInput - Return true if this is an output constraint that has
+    /// a matching input constraint.
+    bool hasMatchingInput() const { return MatchingInput != -1; }
+    
+    /// isCommutative - This is set to true for a constraint that is commutative
+    /// with the next operand.
+    bool isCommutative;
+    
+    /// isIndirect - True if this operand is an indirect operand.  This means
+    /// that the address of the source or destination is present in the call
+    /// instruction, instead of it being returned or passed in explicitly.  This
+    /// is represented with a '*' in the asm string.
+    bool isIndirect;
+    
+    /// Code - The constraint code, either the register name (in braces) or the
+    /// constraint letter/number.
+    std::vector<std::string> Codes;
+    
+    /// Parse - Analyze the specified string (e.g. "=*&{eax}") and fill in the
+    /// fields in this structure.  If the constraint string is not understood,
+    /// return true, otherwise return false.
+    bool Parse(StringRef Str, 
+               std::vector<InlineAsm::ConstraintInfo> &ConstraintsSoFar);
+  };
+  
+  /// ParseConstraints - Split up the constraint string into the specific
+  /// constraints and their prefixes.  If this returns an empty vector, and if
+  /// the constraint string itself isn't empty, there was an error parsing.
+  static std::vector<ConstraintInfo> 
+    ParseConstraints(StringRef ConstraintString);
+  
+  /// ParseConstraints - Parse the constraints of this inlineasm object, 
+  /// returning them the same way that ParseConstraints(str) does.
+  std::vector<ConstraintInfo> 
+  ParseConstraints() const {
+    return ParseConstraints(Constraints);
+  }
   
-  virtual void print(std::ostream &O) const { print(O, 0); }
-  void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
-
   // Methods for support type inquiry through isa, cast, and dyn_cast:
   static inline bool classof(const InlineAsm *) { return true; }
   static inline bool classof(const Value *V) {
-    return V->getValueType() == Value::InlineAsmVal;
+    return V->getValueID() == Value::InlineAsmVal;
+  }
+
+  /// getNumOperandRegisters - Extract the number of registers field from the
+  /// inline asm operand flag.
+  static unsigned getNumOperandRegisters(unsigned Flag) {
+    return (Flag & 0xffff) >> 3;
   }
+
+  /// isUseOperandTiedToDef - Return true if the flag of the inline asm
+  /// operand indicates it is an use operand that's matched to a def operand.
+  static bool isUseOperandTiedToDef(unsigned Flag, unsigned &Idx) {
+    if ((Flag & 0x80000000) == 0)
+      return false;
+    Idx = (Flag & ~0x80000000) >> 16;
+    return true;
+  }
+
+
 };
 
 } // End llvm namespace