1 //===-- llvm/InlineAsm.h - Class to represent inline asm strings-*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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(...).
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_INLINEASM_H
17 #define LLVM_INLINEASM_H
19 #include "llvm/Value.h"
24 struct AssemblyAnnotationWriter;
29 class InlineAsm : public Value {
30 InlineAsm(const InlineAsm &); // do not implement
31 void operator=(const InlineAsm&); // do not implement
33 std::string AsmString, Constraints;
36 InlineAsm(const FunctionType *Ty, const std::string &AsmString,
37 const std::string &Constraints, bool hasSideEffects);
40 /// InlineAsm::get - Return the the specified uniqued inline asm string.
42 static InlineAsm *get(const FunctionType *Ty, const std::string &AsmString,
43 const std::string &Constraints, bool hasSideEffects);
45 bool hasSideEffects() const { return HasSideEffects; }
47 /// getType - InlineAsm's are always pointers.
49 const PointerType *getType() const {
50 return reinterpret_cast<const PointerType*>(Value::getType());
53 /// getFunctionType - InlineAsm's are always pointers to functions.
55 const FunctionType *getFunctionType() const;
57 const std::string &getAsmString() const { return AsmString; }
58 const std::string &getConstraintString() const { return Constraints; }
60 virtual void print(std::ostream &O) const { print(O, 0); }
61 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
63 /// Verify - This static method can be used by the parser to check to see if
64 /// the specified constraint string is legal for the type. This returns true
65 /// if legal, false if not.
67 static bool Verify(const FunctionType *Ty, const std::string &Constraints);
69 // Constraint String Parsing
70 enum ConstraintPrefix {
76 struct ConstraintInfo {
77 /// Type - The basic type of the constraint: input/output/clobber
79 ConstraintPrefix Type;
81 /// isEarlyClobber - "&": output operand writes result before inputs are all
82 /// read. This is only ever set for an output operand.
85 /// isIndirectOutput - If this is true for an output constraint, the address
86 /// to store the output result is passed as an operand to the call.
87 bool isIndirectOutput;
89 /// hasMatchingInput - This is set to true for an output constraint iff
90 /// there is an input constraint that is required to match it (e.g. "0").
91 bool hasMatchingInput;
93 /// isCommutative - This is set to true for a constraint that is commutative
94 /// with the next operand.
97 /// Code - The constraint code, either the register name (in braces) or the
98 /// constraint letter/number.
99 std::vector<std::string> Codes;
101 /// Parse - Analyze the specified string (e.g. "==&{eax}") and fill in the
102 /// fields in this structure. If the constraint string is not understood,
103 /// return true, otherwise return false.
104 bool Parse(const std::string &Str,
105 std::vector<InlineAsm::ConstraintInfo> &ConstraintsSoFar);
108 /// ParseConstraints - Split up the constraint string into the specific
109 /// constraints and their prefixes. If this returns an empty vector, and if
110 /// the constraint string itself isn't empty, there was an error parsing.
111 static std::vector<ConstraintInfo>
112 ParseConstraints(const std::string &ConstraintString);
114 /// ParseConstraints - Parse the constraints of this inlineasm object,
115 /// returning them the same way that ParseConstraints(str) does.
116 std::vector<ConstraintInfo>
117 ParseConstraints() const {
118 return ParseConstraints(Constraints);
121 // Methods for support type inquiry through isa, cast, and dyn_cast:
122 static inline bool classof(const InlineAsm *) { return true; }
123 static inline bool classof(const Value *V) {
124 return V->getValueType() == Value::InlineAsmVal;
128 } // End llvm namespace