1 /*
2  * Copyright (C) 2012 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_INTERPRETER_INTERPRETER_H_
18 #define ART_RUNTIME_INTERPRETER_INTERPRETER_H_
19 
20 #include "base/locks.h"
21 #include "dex/dex_file.h"
22 #include "obj_ptr.h"
23 
24 namespace art {
25 namespace mirror {
26 class Object;
27 }  // namespace mirror
28 
29 class ArtMethod;
30 class CodeItemDataAccessor;
31 union JValue;
32 class ShadowFrame;
33 class Thread;
34 enum class DeoptimizationMethodType;
35 
36 namespace interpreter {
37 
38 // Called by ArtMethod::Invoke, shadow frames arguments are taken from the args array.
39 // The optional stay_in_interpreter parameter (false by default) can be used by clients to
40 // explicitly force interpretation in the remaining path that implements method invocation.
41 extern void EnterInterpreterFromInvoke(Thread* self, ArtMethod* method,
42                                        ObjPtr<mirror::Object> receiver,
43                                        uint32_t* args,
44                                        JValue* result,
45                                        bool stay_in_interpreter = false)
46     REQUIRES_SHARED(Locks::mutator_lock_);
47 
48 // 'from_code' denotes whether the deoptimization was explicitly triggered by compiled code.
49 extern void EnterInterpreterFromDeoptimize(Thread* self,
50                                            ShadowFrame* shadow_frame,
51                                            JValue* ret_val,
52                                            bool from_code,
53                                            DeoptimizationMethodType method_type)
54     REQUIRES_SHARED(Locks::mutator_lock_);
55 
56 extern JValue EnterInterpreterFromEntryPoint(Thread* self,
57                                              const CodeItemDataAccessor& accessor,
58                                              ShadowFrame* shadow_frame)
59     REQUIRES_SHARED(Locks::mutator_lock_);
60 
61 void ArtInterpreterToInterpreterBridge(Thread* self,
62                                        const CodeItemDataAccessor& accessor,
63                                        ShadowFrame* shadow_frame,
64                                        JValue* result)
65     REQUIRES_SHARED(Locks::mutator_lock_);
66 
67 // One-time sanity check.
68 void CheckInterpreterAsmConstants();
69 
70 void InitInterpreterTls(Thread* self);
71 
72 // Returns true if the previous frame has the ForceRetryInstruction bit set. This is required for
73 // ForPopFrame to work correctly since that will cause the java function return with null/0 which
74 // might not be expected by the code being run.
75 bool PrevFrameWillRetry(Thread* self, const ShadowFrame& frame)
76     REQUIRES_SHARED(Locks::mutator_lock_);
77 
78 }  // namespace interpreter
79 
80 }  // namespace art
81 
82 #endif  // ART_RUNTIME_INTERPRETER_INTERPRETER_H_
83