blob: 2e850642e4d3aa8476bc3911207815499fab5bee [file] [log] [blame]
Sebastien Hertz8ece0502013-08-07 11:26:41 +02001/*
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_COMMON_H_
18#define ART_RUNTIME_INTERPRETER_INTERPRETER_COMMON_H_
19
20#include "interpreter.h"
21
22#include <math.h>
23
Ian Rogerscf7f1912014-10-22 22:06:39 -070024#include <iostream>
Ian Rogersc7dd2952014-10-21 23:31:19 -070025#include <sstream>
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -070026#include <atomic>
Ian Rogersc7dd2952014-10-21 23:31:19 -070027
Andreas Gampe46ee31b2016-12-14 10:11:49 -080028#include "android-base/stringprintf.h"
29
Mathieu Chartierc7853442015-03-27 14:35:38 -070030#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070031#include "art_method-inl.h"
Andreas Gampe542451c2016-07-26 09:02:02 -070032#include "base/enums.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020033#include "base/logging.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080034#include "base/macros.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020035#include "class_linker-inl.h"
36#include "common_throws.h"
37#include "dex_file-inl.h"
38#include "dex_instruction-inl.h"
Mingyao Yang98d1cc82014-05-15 17:02:16 -070039#include "entrypoints/entrypoint_utils-inl.h"
Mathieu Chartier0cd81352014-05-22 16:48:55 -070040#include "handle_scope-inl.h"
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +010041#include "jit/jit.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020042#include "mirror/class-inl.h"
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -070043#include "mirror/dex_cache.h"
44#include "mirror/method.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020045#include "mirror/object-inl.h"
46#include "mirror/object_array-inl.h"
Douglas Leung4965c022014-06-11 11:41:11 -070047#include "mirror/string-inl.h"
Mathieu Chartieref41db72016-10-25 15:08:01 -070048#include "obj_ptr.h"
Andreas Gampe03ec9302015-08-27 17:41:47 -070049#include "stack.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020050#include "thread.h"
51#include "well_known_classes.h"
52
Sebastien Hertz8ece0502013-08-07 11:26:41 +020053namespace art {
54namespace interpreter {
55
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +000056void ThrowNullPointerExceptionFromInterpreter()
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070057 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertzda843e12014-05-28 19:28:31 +020058
Andreas Gampe03ec9302015-08-27 17:41:47 -070059template <bool kMonitorCounting>
Mathieu Chartieref41db72016-10-25 15:08:01 -070060static inline void DoMonitorEnter(Thread* self, ShadowFrame* frame, ObjPtr<mirror::Object> ref)
Mathieu Chartier2d096c92015-10-12 16:18:20 -070061 NO_THREAD_SAFETY_ANALYSIS
62 REQUIRES(!Roles::uninterruptible_) {
63 StackHandleScope<1> hs(self);
Mathieu Chartieref41db72016-10-25 15:08:01 -070064 Handle<mirror::Object> h_ref(hs.NewHandle(ref));
Mathieu Chartier2d096c92015-10-12 16:18:20 -070065 h_ref->MonitorEnter(self);
Andreas Gampe56fdd0e2016-04-28 14:56:54 -070066 if (kMonitorCounting && frame->GetMethod()->MustCountLocks()) {
67 frame->GetLockCountData().AddMonitor(self, h_ref.Get());
68 }
Sebastien Hertz8ece0502013-08-07 11:26:41 +020069}
70
Andreas Gampe03ec9302015-08-27 17:41:47 -070071template <bool kMonitorCounting>
Mathieu Chartieref41db72016-10-25 15:08:01 -070072static inline void DoMonitorExit(Thread* self, ShadowFrame* frame, ObjPtr<mirror::Object> ref)
Mathieu Chartier2d096c92015-10-12 16:18:20 -070073 NO_THREAD_SAFETY_ANALYSIS
74 REQUIRES(!Roles::uninterruptible_) {
75 StackHandleScope<1> hs(self);
Mathieu Chartieref41db72016-10-25 15:08:01 -070076 Handle<mirror::Object> h_ref(hs.NewHandle(ref));
Mathieu Chartier2d096c92015-10-12 16:18:20 -070077 h_ref->MonitorExit(self);
Andreas Gampe56fdd0e2016-04-28 14:56:54 -070078 if (kMonitorCounting && frame->GetMethod()->MustCountLocks()) {
79 frame->GetLockCountData().RemoveMonitorOrThrow(self, h_ref.Get());
80 }
81}
82
83template <bool kMonitorCounting>
84static inline bool DoMonitorCheckOnExit(Thread* self, ShadowFrame* frame)
85 NO_THREAD_SAFETY_ANALYSIS
86 REQUIRES(!Roles::uninterruptible_) {
87 if (kMonitorCounting && frame->GetMethod()->MustCountLocks()) {
88 return frame->GetLockCountData().CheckAllMonitorsReleasedOrThrow(self);
89 }
90 return true;
Sebastien Hertz8ece0502013-08-07 11:26:41 +020091}
92
Sebastien Hertz45b15972015-04-03 16:07:05 +020093void AbortTransactionF(Thread* self, const char* fmt, ...)
94 __attribute__((__format__(__printf__, 2, 3)))
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070095 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz45b15972015-04-03 16:07:05 +020096
97void AbortTransactionV(Thread* self, const char* fmt, va_list args)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070098 REQUIRES_SHARED(Locks::mutator_lock_);
Mathieu Chartierb2c7ead2014-04-29 11:13:16 -070099
Mathieu Chartieref41db72016-10-25 15:08:01 -0700100void RecordArrayElementsInTransaction(ObjPtr<mirror::Array> array, int32_t count)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700101 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100102
Sebastien Hertzc6714852013-09-30 16:42:32 +0200103// Invokes the given method. This is part of the invocation support and is used by DoInvoke and
104// DoInvokeVirtualQuick functions.
105// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200106template<bool is_range, bool do_assignability_check>
Ian Rogerse94652f2014-12-02 11:13:19 -0800107bool DoCall(ArtMethod* called_method, Thread* self, ShadowFrame& shadow_frame,
Sebastien Hertzc6714852013-09-30 16:42:32 +0200108 const Instruction* inst, uint16_t inst_data, JValue* result);
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200109
Narayan Kamath9823e782016-08-03 12:46:58 +0100110// Handles all invoke-XXX/range instructions except for invoke-polymorphic[/range].
Sebastien Hertzc6714852013-09-30 16:42:32 +0200111// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200112template<InvokeType type, bool is_range, bool do_access_check>
Mathieu Chartieref41db72016-10-25 15:08:01 -0700113static inline bool DoInvoke(Thread* self,
114 ShadowFrame& shadow_frame,
115 const Instruction* inst,
116 uint16_t inst_data,
117 JValue* result) {
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200118 const uint32_t method_idx = (is_range) ? inst->VRegB_3rc() : inst->VRegB_35c();
119 const uint32_t vregC = (is_range) ? inst->VRegC_3rc() : inst->VRegC_35c();
Mathieu Chartieref41db72016-10-25 15:08:01 -0700120 ObjPtr<mirror::Object> receiver = (type == kStatic) ? nullptr : shadow_frame.GetVRegReference(vregC);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700121 ArtMethod* sf_method = shadow_frame.GetMethod();
Ian Rogerse94652f2014-12-02 11:13:19 -0800122 ArtMethod* const called_method = FindMethodFromCode<type, do_access_check>(
Andreas Gampe3a357142015-08-07 17:20:11 -0700123 method_idx, &receiver, sf_method, self);
Mathieu Chartier0cd81352014-05-22 16:48:55 -0700124 // The shadow frame should already be pushed, so we don't need to update it.
Ian Rogerse94652f2014-12-02 11:13:19 -0800125 if (UNLIKELY(called_method == nullptr)) {
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200126 CHECK(self->IsExceptionPending());
127 result->SetJ(0);
128 return false;
Alex Light9139e002015-10-09 15:59:48 -0700129 } else if (UNLIKELY(!called_method->IsInvokable())) {
130 called_method->ThrowInvocationTimeError();
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200131 result->SetJ(0);
132 return false;
133 } else {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100134 jit::Jit* jit = Runtime::Current()->GetJit();
135 if (jit != nullptr) {
136 if (type == kVirtual || type == kInterface) {
Mathieu Chartier268764d2016-09-13 12:09:38 -0700137 jit->InvokeVirtualOrInterface(receiver, sf_method, shadow_frame.GetDexPC(), called_method);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100138 }
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100139 jit->AddSamples(self, sf_method, 1, /*with_backedges*/false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100140 }
141 // TODO: Remove the InvokeVirtualOrInterface instrumentation, as it was only used by the JIT.
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100142 if (type == kVirtual || type == kInterface) {
143 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
144 if (UNLIKELY(instrumentation->HasInvokeVirtualOrInterfaceListeners())) {
145 instrumentation->InvokeVirtualOrInterface(
Mathieu Chartieref41db72016-10-25 15:08:01 -0700146 self, receiver.Ptr(), sf_method, shadow_frame.GetDexPC(), called_method);
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100147 }
148 }
Ian Rogerse94652f2014-12-02 11:13:19 -0800149 return DoCall<is_range, do_access_check>(called_method, self, shadow_frame, inst, inst_data,
150 result);
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200151 }
152}
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200153
Narayan Kamath9823e782016-08-03 12:46:58 +0100154// Performs a signature polymorphic invoke (invoke-polymorphic/invoke-polymorphic-range).
155template<bool is_range, bool do_access_check>
156bool DoInvokePolymorphic(Thread* self, ShadowFrame& shadow_frame,
157 const Instruction* inst, uint16_t inst_data,
158 JValue* result);
159
Sebastien Hertzc6714852013-09-30 16:42:32 +0200160// Handles invoke-virtual-quick and invoke-virtual-quick-range instructions.
161// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200162template<bool is_range>
163static inline bool DoInvokeVirtualQuick(Thread* self, ShadowFrame& shadow_frame,
164 const Instruction* inst, uint16_t inst_data,
165 JValue* result) {
166 const uint32_t vregC = (is_range) ? inst->VRegC_3rc() : inst->VRegC_35c();
Mathieu Chartieref41db72016-10-25 15:08:01 -0700167 ObjPtr<mirror::Object> const receiver = shadow_frame.GetVRegReference(vregC);
Sebastien Hertzd4beb6b2013-10-02 17:07:20 +0200168 if (UNLIKELY(receiver == nullptr)) {
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200169 // We lost the reference to the method index so we cannot get a more
170 // precised exception message.
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +0000171 ThrowNullPointerExceptionFromDexPC();
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200172 return false;
173 }
174 const uint32_t vtable_idx = (is_range) ? inst->VRegB_3rc() : inst->VRegB_35c();
Hiroshi Yamauchia10ae782016-10-05 18:13:23 -0700175 // Debug code for b/31357497. To be removed.
176 if (kUseReadBarrier) {
177 CHECK(receiver->GetClass() != nullptr)
178 << "Null class found in object " << receiver << " in region type "
179 << Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->
Mathieu Chartieref41db72016-10-25 15:08:01 -0700180 RegionSpace()->GetRegionType(receiver.Ptr());
Hiroshi Yamauchia10ae782016-10-05 18:13:23 -0700181 }
Artem Udovichenkoa62cb9b2016-06-30 09:18:25 +0000182 CHECK(receiver->GetClass()->ShouldHaveEmbeddedVTable());
Mathieu Chartiere401d142015-04-22 13:56:20 -0700183 ArtMethod* const called_method = receiver->GetClass()->GetEmbeddedVTableEntry(
Andreas Gampe542451c2016-07-26 09:02:02 -0700184 vtable_idx, kRuntimePointerSize);
Ian Rogerse94652f2014-12-02 11:13:19 -0800185 if (UNLIKELY(called_method == nullptr)) {
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200186 CHECK(self->IsExceptionPending());
187 result->SetJ(0);
188 return false;
Alex Light9139e002015-10-09 15:59:48 -0700189 } else if (UNLIKELY(!called_method->IsInvokable())) {
190 called_method->ThrowInvocationTimeError();
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200191 result->SetJ(0);
192 return false;
193 } else {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100194 jit::Jit* jit = Runtime::Current()->GetJit();
195 if (jit != nullptr) {
196 jit->InvokeVirtualOrInterface(
Mathieu Chartier268764d2016-09-13 12:09:38 -0700197 receiver, shadow_frame.GetMethod(), shadow_frame.GetDexPC(), called_method);
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100198 jit->AddSamples(self, shadow_frame.GetMethod(), 1, /*with_backedges*/false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100199 }
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100200 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100201 // TODO: Remove the InvokeVirtualOrInterface instrumentation, as it was only used by the JIT.
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100202 if (UNLIKELY(instrumentation->HasInvokeVirtualOrInterfaceListeners())) {
203 instrumentation->InvokeVirtualOrInterface(
Mathieu Chartieref41db72016-10-25 15:08:01 -0700204 self, receiver.Ptr(), shadow_frame.GetMethod(), shadow_frame.GetDexPC(), called_method);
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100205 }
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200206 // No need to check since we've been quickened.
Ian Rogerse94652f2014-12-02 11:13:19 -0800207 return DoCall<is_range, false>(called_method, self, shadow_frame, inst, inst_data, result);
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200208 }
209}
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200210
Sebastien Hertzc6714852013-09-30 16:42:32 +0200211// Handles iget-XXX and sget-XXX instructions.
212// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200213template<FindFieldType find_type, Primitive::Type field_type, bool do_access_check>
Ian Rogers54874942014-06-10 16:31:03 -0700214bool DoFieldGet(Thread* self, ShadowFrame& shadow_frame, const Instruction* inst,
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700215 uint16_t inst_data) REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200216
Sebastien Hertzc6714852013-09-30 16:42:32 +0200217// Handles iget-quick, iget-wide-quick and iget-object-quick instructions.
218// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200219template<Primitive::Type field_type>
Ian Rogers54874942014-06-10 16:31:03 -0700220bool DoIGetQuick(ShadowFrame& shadow_frame, const Instruction* inst, uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700221 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz479fc1e2014-04-04 17:51:34 +0200222
Sebastien Hertzc6714852013-09-30 16:42:32 +0200223// Handles iput-XXX and sput-XXX instructions.
224// Returns true on success, otherwise throws an exception and returns false.
Ian Rogers54874942014-06-10 16:31:03 -0700225template<FindFieldType find_type, Primitive::Type field_type, bool do_access_check,
226 bool transaction_active>
227bool DoFieldPut(Thread* self, const ShadowFrame& shadow_frame, const Instruction* inst,
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700228 uint16_t inst_data) REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200229
Sebastien Hertzc6714852013-09-30 16:42:32 +0200230// Handles iput-quick, iput-wide-quick and iput-object-quick instructions.
231// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100232template<Primitive::Type field_type, bool transaction_active>
Ian Rogers54874942014-06-10 16:31:03 -0700233bool DoIPutQuick(const ShadowFrame& shadow_frame, const Instruction* inst, uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700234 REQUIRES_SHARED(Locks::mutator_lock_);
Ian Rogers54874942014-06-10 16:31:03 -0700235
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200236
Sebastien Hertzc6714852013-09-30 16:42:32 +0200237// Handles string resolution for const-string and const-string-jumbo instructions. Also ensures the
238// java.lang.String class is initialized.
Mathieu Chartieref41db72016-10-25 15:08:01 -0700239static inline ObjPtr<mirror::String> ResolveString(Thread* self,
240 ShadowFrame& shadow_frame,
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800241 dex::StringIndex string_idx)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700242 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartieref41db72016-10-25 15:08:01 -0700243 ObjPtr<mirror::Class> java_lang_string_class = mirror::String::GetJavaLangString();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200244 if (UNLIKELY(!java_lang_string_class->IsInitialized())) {
245 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700246 StackHandleScope<1> hs(self);
247 Handle<mirror::Class> h_class(hs.NewHandle(java_lang_string_class));
Ian Rogers7b078e82014-09-10 14:44:24 -0700248 if (UNLIKELY(!class_linker->EnsureInitialized(self, h_class, true, true))) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200249 DCHECK(self->IsExceptionPending());
Mathieu Chartierc528dba2013-11-26 12:00:11 -0800250 return nullptr;
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200251 }
252 }
Mathieu Chartiere401d142015-04-22 13:56:20 -0700253 ArtMethod* method = shadow_frame.GetMethod();
Alex Lightb81a9842016-12-15 00:59:05 +0000254 ObjPtr<mirror::Class> declaring_class = method->GetDeclaringClass();
Vladimir Marko05792b92015-08-03 11:56:49 +0100255 // MethodVerifier refuses methods with string_idx out of bounds.
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800256 DCHECK_LT(string_idx.index_ % mirror::DexCache::kDexCacheStringCacheSize,
Alex Lightb81a9842016-12-15 00:59:05 +0000257 declaring_class->GetDexFile().NumStringIds());
Mathieu Chartieref41db72016-10-25 15:08:01 -0700258 ObjPtr<mirror::String> string_ptr =
Alex Lightb81a9842016-12-15 00:59:05 +0000259 mirror::StringDexCachePair::Lookup(declaring_class->GetDexCacheStrings(),
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800260 string_idx.index_,
Narayan Kamathc38a6f82016-09-29 17:07:20 +0100261 mirror::DexCache::kDexCacheStringCacheSize).Read();
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -0700262 if (UNLIKELY(string_ptr == nullptr)) {
Ian Rogers6786a582014-10-28 12:49:06 -0700263 StackHandleScope<1> hs(self);
Alex Lightb81a9842016-12-15 00:59:05 +0000264 Handle<mirror::DexCache> dex_cache(hs.NewHandle(declaring_class->GetDexCache()));
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -0700265 string_ptr = Runtime::Current()->GetClassLinker()->ResolveString(*method->GetDexFile(),
266 string_idx,
267 dex_cache);
Ian Rogers6786a582014-10-28 12:49:06 -0700268 }
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -0700269 return string_ptr;
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200270}
271
Sebastien Hertzc6714852013-09-30 16:42:32 +0200272// Handles div-int, div-int/2addr, div-int/li16 and div-int/lit8 instructions.
273// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200274static inline bool DoIntDivide(ShadowFrame& shadow_frame, size_t result_reg,
275 int32_t dividend, int32_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700276 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersf72a11d2014-10-30 15:41:08 -0700277 constexpr int32_t kMinInt = std::numeric_limits<int32_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200278 if (UNLIKELY(divisor == 0)) {
279 ThrowArithmeticExceptionDivideByZero();
280 return false;
281 }
282 if (UNLIKELY(dividend == kMinInt && divisor == -1)) {
283 shadow_frame.SetVReg(result_reg, kMinInt);
284 } else {
285 shadow_frame.SetVReg(result_reg, dividend / divisor);
286 }
287 return true;
288}
289
Sebastien Hertzc6714852013-09-30 16:42:32 +0200290// Handles rem-int, rem-int/2addr, rem-int/li16 and rem-int/lit8 instructions.
291// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200292static inline bool DoIntRemainder(ShadowFrame& shadow_frame, size_t result_reg,
293 int32_t dividend, int32_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700294 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersf72a11d2014-10-30 15:41:08 -0700295 constexpr int32_t kMinInt = std::numeric_limits<int32_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200296 if (UNLIKELY(divisor == 0)) {
297 ThrowArithmeticExceptionDivideByZero();
298 return false;
299 }
300 if (UNLIKELY(dividend == kMinInt && divisor == -1)) {
301 shadow_frame.SetVReg(result_reg, 0);
302 } else {
303 shadow_frame.SetVReg(result_reg, dividend % divisor);
304 }
305 return true;
306}
307
Sebastien Hertzc6714852013-09-30 16:42:32 +0200308// Handles div-long and div-long-2addr instructions.
309// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Mathieu Chartieref41db72016-10-25 15:08:01 -0700310static inline bool DoLongDivide(ShadowFrame& shadow_frame,
311 size_t result_reg,
312 int64_t dividend,
313 int64_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700314 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2e2deeb2013-09-23 11:58:57 -0700315 const int64_t kMinLong = std::numeric_limits<int64_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200316 if (UNLIKELY(divisor == 0)) {
317 ThrowArithmeticExceptionDivideByZero();
318 return false;
319 }
320 if (UNLIKELY(dividend == kMinLong && divisor == -1)) {
321 shadow_frame.SetVRegLong(result_reg, kMinLong);
322 } else {
323 shadow_frame.SetVRegLong(result_reg, dividend / divisor);
324 }
325 return true;
326}
327
Sebastien Hertzc6714852013-09-30 16:42:32 +0200328// Handles rem-long and rem-long-2addr instructions.
329// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Mathieu Chartieref41db72016-10-25 15:08:01 -0700330static inline bool DoLongRemainder(ShadowFrame& shadow_frame,
331 size_t result_reg,
332 int64_t dividend,
333 int64_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700334 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2e2deeb2013-09-23 11:58:57 -0700335 const int64_t kMinLong = std::numeric_limits<int64_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200336 if (UNLIKELY(divisor == 0)) {
337 ThrowArithmeticExceptionDivideByZero();
338 return false;
339 }
340 if (UNLIKELY(dividend == kMinLong && divisor == -1)) {
341 shadow_frame.SetVRegLong(result_reg, 0);
342 } else {
343 shadow_frame.SetVRegLong(result_reg, dividend % divisor);
344 }
345 return true;
346}
347
Sebastien Hertzc6714852013-09-30 16:42:32 +0200348// Handles filled-new-array and filled-new-array-range instructions.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200349// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100350template <bool is_range, bool do_access_check, bool transaction_active>
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200351bool DoFilledNewArray(const Instruction* inst, const ShadowFrame& shadow_frame,
Sebastien Hertzc6714852013-09-30 16:42:32 +0200352 Thread* self, JValue* result);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200353
Sebastien Hertzc6714852013-09-30 16:42:32 +0200354// Handles packed-switch instruction.
355// Returns the branch offset to the next instruction to execute.
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200356static inline int32_t DoPackedSwitch(const Instruction* inst, const ShadowFrame& shadow_frame,
357 uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700358 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200359 DCHECK(inst->Opcode() == Instruction::PACKED_SWITCH);
360 const uint16_t* switch_data = reinterpret_cast<const uint16_t*>(inst) + inst->VRegB_31t();
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200361 int32_t test_val = shadow_frame.GetVReg(inst->VRegA_31t(inst_data));
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200362 DCHECK_EQ(switch_data[0], static_cast<uint16_t>(Instruction::kPackedSwitchSignature));
363 uint16_t size = switch_data[1];
David Brazdil2ef645b2015-06-17 18:20:52 +0100364 if (size == 0) {
365 // Empty packed switch, move forward by 3 (size of PACKED_SWITCH).
366 return 3;
367 }
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200368 const int32_t* keys = reinterpret_cast<const int32_t*>(&switch_data[2]);
Roland Levillain14d90572015-07-16 10:52:26 +0100369 DCHECK_ALIGNED(keys, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200370 int32_t first_key = keys[0];
371 const int32_t* targets = reinterpret_cast<const int32_t*>(&switch_data[4]);
Roland Levillain14d90572015-07-16 10:52:26 +0100372 DCHECK_ALIGNED(targets, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200373 int32_t index = test_val - first_key;
374 if (index >= 0 && index < size) {
375 return targets[index];
376 } else {
377 // No corresponding value: move forward by 3 (size of PACKED_SWITCH).
378 return 3;
379 }
380}
381
Sebastien Hertzc6714852013-09-30 16:42:32 +0200382// Handles sparse-switch instruction.
383// Returns the branch offset to the next instruction to execute.
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200384static inline int32_t DoSparseSwitch(const Instruction* inst, const ShadowFrame& shadow_frame,
385 uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700386 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200387 DCHECK(inst->Opcode() == Instruction::SPARSE_SWITCH);
388 const uint16_t* switch_data = reinterpret_cast<const uint16_t*>(inst) + inst->VRegB_31t();
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200389 int32_t test_val = shadow_frame.GetVReg(inst->VRegA_31t(inst_data));
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200390 DCHECK_EQ(switch_data[0], static_cast<uint16_t>(Instruction::kSparseSwitchSignature));
391 uint16_t size = switch_data[1];
Jeff Hao935e01a2015-03-20 19:44:35 -0700392 // Return length of SPARSE_SWITCH if size is 0.
393 if (size == 0) {
394 return 3;
395 }
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200396 const int32_t* keys = reinterpret_cast<const int32_t*>(&switch_data[2]);
Roland Levillain14d90572015-07-16 10:52:26 +0100397 DCHECK_ALIGNED(keys, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200398 const int32_t* entries = keys + size;
Roland Levillain14d90572015-07-16 10:52:26 +0100399 DCHECK_ALIGNED(entries, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200400 int lo = 0;
401 int hi = size - 1;
402 while (lo <= hi) {
403 int mid = (lo + hi) / 2;
404 int32_t foundVal = keys[mid];
405 if (test_val < foundVal) {
406 hi = mid - 1;
407 } else if (test_val > foundVal) {
408 lo = mid + 1;
409 } else {
410 return entries[mid];
411 }
412 }
413 // No corresponding value: move forward by 3 (size of SPARSE_SWITCH).
414 return 3;
415}
416
Ian Rogers54874942014-06-10 16:31:03 -0700417uint32_t FindNextInstructionFollowingException(Thread* self, ShadowFrame& shadow_frame,
Sebastien Hertz9f102032014-05-23 08:59:42 +0200418 uint32_t dex_pc, const instrumentation::Instrumentation* instrumentation)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700419 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200420
Andreas Gampe794ad762015-02-23 08:12:24 -0800421NO_RETURN void UnexpectedOpcode(const Instruction* inst, const ShadowFrame& shadow_frame)
422 __attribute__((cold))
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700423 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200424
Bill Buzbeed47fd902016-07-07 14:42:43 +0000425// Set true if you want TraceExecution invocation before each bytecode execution.
426constexpr bool kTraceExecutionEnabled = false;
Serguei Katkov9fb0ac72016-02-20 12:55:24 +0600427
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200428static inline void TraceExecution(const ShadowFrame& shadow_frame, const Instruction* inst,
Ian Rogerse94652f2014-12-02 11:13:19 -0800429 const uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700430 REQUIRES_SHARED(Locks::mutator_lock_) {
Bill Buzbeed47fd902016-07-07 14:42:43 +0000431 if (kTraceExecutionEnabled) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200432#define TRACE_LOG std::cerr
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700433 std::ostringstream oss;
David Sehr709b0702016-10-13 09:12:37 -0700434 oss << shadow_frame.GetMethod()->PrettyMethod()
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800435 << android::base::StringPrintf("\n0x%x: ", dex_pc)
Ian Rogerse94652f2014-12-02 11:13:19 -0800436 << inst->DumpString(shadow_frame.GetMethod()->GetDexFile()) << "\n";
Ian Rogersef7d42f2014-01-06 12:55:46 -0800437 for (uint32_t i = 0; i < shadow_frame.NumberOfVRegs(); ++i) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200438 uint32_t raw_value = shadow_frame.GetVReg(i);
Mathieu Chartieref41db72016-10-25 15:08:01 -0700439 ObjPtr<mirror::Object> ref_value = shadow_frame.GetVRegReference(i);
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800440 oss << android::base::StringPrintf(" vreg%u=0x%08X", i, raw_value);
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700441 if (ref_value != nullptr) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200442 if (ref_value->GetClass()->IsStringClass() &&
jessicahandojo3aaa37b2016-07-29 14:46:37 -0700443 !ref_value->AsString()->IsValueNull()) {
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700444 oss << "/java.lang.String \"" << ref_value->AsString()->ToModifiedUtf8() << "\"";
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200445 } else {
David Sehr709b0702016-10-13 09:12:37 -0700446 oss << "/" << ref_value->PrettyTypeOf();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200447 }
448 }
449 }
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700450 TRACE_LOG << oss.str() << "\n";
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200451#undef TRACE_LOG
452 }
453}
454
Sebastien Hertz1eda2262013-09-09 16:53:14 +0200455static inline bool IsBackwardBranch(int32_t branch_offset) {
456 return branch_offset <= 0;
457}
458
Narayan Kamath208f8572016-08-03 12:46:58 +0100459// Assign register 'src_reg' from shadow_frame to register 'dest_reg' into new_shadow_frame.
460static inline void AssignRegister(ShadowFrame* new_shadow_frame, const ShadowFrame& shadow_frame,
461 size_t dest_reg, size_t src_reg)
462 REQUIRES_SHARED(Locks::mutator_lock_) {
463 // Uint required, so that sign extension does not make this wrong on 64b systems
464 uint32_t src_value = shadow_frame.GetVReg(src_reg);
Mathieu Chartieref41db72016-10-25 15:08:01 -0700465 ObjPtr<mirror::Object> o = shadow_frame.GetVRegReference<kVerifyNone>(src_reg);
Narayan Kamath208f8572016-08-03 12:46:58 +0100466
467 // If both register locations contains the same value, the register probably holds a reference.
468 // Note: As an optimization, non-moving collectors leave a stale reference value
469 // in the references array even after the original vreg was overwritten to a non-reference.
Mathieu Chartieref41db72016-10-25 15:08:01 -0700470 if (src_value == reinterpret_cast<uintptr_t>(o.Ptr())) {
471 new_shadow_frame->SetVRegReference(dest_reg, o.Ptr());
Narayan Kamath208f8572016-08-03 12:46:58 +0100472 } else {
473 new_shadow_frame->SetVReg(dest_reg, src_value);
474 }
475}
476
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100477void ArtInterpreterToCompiledCodeBridge(Thread* self,
478 ArtMethod* caller,
479 const DexFile::CodeItem* code_item,
480 ShadowFrame* shadow_frame,
481 JValue* result);
Siva Chandra05d24152016-01-05 17:43:17 -0800482
Mingyao Yangffedec52016-05-19 10:48:40 -0700483// Set string value created from StringFactory.newStringFromXXX() into all aliases of
484// StringFactory.newEmptyString().
485void SetStringInitValueToAllAliases(ShadowFrame* shadow_frame,
486 uint16_t this_obj_vreg,
487 JValue result);
488
Sebastien Hertzc6714852013-09-30 16:42:32 +0200489// Explicitly instantiate all DoInvoke functions.
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100490#define EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, _is_range, _do_check) \
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700491 template REQUIRES_SHARED(Locks::mutator_lock_) \
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100492 bool DoInvoke<_type, _is_range, _do_check>(Thread* self, ShadowFrame& shadow_frame, \
493 const Instruction* inst, uint16_t inst_data, \
494 JValue* result)
Sebastien Hertzc6714852013-09-30 16:42:32 +0200495
496#define EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(_type) \
497 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, false, false); \
498 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, false, true); \
499 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, true, false); \
500 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, true, true);
501
Andreas Gampec8ccf682014-09-29 20:07:43 -0700502EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kStatic) // invoke-static/range.
503EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kDirect) // invoke-direct/range.
504EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kVirtual) // invoke-virtual/range.
505EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kSuper) // invoke-super/range.
506EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kInterface) // invoke-interface/range.
Sebastien Hertzc6714852013-09-30 16:42:32 +0200507#undef EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL
508#undef EXPLICIT_DO_INVOKE_TEMPLATE_DECL
509
Sebastien Hertzc6714852013-09-30 16:42:32 +0200510// Explicitly instantiate all DoInvokeVirtualQuick functions.
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100511#define EXPLICIT_DO_INVOKE_VIRTUAL_QUICK_TEMPLATE_DECL(_is_range) \
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700512 template REQUIRES_SHARED(Locks::mutator_lock_) \
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100513 bool DoInvokeVirtualQuick<_is_range>(Thread* self, ShadowFrame& shadow_frame, \
514 const Instruction* inst, uint16_t inst_data, \
515 JValue* result)
Sebastien Hertzc6714852013-09-30 16:42:32 +0200516
517EXPLICIT_DO_INVOKE_VIRTUAL_QUICK_TEMPLATE_DECL(false); // invoke-virtual-quick.
518EXPLICIT_DO_INVOKE_VIRTUAL_QUICK_TEMPLATE_DECL(true); // invoke-virtual-quick-range.
519#undef EXPLICIT_INSTANTIATION_DO_INVOKE_VIRTUAL_QUICK
520
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200521} // namespace interpreter
522} // namespace art
523
524#endif // ART_RUNTIME_INTERPRETER_INTERPRETER_COMMON_H_