include/llvm/InlineAsm.h

   1 //===-- llvm/InlineAsm.h - Class to represent inline asm strings-*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Chris Lattner and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This class represents the inline asm strings, which are Value*'s that are
  11 // used as the callee operand of call instructions.  InlineAsm's are uniqued
  12 // like constants, and created via InlineAsm::get(...).
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_INLINEASM_H
  17 #define LLVM_INLINEASM_H
  18
  19 #include "llvm/Value.h"
  20 #include "llvm/System/IncludeFile.h"
  21 #include <vector>
  22
  23 namespace llvm {
  24
  25 struct AssemblyAnnotationWriter;
  26 class PointerType;
  27 class FunctionType;
  28 class Module;
  29
  30 class InlineAsm : public Value {
  31   InlineAsm(const InlineAsm &);             // do not implement
  32   void operator=(const InlineAsm&);         // do not implement
  33
  34   std::string AsmString, Constraints;
  35   bool HasSideEffects;
  36
  37   InlineAsm(const FunctionType *Ty, const std::string &AsmString,
  38             const std::string &Constraints, bool hasSideEffects);
  39   virtual ~InlineAsm();
  40 public:
  41
  42   /// InlineAsm::get - Return the the specified uniqued inline asm string.
  43   ///
  44   static InlineAsm *get(const FunctionType *Ty, const std::string &AsmString,
  45                         const std::string &Constraints, bool hasSideEffects);
  46
  47   bool hasSideEffects() const { return HasSideEffects; }
  48
  49   /// getType - InlineAsm's are always pointers.
  50   ///
  51   const PointerType *getType() const {
  52     return reinterpret_cast<const PointerType*>(Value::getType());
  53   }
  54
  55   /// getFunctionType - InlineAsm's are always pointers to functions.
  56   ///
  57   const FunctionType *getFunctionType() const;
  58
  59   const std::string &getAsmString() const { return AsmString; }
  60   const std::string &getConstraintString() const { return Constraints; }
  61
  62   virtual void print(std::ostream &O) const { print(O, 0); }
  63   void print(std::ostream *O) const { if (O) print(*O); }
  64   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
  65
  66   /// Verify - This static method can be used by the parser to check to see if
  67   /// the specified constraint string is legal for the type.  This returns true
  68   /// if legal, false if not.
  69   ///
  70   static bool Verify(const FunctionType *Ty, const std::string &Constraints);
  71
  72   // Constraint String Parsing
  73   enum ConstraintPrefix {
  74     isInput,            // 'x'
  75     isOutput,           // '=x'
  76     isClobber           // '~x'
  77   };
  78
  79   struct ConstraintInfo {
  80     /// Type - The basic type of the constraint: input/output/clobber
  81     ///
  82     ConstraintPrefix Type;
  83
  84     /// isEarlyClobber - "&": output operand writes result before inputs are all
  85     /// read.  This is only ever set for an output operand.
  86     bool isEarlyClobber;
  87
  88     /// hasMatchingInput - This is set to true for an output constraint iff
  89     /// there is an input constraint that is required to match it (e.g. "0").
  90     bool hasMatchingInput;
  91
  92     /// isCommutative - This is set to true for a constraint that is commutative
  93     /// with the next operand.
  94     bool isCommutative;
  95
  96     /// isIndirect - True if this operand is an indirect operand.  This means
  97     /// that the address of the source or destination is present in the call
  98     /// instruction, instead of it being returned or passed in explicitly.  This
  99     /// is represented with a '*' in the asm string.
 100     bool isIndirect;
 101
 102     /// Code - The constraint code, either the register name (in braces) or the
 103     /// constraint letter/number.
 104     std::vector<std::string> Codes;
 105
 106     /// Parse - Analyze the specified string (e.g. "=*&{eax}") and fill in the
 107     /// fields in this structure.  If the constraint string is not understood,
 108     /// return true, otherwise return false.
 109     bool Parse(const std::string &Str,
 110                std::vector<InlineAsm::ConstraintInfo> &ConstraintsSoFar);
 111   };
 112
 113   /// ParseConstraints - Split up the constraint string into the specific
 114   /// constraints and their prefixes.  If this returns an empty vector, and if
 115   /// the constraint string itself isn't empty, there was an error parsing.
 116   static std::vector<ConstraintInfo>
 117     ParseConstraints(const std::string &ConstraintString);
 118
 119   /// ParseConstraints - Parse the constraints of this inlineasm object,
 120   /// returning them the same way that ParseConstraints(str) does.
 121   std::vector<ConstraintInfo>
 122   ParseConstraints() const {
 123     return ParseConstraints(Constraints);
 124   }
 125
 126   // Methods for support type inquiry through isa, cast, and dyn_cast:
 127   static inline bool classof(const InlineAsm *) { return true; }
 128   static inline bool classof(const Value *V) {
 129     return V->getValueID() == Value::InlineAsmVal;
 130   }
 131 };
 132
 133 } // End llvm namespace
 134
 135 // Make sure the InlineAsm.cpp file is linked when this one is #included.
 136 FORCE_DEFINING_FILE_TO_BE_LINKED(InlineAsm)
 137
 138 #endif