Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 1 | //===----- CGCall.h - Encapsulate calling convention details ----*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // These classes wrap the information about a call or function |
| 11 | // definition used to handle ABI compliancy. |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 15 | #ifndef LLVM_CLANG_LIB_CODEGEN_CGCALL_H |
| 16 | #define LLVM_CLANG_LIB_CODEGEN_CGCALL_H |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 17 | |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 18 | #include "CGValue.h" |
Reid Kleckner | 9b60195 | 2013-06-21 12:45:15 +0000 | [diff] [blame] | 19 | #include "EHScopeStack.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 20 | #include "clang/AST/CanonicalType.h" |
| 21 | #include "clang/AST/Type.h" |
Anders Carlsson | 31777a2 | 2009-12-24 19:08:58 +0000 | [diff] [blame] | 22 | #include "llvm/ADT/FoldingSet.h" |
Chandler Carruth | 3b844ba | 2013-01-02 11:45:17 +0000 | [diff] [blame] | 23 | #include "llvm/IR/Value.h" |
Daniel Dunbar | 46f45b9 | 2008-09-09 01:06:48 +0000 | [diff] [blame] | 24 | |
Daniel Dunbar | 88c2fa9 | 2009-02-03 05:31:23 +0000 | [diff] [blame] | 25 | // FIXME: Restructure so we don't have to expose so much stuff. |
| 26 | #include "ABIInfo.h" |
| 27 | |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 28 | namespace llvm { |
Bill Wendling | b263bdf | 2013-01-27 02:46:53 +0000 | [diff] [blame] | 29 | class AttributeSet; |
Daniel Dunbar | 88c2fa9 | 2009-02-03 05:31:23 +0000 | [diff] [blame] | 30 | class Function; |
| 31 | class Type; |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 32 | class Value; |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 33 | } |
| 34 | |
| 35 | namespace clang { |
| 36 | class ASTContext; |
| 37 | class Decl; |
| 38 | class FunctionDecl; |
| 39 | class ObjCMethodDecl; |
Daniel Dunbar | 7c08651 | 2008-09-09 23:14:03 +0000 | [diff] [blame] | 40 | class VarDecl; |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 41 | |
| 42 | namespace CodeGen { |
Bill Wendling | b263bdf | 2013-01-27 02:46:53 +0000 | [diff] [blame] | 43 | typedef SmallVector<llvm::AttributeSet, 8> AttributeListType; |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 44 | |
Eli Friedman | c6d0782 | 2011-05-02 18:05:27 +0000 | [diff] [blame] | 45 | struct CallArg { |
| 46 | RValue RV; |
| 47 | QualType Ty; |
Eli Friedman | 55d4848 | 2011-05-26 00:10:27 +0000 | [diff] [blame] | 48 | bool NeedsCopy; |
| 49 | CallArg(RValue rv, QualType ty, bool needscopy) |
| 50 | : RV(rv), Ty(ty), NeedsCopy(needscopy) |
Eli Friedman | c6d0782 | 2011-05-02 18:05:27 +0000 | [diff] [blame] | 51 | { } |
| 52 | }; |
| 53 | |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 54 | /// CallArgList - Type for representing both the value and type of |
| 55 | /// arguments in a call. |
John McCall | d26bc76 | 2011-03-09 04:27:21 +0000 | [diff] [blame] | 56 | class CallArgList : |
Chris Lattner | 686775d | 2011-07-20 06:58:45 +0000 | [diff] [blame] | 57 | public SmallVector<CallArg, 16> { |
John McCall | 413ebdb | 2011-03-11 20:59:21 +0000 | [diff] [blame] | 58 | public: |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 59 | CallArgList() : StackBase(nullptr) {} |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 60 | |
John McCall | f85e193 | 2011-06-15 23:02:42 +0000 | [diff] [blame] | 61 | struct Writeback { |
John McCall | b6a6079 | 2013-03-23 02:35:54 +0000 | [diff] [blame] | 62 | /// The original argument. Note that the argument l-value |
| 63 | /// is potentially null. |
| 64 | LValue Source; |
John McCall | f85e193 | 2011-06-15 23:02:42 +0000 | [diff] [blame] | 65 | |
| 66 | /// The temporary alloca. |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 67 | Address Temporary; |
John McCall | b6a6079 | 2013-03-23 02:35:54 +0000 | [diff] [blame] | 68 | |
| 69 | /// A value to "use" after the writeback, or null. |
| 70 | llvm::Value *ToUse; |
John McCall | f85e193 | 2011-06-15 23:02:42 +0000 | [diff] [blame] | 71 | }; |
| 72 | |
Reid Kleckner | 9b60195 | 2013-06-21 12:45:15 +0000 | [diff] [blame] | 73 | struct CallArgCleanup { |
| 74 | EHScopeStack::stable_iterator Cleanup; |
| 75 | |
| 76 | /// The "is active" insertion point. This instruction is temporary and |
| 77 | /// will be removed after insertion. |
| 78 | llvm::Instruction *IsActiveIP; |
| 79 | }; |
| 80 | |
Eli Friedman | 55d4848 | 2011-05-26 00:10:27 +0000 | [diff] [blame] | 81 | void add(RValue rvalue, QualType type, bool needscopy = false) { |
| 82 | push_back(CallArg(rvalue, type, needscopy)); |
John McCall | 413ebdb | 2011-03-11 20:59:21 +0000 | [diff] [blame] | 83 | } |
John McCall | f85e193 | 2011-06-15 23:02:42 +0000 | [diff] [blame] | 84 | |
| 85 | void addFrom(const CallArgList &other) { |
| 86 | insert(end(), other.begin(), other.end()); |
| 87 | Writebacks.insert(Writebacks.end(), |
| 88 | other.Writebacks.begin(), other.Writebacks.end()); |
| 89 | } |
| 90 | |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 91 | void addWriteback(LValue srcLV, Address temporary, |
John McCall | b6a6079 | 2013-03-23 02:35:54 +0000 | [diff] [blame] | 92 | llvm::Value *toUse) { |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 93 | Writeback writeback = { srcLV, temporary, toUse }; |
John McCall | f85e193 | 2011-06-15 23:02:42 +0000 | [diff] [blame] | 94 | Writebacks.push_back(writeback); |
| 95 | } |
| 96 | |
| 97 | bool hasWritebacks() const { return !Writebacks.empty(); } |
| 98 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 99 | typedef llvm::iterator_range<SmallVectorImpl<Writeback>::const_iterator> |
| 100 | writeback_const_range; |
| 101 | |
| 102 | writeback_const_range writebacks() const { |
| 103 | return writeback_const_range(Writebacks.begin(), Writebacks.end()); |
| 104 | } |
John McCall | f85e193 | 2011-06-15 23:02:42 +0000 | [diff] [blame] | 105 | |
Reid Kleckner | 9b60195 | 2013-06-21 12:45:15 +0000 | [diff] [blame] | 106 | void addArgCleanupDeactivation(EHScopeStack::stable_iterator Cleanup, |
| 107 | llvm::Instruction *IsActiveIP) { |
| 108 | CallArgCleanup ArgCleanup; |
| 109 | ArgCleanup.Cleanup = Cleanup; |
| 110 | ArgCleanup.IsActiveIP = IsActiveIP; |
| 111 | CleanupsToDeactivate.push_back(ArgCleanup); |
| 112 | } |
| 113 | |
| 114 | ArrayRef<CallArgCleanup> getCleanupsToDeactivate() const { |
| 115 | return CleanupsToDeactivate; |
| 116 | } |
| 117 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 118 | void allocateArgumentMemory(CodeGenFunction &CGF); |
| 119 | llvm::Instruction *getStackBase() const { return StackBase; } |
| 120 | void freeArgumentMemory(CodeGenFunction &CGF) const; |
| 121 | |
| 122 | /// \brief Returns if we're using an inalloca struct to pass arguments in |
| 123 | /// memory. |
| 124 | bool isUsingInAlloca() const { return StackBase; } |
| 125 | |
John McCall | f85e193 | 2011-06-15 23:02:42 +0000 | [diff] [blame] | 126 | private: |
Chris Lattner | 686775d | 2011-07-20 06:58:45 +0000 | [diff] [blame] | 127 | SmallVector<Writeback, 1> Writebacks; |
Reid Kleckner | 9b60195 | 2013-06-21 12:45:15 +0000 | [diff] [blame] | 128 | |
| 129 | /// Deactivate these cleanups immediately before making the call. This |
| 130 | /// is used to cleanup objects that are owned by the callee once the call |
| 131 | /// occurs. |
| 132 | SmallVector<CallArgCleanup, 1> CleanupsToDeactivate; |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 133 | |
| 134 | /// The stacksave call. It dominates all of the argument evaluation. |
| 135 | llvm::CallInst *StackBase; |
| 136 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 137 | /// The iterator pointing to the stack restore cleanup. We manually run and |
| 138 | /// deactivate this cleanup after the call in the unexceptional case because |
| 139 | /// it doesn't run in the normal order. |
| 140 | EHScopeStack::stable_iterator StackCleanup; |
John McCall | d26bc76 | 2011-03-09 04:27:21 +0000 | [diff] [blame] | 141 | }; |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 142 | |
Daniel Dunbar | 7c08651 | 2008-09-09 23:14:03 +0000 | [diff] [blame] | 143 | /// FunctionArgList - Type for representing both the decl and type |
| 144 | /// of parameters to a function. The decl must be either a |
| 145 | /// ParmVarDecl or ImplicitParamDecl. |
Chris Lattner | 686775d | 2011-07-20 06:58:45 +0000 | [diff] [blame] | 146 | class FunctionArgList : public SmallVector<const VarDecl*, 16> { |
John McCall | d26bc76 | 2011-03-09 04:27:21 +0000 | [diff] [blame] | 147 | }; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 148 | |
Anders Carlsson | d2490a9 | 2009-12-24 20:40:36 +0000 | [diff] [blame] | 149 | /// ReturnValueSlot - Contains the address where the return value of a |
| 150 | /// function can be stored, and whether the address is volatile or not. |
Anders Carlsson | 31777a2 | 2009-12-24 19:08:58 +0000 | [diff] [blame] | 151 | class ReturnValueSlot { |
Pirama Arumuga Nainar | b6d6993 | 2015-07-01 12:25:36 -0700 | [diff] [blame] | 152 | llvm::PointerIntPair<llvm::Value *, 2, unsigned int> Value; |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 153 | CharUnits Alignment; |
Pirama Arumuga Nainar | b6d6993 | 2015-07-01 12:25:36 -0700 | [diff] [blame] | 154 | |
| 155 | // Return value slot flags |
| 156 | enum Flags { |
| 157 | IS_VOLATILE = 0x1, |
| 158 | IS_UNUSED = 0x2, |
| 159 | }; |
Anders Carlsson | 31777a2 | 2009-12-24 19:08:58 +0000 | [diff] [blame] | 160 | |
| 161 | public: |
| 162 | ReturnValueSlot() {} |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 163 | ReturnValueSlot(Address Addr, bool IsVolatile, bool IsUnused = false) |
| 164 | : Value(Addr.isValid() ? Addr.getPointer() : nullptr, |
| 165 | (IsVolatile ? IS_VOLATILE : 0) | (IsUnused ? IS_UNUSED : 0)), |
| 166 | Alignment(Addr.isValid() ? Addr.getAlignment() : CharUnits::Zero()) {} |
Anders Carlsson | 31777a2 | 2009-12-24 19:08:58 +0000 | [diff] [blame] | 167 | |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 168 | bool isNull() const { return !getValue().isValid(); } |
Pirama Arumuga Nainar | b6d6993 | 2015-07-01 12:25:36 -0700 | [diff] [blame] | 169 | |
| 170 | bool isVolatile() const { return Value.getInt() & IS_VOLATILE; } |
Pirama Arumuga Nainar | 87d948e | 2016-03-03 15:49:35 -0800 | [diff] [blame] | 171 | Address getValue() const { return Address(Value.getPointer(), Alignment); } |
Pirama Arumuga Nainar | b6d6993 | 2015-07-01 12:25:36 -0700 | [diff] [blame] | 172 | bool isUnused() const { return Value.getInt() & IS_UNUSED; } |
Anders Carlsson | 31777a2 | 2009-12-24 19:08:58 +0000 | [diff] [blame] | 173 | }; |
| 174 | |
Daniel Dunbar | 0dbe227 | 2008-09-08 21:33:45 +0000 | [diff] [blame] | 175 | } // end namespace CodeGen |
| 176 | } // end namespace clang |
| 177 | |
| 178 | #endif |