Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 1 | // Copyright 2011 Google Inc. All Rights Reserved. |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 2 | |
| 3 | #ifndef ART_SRC_CALLING_CONVENTION_H_ |
| 4 | #define ART_SRC_CALLING_CONVENTION_H_ |
| 5 | |
Ian Rogers | 0d666d8 | 2011-08-14 16:03:46 -0700 | [diff] [blame] | 6 | #include <vector> |
Brian Carlstrom | 578bbdc | 2011-07-21 14:07:47 -0700 | [diff] [blame] | 7 | #include "managed_register.h" |
| 8 | #include "object.h" |
Elliott Hughes | 68e7652 | 2011-10-05 13:22:16 -0700 | [diff] [blame] | 9 | #include "stack_indirect_reference_table.h" |
Brian Carlstrom | 578bbdc | 2011-07-21 14:07:47 -0700 | [diff] [blame] | 10 | #include "thread.h" |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 11 | |
| 12 | namespace art { |
| 13 | |
| 14 | // Top-level abstraction for different calling conventions |
| 15 | class CallingConvention { |
| 16 | public: |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 17 | bool IsReturnAReference() const { return method_->IsReturnAReference(); } |
| 18 | |
Ian Rogers | df20fe0 | 2011-07-20 20:34:16 -0700 | [diff] [blame] | 19 | size_t SizeOfReturnValue() const { return method_->ReturnSize(); } |
| 20 | |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 21 | // Register that holds result of this method |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 22 | virtual ManagedRegister ReturnRegister() = 0; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 23 | // Register reserved for scratch usage during procedure calls |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 24 | virtual ManagedRegister InterproceduralScratchRegister() = 0; |
Shih-wei Liao | 668512a | 2011-09-01 14:18:34 -0700 | [diff] [blame] | 25 | |
Carl Shapiro | e2d373e | 2011-07-25 15:20:06 -0700 | [diff] [blame] | 26 | // Offset of Method within the frame |
| 27 | FrameOffset MethodStackOffset(); |
| 28 | |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 29 | // Iterator interface |
| 30 | |
| 31 | // Place iterator at start of arguments. The displacement is applied to |
| 32 | // frame offset methods to account for frames which may be on the stack |
| 33 | // below the one being iterated over. |
| 34 | void ResetIterator(FrameOffset displacement) { |
| 35 | displacement_ = displacement; |
Shih-wei Liao | 5381cf9 | 2011-07-27 00:28:04 -0700 | [diff] [blame] | 36 | itr_slots_ = 0; |
| 37 | itr_args_ = 0; |
Shih-wei Liao | 668512a | 2011-09-01 14:18:34 -0700 | [diff] [blame] | 38 | itr_refs_ = 0; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 39 | itr_longs_and_doubles_ = 0; |
| 40 | } |
| 41 | |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 42 | virtual ~CallingConvention() {} |
| 43 | |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 44 | protected: |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 45 | explicit CallingConvention(const Method* method) |
| 46 | : displacement_(0), method_(const_cast<Method*>(method)) {} |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 47 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 48 | const Method* GetMethod() const { return method_; } |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 49 | |
Shih-wei Liao | 5381cf9 | 2011-07-27 00:28:04 -0700 | [diff] [blame] | 50 | // The slot number for current calling_convention argument. |
| 51 | // Note that each slot is 32-bit. When the current argument is bigger |
| 52 | // than 32 bits, return the first slot number for this argument. |
| 53 | unsigned int itr_slots_; |
Ian Rogers | 7a99c11 | 2011-09-07 12:48:27 -0700 | [diff] [blame] | 54 | // The number of references iterated past |
| 55 | unsigned int itr_refs_; |
Shih-wei Liao | 5381cf9 | 2011-07-27 00:28:04 -0700 | [diff] [blame] | 56 | // The argument number along argument list for current argument |
| 57 | unsigned int itr_args_; |
| 58 | // Number of longs and doubles seen along argument list |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 59 | unsigned int itr_longs_and_doubles_; |
| 60 | // Space for frames below this on the stack |
| 61 | FrameOffset displacement_; |
| 62 | |
| 63 | private: |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 64 | Method* method_; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 65 | }; |
| 66 | |
| 67 | // Abstraction for managed code's calling conventions |
Ian Rogers | bdb0391 | 2011-09-14 00:55:44 -0700 | [diff] [blame] | 68 | // | { Incoming stack args } | |
| 69 | // | { Prior Method* } | <-- Prior SP |
| 70 | // | { Return address } | |
| 71 | // | { Callee saves } | |
| 72 | // | { Spills ... } | |
| 73 | // | { Outgoing stack args } | |
| 74 | // | { Method* } | <-- SP |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 75 | class ManagedRuntimeCallingConvention : public CallingConvention { |
| 76 | public: |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 77 | static ManagedRuntimeCallingConvention* Create(const Method* native_method, |
| 78 | InstructionSet instruction_set); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 79 | |
| 80 | size_t FrameSize(); |
| 81 | |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 82 | // Register that holds the incoming method argument |
| 83 | virtual ManagedRegister MethodRegister() = 0; |
| 84 | |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 85 | // Iterator interface |
| 86 | bool HasNext(); |
| 87 | void Next(); |
| 88 | bool IsCurrentParamAReference(); |
Ian Rogers | 7a99c11 | 2011-09-07 12:48:27 -0700 | [diff] [blame] | 89 | bool IsCurrentArgExplicit(); // ie a non-implict argument such as this |
| 90 | bool IsCurrentArgPossiblyNull(); |
Ian Rogers | df20fe0 | 2011-07-20 20:34:16 -0700 | [diff] [blame] | 91 | size_t CurrentParamSize(); |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 92 | virtual bool IsCurrentParamInRegister() = 0; |
| 93 | virtual bool IsCurrentParamOnStack() = 0; |
| 94 | virtual ManagedRegister CurrentParamRegister() = 0; |
| 95 | virtual FrameOffset CurrentParamStackOffset() = 0; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 96 | |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 97 | virtual ~ManagedRuntimeCallingConvention() {} |
| 98 | |
| 99 | protected: |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 100 | explicit ManagedRuntimeCallingConvention(const Method* method) : |
Ian Rogers | bdb0391 | 2011-09-14 00:55:44 -0700 | [diff] [blame] | 101 | CallingConvention(method) {} |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 102 | }; |
| 103 | |
| 104 | // Abstraction for JNI calling conventions |
Ian Rogers | bdb0391 | 2011-09-14 00:55:44 -0700 | [diff] [blame] | 105 | // | { Incoming stack args } | <-- Prior SP |
| 106 | // | { Return address } | |
| 107 | // | { Callee saves } | ([1]) |
| 108 | // | { Return value spill } | (live on return slow paths) |
Ian Rogers | dc51b79 | 2011-09-22 20:41:37 -0700 | [diff] [blame] | 109 | // | { Local Ref. Table State } | |
Ian Rogers | bdb0391 | 2011-09-14 00:55:44 -0700 | [diff] [blame] | 110 | // | { Stack Indirect Ref. Table | |
| 111 | // | num. refs./link } | (here to prior SP is frame size) |
| 112 | // | { Method* } | <-- Anchor SP written to thread |
| 113 | // | { Outgoing stack args } | <-- SP at point of call |
| 114 | // | Native frame | |
| 115 | // |
| 116 | // [1] We must save all callee saves here to enable any exception throws to restore |
| 117 | // callee saves for frames above this one. |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 118 | class JniCallingConvention : public CallingConvention { |
| 119 | public: |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 120 | static JniCallingConvention* Create(const Method* native_method, |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 121 | InstructionSet instruction_set); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 122 | |
| 123 | // Size of frame excluding space for outgoing args (its assumed Method* is |
| 124 | // always at the bottom of a frame, but this doesn't work for outgoing |
| 125 | // native args). Includes alignment. |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 126 | virtual size_t FrameSize() = 0; |
Ian Rogers | 762400c | 2011-08-23 12:14:16 -0700 | [diff] [blame] | 127 | // Offset within the frame of the return pc |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 128 | virtual size_t ReturnPcOffset() = 0; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 129 | // Size of outgoing arguments, including alignment |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 130 | virtual size_t OutArgSize() = 0; |
Ian Rogers | 408f79a | 2011-08-23 18:22:33 -0700 | [diff] [blame] | 131 | // Number of references in stack indirect reference table |
Ian Rogers | dc51b79 | 2011-09-22 20:41:37 -0700 | [diff] [blame] | 132 | size_t ReferenceCount() const; |
| 133 | // Location where the segment state of the local indirect reference table is saved |
Ian Rogers | 5a7a74a | 2011-09-26 16:32:29 -0700 | [diff] [blame] | 134 | FrameOffset SavedLocalReferenceCookieOffset() const; |
Ian Rogers | df20fe0 | 2011-07-20 20:34:16 -0700 | [diff] [blame] | 135 | // Location where the return value of a call can be squirreled if another |
| 136 | // call is made following the native call |
Ian Rogers | dc51b79 | 2011-09-22 20:41:37 -0700 | [diff] [blame] | 137 | FrameOffset ReturnValueSaveLocation() const; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 138 | |
Ian Rogers | bdb0391 | 2011-09-14 00:55:44 -0700 | [diff] [blame] | 139 | // Callee save registers to spill prior to native code (which may clobber) |
| 140 | virtual const std::vector<ManagedRegister>& CalleeSaveRegisters() const = 0; |
| 141 | |
| 142 | // Spill mask values |
| 143 | virtual uint32_t CoreSpillMask() const = 0; |
| 144 | virtual uint32_t FpSpillMask() const = 0; |
Ian Rogers | 0d666d8 | 2011-08-14 16:03:46 -0700 | [diff] [blame] | 145 | |
Ian Rogers | 67375ac | 2011-09-14 00:55:44 -0700 | [diff] [blame] | 146 | // Returns true if the method register will have been clobbered during argument |
| 147 | // set up |
Ian Rogers | ad42e13 | 2011-09-17 20:23:33 -0700 | [diff] [blame] | 148 | virtual bool IsMethodRegisterClobberedPreCall() = 0; |
Carl Shapiro | e2d373e | 2011-07-25 15:20:06 -0700 | [diff] [blame] | 149 | |
Ian Rogers | dc51b79 | 2011-09-22 20:41:37 -0700 | [diff] [blame] | 150 | // An extra scratch register live after the call |
| 151 | virtual ManagedRegister ReturnScratchRegister() const = 0; |
| 152 | |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 153 | // Iterator interface |
| 154 | bool HasNext(); |
Ian Rogers | 67375ac | 2011-09-14 00:55:44 -0700 | [diff] [blame] | 155 | virtual void Next(); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 156 | bool IsCurrentParamAReference(); |
Ian Rogers | df20fe0 | 2011-07-20 20:34:16 -0700 | [diff] [blame] | 157 | size_t CurrentParamSize(); |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 158 | virtual bool IsCurrentParamInRegister() = 0; |
| 159 | virtual bool IsCurrentParamOnStack() = 0; |
| 160 | virtual ManagedRegister CurrentParamRegister() = 0; |
| 161 | virtual FrameOffset CurrentParamStackOffset() = 0; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 162 | |
| 163 | // Iterator interface extension for JNI |
Ian Rogers | 408f79a | 2011-08-23 18:22:33 -0700 | [diff] [blame] | 164 | FrameOffset CurrentParamSirtEntryOffset(); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 165 | |
Ian Rogers | 408f79a | 2011-08-23 18:22:33 -0700 | [diff] [blame] | 166 | // Position of SIRT and interior fields |
Ian Rogers | dc51b79 | 2011-09-22 20:41:37 -0700 | [diff] [blame] | 167 | FrameOffset SirtOffset() const { |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 168 | return FrameOffset(displacement_.Int32Value() + |
| 169 | kPointerSize); // above Method* |
| 170 | } |
Ian Rogers | dc51b79 | 2011-09-22 20:41:37 -0700 | [diff] [blame] | 171 | FrameOffset SirtNumRefsOffset() const { |
Ian Rogers | 408f79a | 2011-08-23 18:22:33 -0700 | [diff] [blame] | 172 | return FrameOffset(SirtOffset().Int32Value() + |
| 173 | StackIndirectReferenceTable::NumberOfReferencesOffset()); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 174 | } |
Ian Rogers | dc51b79 | 2011-09-22 20:41:37 -0700 | [diff] [blame] | 175 | FrameOffset SirtLinkOffset() const { |
Ian Rogers | 408f79a | 2011-08-23 18:22:33 -0700 | [diff] [blame] | 176 | return FrameOffset(SirtOffset().Int32Value() + |
| 177 | StackIndirectReferenceTable::LinkOffset()); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 178 | } |
| 179 | |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 180 | virtual ~JniCallingConvention() {} |
| 181 | |
| 182 | protected: |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 183 | // Named iterator positions |
| 184 | enum IteratorPos { |
| 185 | kJniEnv = 0, |
| 186 | kObjectOrClass = 1 |
| 187 | }; |
| 188 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 189 | explicit JniCallingConvention(const Method* native_method) : |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 190 | CallingConvention(native_method) {} |
| 191 | |
Ian Rogers | 408f79a | 2011-08-23 18:22:33 -0700 | [diff] [blame] | 192 | // Number of stack slots for outgoing arguments, above which the SIRT is |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 193 | // located |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 194 | virtual size_t NumberOfOutgoingStackArgs() = 0; |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 195 | |
Ian Rogers | 2c8f653 | 2011-09-02 17:16:34 -0700 | [diff] [blame] | 196 | protected: |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 197 | static size_t NumberOfExtraArgumentsForJni(const Method* method); |
Ian Rogers | b033c75 | 2011-07-20 12:22:35 -0700 | [diff] [blame] | 198 | }; |
| 199 | |
| 200 | } // namespace art |
| 201 | |
| 202 | #endif // ART_SRC_CALLING_CONVENTION_H_ |