1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_MIRROR_EMULATED_STACK_FRAME_H_
18 #define ART_RUNTIME_MIRROR_EMULATED_STACK_FRAME_H_
19 
20 #include "base/utils.h"
21 #include "dex/dex_instruction.h"
22 #include "handle.h"
23 #include "object.h"
24 #include "stack.h"
25 
26 namespace art {
27 
28 struct EmulatedStackFrameOffsets;
29 
30 namespace mirror {
31 
32 class MethodType;
33 
34 // C++ mirror of dalvik.system.EmulatedStackFrame
35 class MANAGED EmulatedStackFrame : public Object {
36  public:
37   MIRROR_CLASS("Ldalvik/system/EmulatedStackFrame;");
38 
39   // Creates an emulated stack frame whose type is |frame_type| from
40   // a shadow frame.
41   static ObjPtr<mirror::EmulatedStackFrame> CreateFromShadowFrameAndArgs(
42       Thread* self,
43       Handle<mirror::MethodType> args_type,
44       Handle<mirror::MethodType> frame_type,
45       const ShadowFrame& caller_frame,
46       const InstructionOperands* const operands) REQUIRES_SHARED(Locks::mutator_lock_);
47 
48   // Writes the contents of this emulated stack frame to the |callee_frame|
49   // whose type is |callee_type|, starting at |first_dest_reg|.
50   bool WriteToShadowFrame(
51       Thread* self,
52       Handle<mirror::MethodType> callee_type,
53       const uint32_t first_dest_reg,
54       ShadowFrame* callee_frame) REQUIRES_SHARED(Locks::mutator_lock_);
55 
56   // Sets |value| to the return value written to this emulated stack frame (if any).
57   void GetReturnValue(Thread* self, JValue* value) REQUIRES_SHARED(Locks::mutator_lock_);
58 
59   // Sets the return value slot of this emulated stack frame to |value|.
60   void SetReturnValue(Thread* self, const JValue& value) REQUIRES_SHARED(Locks::mutator_lock_);
61 
62   ObjPtr<mirror::MethodType> GetType() REQUIRES_SHARED(Locks::mutator_lock_);
63 
64   ObjPtr<mirror::Object> GetReceiver() REQUIRES_SHARED(Locks::mutator_lock_);
65 
66  private:
67   ObjPtr<mirror::ObjectArray<mirror::Object>> GetReferences() REQUIRES_SHARED(Locks::mutator_lock_);
68 
69   ObjPtr<mirror::ByteArray> GetStackFrame() REQUIRES_SHARED(Locks::mutator_lock_);
70 
CallsiteTypeOffset()71   static MemberOffset CallsiteTypeOffset() {
72     return MemberOffset(OFFSETOF_MEMBER(EmulatedStackFrame, callsite_type_));
73   }
74 
TypeOffset()75   static MemberOffset TypeOffset() {
76     return MemberOffset(OFFSETOF_MEMBER(EmulatedStackFrame, type_));
77   }
78 
ReferencesOffset()79   static MemberOffset ReferencesOffset() {
80     return MemberOffset(OFFSETOF_MEMBER(EmulatedStackFrame, references_));
81   }
82 
StackFrameOffset()83   static MemberOffset StackFrameOffset() {
84     return MemberOffset(OFFSETOF_MEMBER(EmulatedStackFrame, stack_frame_));
85   }
86 
87   HeapReference<mirror::MethodType> callsite_type_;
88   HeapReference<mirror::ObjectArray<mirror::Object>> references_;
89   HeapReference<mirror::ByteArray> stack_frame_;
90   HeapReference<mirror::MethodType> type_;
91 
92   friend struct art::EmulatedStackFrameOffsets;  // for verifying offset information
93   DISALLOW_IMPLICIT_CONSTRUCTORS(EmulatedStackFrame);
94 };
95 
96 }  // namespace mirror
97 }  // namespace art
98 
99 #endif  // ART_RUNTIME_MIRROR_EMULATED_STACK_FRAME_H_
100