blob: bdb6bd39a1c3399cbc18ce15e06f456725a2ae33 [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
Mathieu Chartierc7853442015-03-27 14:35:38 -070028#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070029#include "art_method-inl.h"
Andreas Gampe542451c2016-07-26 09:02:02 -070030#include "base/enums.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020031#include "base/logging.h"
Andreas Gampe794ad762015-02-23 08:12:24 -080032#include "base/macros.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020033#include "class_linker-inl.h"
34#include "common_throws.h"
35#include "dex_file-inl.h"
36#include "dex_instruction-inl.h"
Mingyao Yang98d1cc82014-05-15 17:02:16 -070037#include "entrypoints/entrypoint_utils-inl.h"
Mathieu Chartier0cd81352014-05-22 16:48:55 -070038#include "handle_scope-inl.h"
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +010039#include "jit/jit.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020040#include "mirror/class-inl.h"
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -070041#include "mirror/dex_cache.h"
42#include "mirror/method.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020043#include "mirror/object-inl.h"
44#include "mirror/object_array-inl.h"
Douglas Leung4965c022014-06-11 11:41:11 -070045#include "mirror/string-inl.h"
Andreas Gampe03ec9302015-08-27 17:41:47 -070046#include "stack.h"
Sebastien Hertz8ece0502013-08-07 11:26:41 +020047#include "thread.h"
48#include "well_known_classes.h"
49
Mathieu Chartiere401d142015-04-22 13:56:20 -070050using ::art::ArtMethod;
Sebastien Hertz8ece0502013-08-07 11:26:41 +020051using ::art::mirror::Array;
52using ::art::mirror::BooleanArray;
53using ::art::mirror::ByteArray;
54using ::art::mirror::CharArray;
55using ::art::mirror::Class;
56using ::art::mirror::ClassLoader;
57using ::art::mirror::IntArray;
58using ::art::mirror::LongArray;
59using ::art::mirror::Object;
60using ::art::mirror::ObjectArray;
61using ::art::mirror::ShortArray;
62using ::art::mirror::String;
63using ::art::mirror::Throwable;
64
65namespace art {
66namespace interpreter {
67
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +000068void ThrowNullPointerExceptionFromInterpreter()
Andreas Gampebdf7f1c2016-08-30 16:38:47 -070069 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertzda843e12014-05-28 19:28:31 +020070
Andreas Gampe03ec9302015-08-27 17:41:47 -070071template <bool kMonitorCounting>
72static inline void DoMonitorEnter(Thread* self,
73 ShadowFrame* frame,
Mathieu Chartier2d096c92015-10-12 16:18:20 -070074 Object* ref)
75 NO_THREAD_SAFETY_ANALYSIS
76 REQUIRES(!Roles::uninterruptible_) {
77 StackHandleScope<1> hs(self);
78 Handle<Object> h_ref(hs.NewHandle(ref));
79 h_ref->MonitorEnter(self);
Andreas Gampe56fdd0e2016-04-28 14:56:54 -070080 if (kMonitorCounting && frame->GetMethod()->MustCountLocks()) {
81 frame->GetLockCountData().AddMonitor(self, h_ref.Get());
82 }
Sebastien Hertz8ece0502013-08-07 11:26:41 +020083}
84
Andreas Gampe03ec9302015-08-27 17:41:47 -070085template <bool kMonitorCounting>
86static inline void DoMonitorExit(Thread* self,
87 ShadowFrame* frame,
Mathieu Chartier2d096c92015-10-12 16:18:20 -070088 Object* ref)
89 NO_THREAD_SAFETY_ANALYSIS
90 REQUIRES(!Roles::uninterruptible_) {
91 StackHandleScope<1> hs(self);
92 Handle<Object> h_ref(hs.NewHandle(ref));
93 h_ref->MonitorExit(self);
Andreas Gampe56fdd0e2016-04-28 14:56:54 -070094 if (kMonitorCounting && frame->GetMethod()->MustCountLocks()) {
95 frame->GetLockCountData().RemoveMonitorOrThrow(self, h_ref.Get());
96 }
97}
98
99template <bool kMonitorCounting>
100static inline bool DoMonitorCheckOnExit(Thread* self, ShadowFrame* frame)
101 NO_THREAD_SAFETY_ANALYSIS
102 REQUIRES(!Roles::uninterruptible_) {
103 if (kMonitorCounting && frame->GetMethod()->MustCountLocks()) {
104 return frame->GetLockCountData().CheckAllMonitorsReleasedOrThrow(self);
105 }
106 return true;
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200107}
108
Sebastien Hertz45b15972015-04-03 16:07:05 +0200109void AbortTransactionF(Thread* self, const char* fmt, ...)
110 __attribute__((__format__(__printf__, 2, 3)))
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700111 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz45b15972015-04-03 16:07:05 +0200112
113void AbortTransactionV(Thread* self, const char* fmt, va_list args)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700114 REQUIRES_SHARED(Locks::mutator_lock_);
Mathieu Chartierb2c7ead2014-04-29 11:13:16 -0700115
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100116void RecordArrayElementsInTransaction(mirror::Array* array, int32_t count)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700117 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100118
Sebastien Hertzc6714852013-09-30 16:42:32 +0200119// Invokes the given method. This is part of the invocation support and is used by DoInvoke and
120// DoInvokeVirtualQuick functions.
121// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200122template<bool is_range, bool do_assignability_check>
Ian Rogerse94652f2014-12-02 11:13:19 -0800123bool DoCall(ArtMethod* called_method, Thread* self, ShadowFrame& shadow_frame,
Sebastien Hertzc6714852013-09-30 16:42:32 +0200124 const Instruction* inst, uint16_t inst_data, JValue* result);
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200125
Narayan Kamath9823e782016-08-03 12:46:58 +0100126// Handles all invoke-XXX/range instructions except for invoke-polymorphic[/range].
Sebastien Hertzc6714852013-09-30 16:42:32 +0200127// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200128template<InvokeType type, bool is_range, bool do_access_check>
129static inline bool DoInvoke(Thread* self, ShadowFrame& shadow_frame, const Instruction* inst,
130 uint16_t inst_data, JValue* result) {
131 const uint32_t method_idx = (is_range) ? inst->VRegB_3rc() : inst->VRegB_35c();
132 const uint32_t vregC = (is_range) ? inst->VRegC_3rc() : inst->VRegC_35c();
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700133 Object* receiver = (type == kStatic) ? nullptr : shadow_frame.GetVRegReference(vregC);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700134 ArtMethod* sf_method = shadow_frame.GetMethod();
Ian Rogerse94652f2014-12-02 11:13:19 -0800135 ArtMethod* const called_method = FindMethodFromCode<type, do_access_check>(
Andreas Gampe3a357142015-08-07 17:20:11 -0700136 method_idx, &receiver, sf_method, self);
Mathieu Chartier0cd81352014-05-22 16:48:55 -0700137 // The shadow frame should already be pushed, so we don't need to update it.
Ian Rogerse94652f2014-12-02 11:13:19 -0800138 if (UNLIKELY(called_method == nullptr)) {
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200139 CHECK(self->IsExceptionPending());
140 result->SetJ(0);
141 return false;
Alex Light9139e002015-10-09 15:59:48 -0700142 } else if (UNLIKELY(!called_method->IsInvokable())) {
143 called_method->ThrowInvocationTimeError();
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200144 result->SetJ(0);
145 return false;
146 } else {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100147 jit::Jit* jit = Runtime::Current()->GetJit();
148 if (jit != nullptr) {
149 if (type == kVirtual || type == kInterface) {
Mathieu Chartier268764d2016-09-13 12:09:38 -0700150 jit->InvokeVirtualOrInterface(receiver, sf_method, shadow_frame.GetDexPC(), called_method);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100151 }
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100152 jit->AddSamples(self, sf_method, 1, /*with_backedges*/false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100153 }
154 // TODO: Remove the InvokeVirtualOrInterface instrumentation, as it was only used by the JIT.
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100155 if (type == kVirtual || type == kInterface) {
156 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
157 if (UNLIKELY(instrumentation->HasInvokeVirtualOrInterfaceListeners())) {
158 instrumentation->InvokeVirtualOrInterface(
159 self, receiver, sf_method, shadow_frame.GetDexPC(), called_method);
160 }
161 }
Ian Rogerse94652f2014-12-02 11:13:19 -0800162 return DoCall<is_range, do_access_check>(called_method, self, shadow_frame, inst, inst_data,
163 result);
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200164 }
165}
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200166
Narayan Kamath9823e782016-08-03 12:46:58 +0100167// Performs a signature polymorphic invoke (invoke-polymorphic/invoke-polymorphic-range).
168template<bool is_range, bool do_access_check>
169bool DoInvokePolymorphic(Thread* self, ShadowFrame& shadow_frame,
170 const Instruction* inst, uint16_t inst_data,
171 JValue* result);
172
Sebastien Hertzc6714852013-09-30 16:42:32 +0200173// Handles invoke-virtual-quick and invoke-virtual-quick-range instructions.
174// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200175template<bool is_range>
176static inline bool DoInvokeVirtualQuick(Thread* self, ShadowFrame& shadow_frame,
177 const Instruction* inst, uint16_t inst_data,
178 JValue* result) {
179 const uint32_t vregC = (is_range) ? inst->VRegC_3rc() : inst->VRegC_35c();
180 Object* const receiver = shadow_frame.GetVRegReference(vregC);
Sebastien Hertzd4beb6b2013-10-02 17:07:20 +0200181 if (UNLIKELY(receiver == nullptr)) {
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200182 // We lost the reference to the method index so we cannot get a more
183 // precised exception message.
Nicolas Geoffray0aa50ce2015-03-10 11:03:29 +0000184 ThrowNullPointerExceptionFromDexPC();
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200185 return false;
186 }
187 const uint32_t vtable_idx = (is_range) ? inst->VRegB_3rc() : inst->VRegB_35c();
Hiroshi Yamauchia10ae782016-10-05 18:13:23 -0700188 // Debug code for b/31357497. To be removed.
189 if (kUseReadBarrier) {
190 CHECK(receiver->GetClass() != nullptr)
191 << "Null class found in object " << receiver << " in region type "
192 << Runtime::Current()->GetHeap()->ConcurrentCopyingCollector()->
193 RegionSpace()->GetRegionType(receiver);
194 }
Artem Udovichenkoa62cb9b2016-06-30 09:18:25 +0000195 CHECK(receiver->GetClass()->ShouldHaveEmbeddedVTable());
Mathieu Chartiere401d142015-04-22 13:56:20 -0700196 ArtMethod* const called_method = receiver->GetClass()->GetEmbeddedVTableEntry(
Andreas Gampe542451c2016-07-26 09:02:02 -0700197 vtable_idx, kRuntimePointerSize);
Ian Rogerse94652f2014-12-02 11:13:19 -0800198 if (UNLIKELY(called_method == nullptr)) {
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200199 CHECK(self->IsExceptionPending());
200 result->SetJ(0);
201 return false;
Alex Light9139e002015-10-09 15:59:48 -0700202 } else if (UNLIKELY(!called_method->IsInvokable())) {
203 called_method->ThrowInvocationTimeError();
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200204 result->SetJ(0);
205 return false;
206 } else {
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100207 jit::Jit* jit = Runtime::Current()->GetJit();
208 if (jit != nullptr) {
209 jit->InvokeVirtualOrInterface(
Mathieu Chartier268764d2016-09-13 12:09:38 -0700210 receiver, shadow_frame.GetMethod(), shadow_frame.GetDexPC(), called_method);
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100211 jit->AddSamples(self, shadow_frame.GetMethod(), 1, /*with_backedges*/false);
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100212 }
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100213 instrumentation::Instrumentation* instrumentation = Runtime::Current()->GetInstrumentation();
Nicolas Geoffray274fe4a2016-04-12 16:33:24 +0100214 // TODO: Remove the InvokeVirtualOrInterface instrumentation, as it was only used by the JIT.
Nicolas Geoffray5550ca82015-08-21 18:38:30 +0100215 if (UNLIKELY(instrumentation->HasInvokeVirtualOrInterfaceListeners())) {
216 instrumentation->InvokeVirtualOrInterface(
217 self, receiver, shadow_frame.GetMethod(), shadow_frame.GetDexPC(), called_method);
218 }
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200219 // No need to check since we've been quickened.
Ian Rogerse94652f2014-12-02 11:13:19 -0800220 return DoCall<is_range, false>(called_method, self, shadow_frame, inst, inst_data, result);
Sebastien Hertzc61124b2013-09-10 11:44:19 +0200221 }
222}
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200223
Sebastien Hertzc6714852013-09-30 16:42:32 +0200224// Handles iget-XXX and sget-XXX instructions.
225// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200226template<FindFieldType find_type, Primitive::Type field_type, bool do_access_check>
Ian Rogers54874942014-06-10 16:31:03 -0700227bool DoFieldGet(Thread* self, 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 iget-quick, iget-wide-quick and iget-object-quick instructions.
231// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200232template<Primitive::Type field_type>
Ian Rogers54874942014-06-10 16:31:03 -0700233bool DoIGetQuick(ShadowFrame& shadow_frame, const Instruction* inst, uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700234 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz479fc1e2014-04-04 17:51:34 +0200235
Sebastien Hertzc6714852013-09-30 16:42:32 +0200236// Handles iput-XXX and sput-XXX instructions.
237// Returns true on success, otherwise throws an exception and returns false.
Ian Rogers54874942014-06-10 16:31:03 -0700238template<FindFieldType find_type, Primitive::Type field_type, bool do_access_check,
239 bool transaction_active>
240bool DoFieldPut(Thread* self, const ShadowFrame& shadow_frame, const Instruction* inst,
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700241 uint16_t inst_data) REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200242
Sebastien Hertzc6714852013-09-30 16:42:32 +0200243// Handles iput-quick, iput-wide-quick and iput-object-quick instructions.
244// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100245template<Primitive::Type field_type, bool transaction_active>
Ian Rogers54874942014-06-10 16:31:03 -0700246bool DoIPutQuick(const ShadowFrame& shadow_frame, const Instruction* inst, uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700247 REQUIRES_SHARED(Locks::mutator_lock_);
Ian Rogers54874942014-06-10 16:31:03 -0700248
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200249
Sebastien Hertzc6714852013-09-30 16:42:32 +0200250// Handles string resolution for const-string and const-string-jumbo instructions. Also ensures the
251// java.lang.String class is initialized.
Ian Rogers6786a582014-10-28 12:49:06 -0700252static inline String* ResolveString(Thread* self, ShadowFrame& shadow_frame, uint32_t string_idx)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700253 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200254 Class* java_lang_string_class = String::GetJavaLangString();
255 if (UNLIKELY(!java_lang_string_class->IsInitialized())) {
256 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700257 StackHandleScope<1> hs(self);
258 Handle<mirror::Class> h_class(hs.NewHandle(java_lang_string_class));
Ian Rogers7b078e82014-09-10 14:44:24 -0700259 if (UNLIKELY(!class_linker->EnsureInitialized(self, h_class, true, true))) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200260 DCHECK(self->IsExceptionPending());
Mathieu Chartierc528dba2013-11-26 12:00:11 -0800261 return nullptr;
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200262 }
263 }
Mathieu Chartiere401d142015-04-22 13:56:20 -0700264 ArtMethod* method = shadow_frame.GetMethod();
Mathieu Chartiereace4582014-11-24 18:29:54 -0800265 mirror::Class* declaring_class = method->GetDeclaringClass();
Vladimir Marko05792b92015-08-03 11:56:49 +0100266 // MethodVerifier refuses methods with string_idx out of bounds.
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -0700267 DCHECK_LT(string_idx % mirror::DexCache::kDexCacheStringCacheSize,
268 declaring_class->GetDexFile().NumStringIds());
269 mirror::String* string_ptr =
Narayan Kamathc38a6f82016-09-29 17:07:20 +0100270 mirror::StringDexCachePair::Lookup(declaring_class->GetDexCacheStrings(),
271 string_idx,
272 mirror::DexCache::kDexCacheStringCacheSize).Read();
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -0700273 if (UNLIKELY(string_ptr == nullptr)) {
Ian Rogers6786a582014-10-28 12:49:06 -0700274 StackHandleScope<1> hs(self);
Mathieu Chartiereace4582014-11-24 18:29:54 -0800275 Handle<mirror::DexCache> dex_cache(hs.NewHandle(declaring_class->GetDexCache()));
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -0700276 string_ptr = Runtime::Current()->GetClassLinker()->ResolveString(*method->GetDexFile(),
277 string_idx,
278 dex_cache);
Ian Rogers6786a582014-10-28 12:49:06 -0700279 }
Christina Wadsworthbf44e0e2016-08-18 10:37:42 -0700280 return string_ptr;
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200281}
282
Sebastien Hertzc6714852013-09-30 16:42:32 +0200283// Handles div-int, div-int/2addr, div-int/li16 and div-int/lit8 instructions.
284// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200285static inline bool DoIntDivide(ShadowFrame& shadow_frame, size_t result_reg,
286 int32_t dividend, int32_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700287 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersf72a11d2014-10-30 15:41:08 -0700288 constexpr int32_t kMinInt = std::numeric_limits<int32_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200289 if (UNLIKELY(divisor == 0)) {
290 ThrowArithmeticExceptionDivideByZero();
291 return false;
292 }
293 if (UNLIKELY(dividend == kMinInt && divisor == -1)) {
294 shadow_frame.SetVReg(result_reg, kMinInt);
295 } else {
296 shadow_frame.SetVReg(result_reg, dividend / divisor);
297 }
298 return true;
299}
300
Sebastien Hertzc6714852013-09-30 16:42:32 +0200301// Handles rem-int, rem-int/2addr, rem-int/li16 and rem-int/lit8 instructions.
302// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200303static inline bool DoIntRemainder(ShadowFrame& shadow_frame, size_t result_reg,
304 int32_t dividend, int32_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700305 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersf72a11d2014-10-30 15:41:08 -0700306 constexpr int32_t kMinInt = std::numeric_limits<int32_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200307 if (UNLIKELY(divisor == 0)) {
308 ThrowArithmeticExceptionDivideByZero();
309 return false;
310 }
311 if (UNLIKELY(dividend == kMinInt && divisor == -1)) {
312 shadow_frame.SetVReg(result_reg, 0);
313 } else {
314 shadow_frame.SetVReg(result_reg, dividend % divisor);
315 }
316 return true;
317}
318
Sebastien Hertzc6714852013-09-30 16:42:32 +0200319// Handles div-long and div-long-2addr instructions.
320// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200321static inline bool DoLongDivide(ShadowFrame& shadow_frame, size_t result_reg,
322 int64_t dividend, int64_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700323 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2e2deeb2013-09-23 11:58:57 -0700324 const int64_t kMinLong = std::numeric_limits<int64_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200325 if (UNLIKELY(divisor == 0)) {
326 ThrowArithmeticExceptionDivideByZero();
327 return false;
328 }
329 if (UNLIKELY(dividend == kMinLong && divisor == -1)) {
330 shadow_frame.SetVRegLong(result_reg, kMinLong);
331 } else {
332 shadow_frame.SetVRegLong(result_reg, dividend / divisor);
333 }
334 return true;
335}
336
Sebastien Hertzc6714852013-09-30 16:42:32 +0200337// Handles rem-long and rem-long-2addr instructions.
338// Returns true on success, otherwise throws a java.lang.ArithmeticException and return false.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200339static inline bool DoLongRemainder(ShadowFrame& shadow_frame, size_t result_reg,
340 int64_t dividend, int64_t divisor)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700341 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2e2deeb2013-09-23 11:58:57 -0700342 const int64_t kMinLong = std::numeric_limits<int64_t>::min();
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200343 if (UNLIKELY(divisor == 0)) {
344 ThrowArithmeticExceptionDivideByZero();
345 return false;
346 }
347 if (UNLIKELY(dividend == kMinLong && divisor == -1)) {
348 shadow_frame.SetVRegLong(result_reg, 0);
349 } else {
350 shadow_frame.SetVRegLong(result_reg, dividend % divisor);
351 }
352 return true;
353}
354
Sebastien Hertzc6714852013-09-30 16:42:32 +0200355// Handles filled-new-array and filled-new-array-range instructions.
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200356// Returns true on success, otherwise throws an exception and returns false.
Sebastien Hertzd2fe10a2014-01-15 10:20:56 +0100357template <bool is_range, bool do_access_check, bool transaction_active>
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200358bool DoFilledNewArray(const Instruction* inst, const ShadowFrame& shadow_frame,
Sebastien Hertzc6714852013-09-30 16:42:32 +0200359 Thread* self, JValue* result);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200360
Sebastien Hertzc6714852013-09-30 16:42:32 +0200361// Handles packed-switch instruction.
362// Returns the branch offset to the next instruction to execute.
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200363static inline int32_t DoPackedSwitch(const Instruction* inst, const ShadowFrame& shadow_frame,
364 uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700365 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200366 DCHECK(inst->Opcode() == Instruction::PACKED_SWITCH);
367 const uint16_t* switch_data = reinterpret_cast<const uint16_t*>(inst) + inst->VRegB_31t();
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200368 int32_t test_val = shadow_frame.GetVReg(inst->VRegA_31t(inst_data));
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200369 DCHECK_EQ(switch_data[0], static_cast<uint16_t>(Instruction::kPackedSwitchSignature));
370 uint16_t size = switch_data[1];
David Brazdil2ef645b2015-06-17 18:20:52 +0100371 if (size == 0) {
372 // Empty packed switch, move forward by 3 (size of PACKED_SWITCH).
373 return 3;
374 }
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200375 const int32_t* keys = reinterpret_cast<const int32_t*>(&switch_data[2]);
Roland Levillain14d90572015-07-16 10:52:26 +0100376 DCHECK_ALIGNED(keys, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200377 int32_t first_key = keys[0];
378 const int32_t* targets = reinterpret_cast<const int32_t*>(&switch_data[4]);
Roland Levillain14d90572015-07-16 10:52:26 +0100379 DCHECK_ALIGNED(targets, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200380 int32_t index = test_val - first_key;
381 if (index >= 0 && index < size) {
382 return targets[index];
383 } else {
384 // No corresponding value: move forward by 3 (size of PACKED_SWITCH).
385 return 3;
386 }
387}
388
Sebastien Hertzc6714852013-09-30 16:42:32 +0200389// Handles sparse-switch instruction.
390// Returns the branch offset to the next instruction to execute.
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200391static inline int32_t DoSparseSwitch(const Instruction* inst, const ShadowFrame& shadow_frame,
392 uint16_t inst_data)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700393 REQUIRES_SHARED(Locks::mutator_lock_) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200394 DCHECK(inst->Opcode() == Instruction::SPARSE_SWITCH);
395 const uint16_t* switch_data = reinterpret_cast<const uint16_t*>(inst) + inst->VRegB_31t();
Sebastien Hertz3b588e02013-09-11 14:33:18 +0200396 int32_t test_val = shadow_frame.GetVReg(inst->VRegA_31t(inst_data));
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200397 DCHECK_EQ(switch_data[0], static_cast<uint16_t>(Instruction::kSparseSwitchSignature));
398 uint16_t size = switch_data[1];
Jeff Hao935e01a2015-03-20 19:44:35 -0700399 // Return length of SPARSE_SWITCH if size is 0.
400 if (size == 0) {
401 return 3;
402 }
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200403 const int32_t* keys = reinterpret_cast<const int32_t*>(&switch_data[2]);
Roland Levillain14d90572015-07-16 10:52:26 +0100404 DCHECK_ALIGNED(keys, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200405 const int32_t* entries = keys + size;
Roland Levillain14d90572015-07-16 10:52:26 +0100406 DCHECK_ALIGNED(entries, 4);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200407 int lo = 0;
408 int hi = size - 1;
409 while (lo <= hi) {
410 int mid = (lo + hi) / 2;
411 int32_t foundVal = keys[mid];
412 if (test_val < foundVal) {
413 hi = mid - 1;
414 } else if (test_val > foundVal) {
415 lo = mid + 1;
416 } else {
417 return entries[mid];
418 }
419 }
420 // No corresponding value: move forward by 3 (size of SPARSE_SWITCH).
421 return 3;
422}
423
Ian Rogers54874942014-06-10 16:31:03 -0700424uint32_t FindNextInstructionFollowingException(Thread* self, ShadowFrame& shadow_frame,
Sebastien Hertz9f102032014-05-23 08:59:42 +0200425 uint32_t dex_pc, const instrumentation::Instrumentation* instrumentation)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700426 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200427
Andreas Gampe794ad762015-02-23 08:12:24 -0800428NO_RETURN void UnexpectedOpcode(const Instruction* inst, const ShadowFrame& shadow_frame)
429 __attribute__((cold))
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700430 REQUIRES_SHARED(Locks::mutator_lock_);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200431
Bill Buzbeed47fd902016-07-07 14:42:43 +0000432// Set true if you want TraceExecution invocation before each bytecode execution.
433constexpr bool kTraceExecutionEnabled = false;
Serguei Katkov9fb0ac72016-02-20 12:55:24 +0600434
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200435static inline void TraceExecution(const ShadowFrame& shadow_frame, const Instruction* inst,
Ian Rogerse94652f2014-12-02 11:13:19 -0800436 const uint32_t dex_pc)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700437 REQUIRES_SHARED(Locks::mutator_lock_) {
Bill Buzbeed47fd902016-07-07 14:42:43 +0000438 if (kTraceExecutionEnabled) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200439#define TRACE_LOG std::cerr
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700440 std::ostringstream oss;
441 oss << PrettyMethod(shadow_frame.GetMethod())
442 << StringPrintf("\n0x%x: ", dex_pc)
Ian Rogerse94652f2014-12-02 11:13:19 -0800443 << inst->DumpString(shadow_frame.GetMethod()->GetDexFile()) << "\n";
Ian Rogersef7d42f2014-01-06 12:55:46 -0800444 for (uint32_t i = 0; i < shadow_frame.NumberOfVRegs(); ++i) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200445 uint32_t raw_value = shadow_frame.GetVReg(i);
446 Object* ref_value = shadow_frame.GetVRegReference(i);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800447 oss << StringPrintf(" vreg%u=0x%08X", i, raw_value);
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700448 if (ref_value != nullptr) {
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200449 if (ref_value->GetClass()->IsStringClass() &&
jessicahandojo3aaa37b2016-07-29 14:46:37 -0700450 !ref_value->AsString()->IsValueNull()) {
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700451 oss << "/java.lang.String \"" << ref_value->AsString()->ToModifiedUtf8() << "\"";
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200452 } else {
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700453 oss << "/" << PrettyTypeOf(ref_value);
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200454 }
455 }
456 }
Mathieu Chartiere861ebd2013-10-09 15:01:21 -0700457 TRACE_LOG << oss.str() << "\n";
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200458#undef TRACE_LOG
459 }
460}
461
Sebastien Hertz1eda2262013-09-09 16:53:14 +0200462static inline bool IsBackwardBranch(int32_t branch_offset) {
463 return branch_offset <= 0;
464}
465
Narayan Kamath208f8572016-08-03 12:46:58 +0100466// Assign register 'src_reg' from shadow_frame to register 'dest_reg' into new_shadow_frame.
467static inline void AssignRegister(ShadowFrame* new_shadow_frame, const ShadowFrame& shadow_frame,
468 size_t dest_reg, size_t src_reg)
469 REQUIRES_SHARED(Locks::mutator_lock_) {
470 // Uint required, so that sign extension does not make this wrong on 64b systems
471 uint32_t src_value = shadow_frame.GetVReg(src_reg);
472 mirror::Object* o = shadow_frame.GetVRegReference<kVerifyNone>(src_reg);
473
474 // If both register locations contains the same value, the register probably holds a reference.
475 // Note: As an optimization, non-moving collectors leave a stale reference value
476 // in the references array even after the original vreg was overwritten to a non-reference.
477 if (src_value == reinterpret_cast<uintptr_t>(o)) {
478 new_shadow_frame->SetVRegReference(dest_reg, o);
479 } else {
480 new_shadow_frame->SetVReg(dest_reg, src_value);
481 }
482}
483
Nicolas Geoffray71cd50f2016-04-14 15:00:33 +0100484void ArtInterpreterToCompiledCodeBridge(Thread* self,
485 ArtMethod* caller,
486 const DexFile::CodeItem* code_item,
487 ShadowFrame* shadow_frame,
488 JValue* result);
Siva Chandra05d24152016-01-05 17:43:17 -0800489
Mingyao Yangffedec52016-05-19 10:48:40 -0700490// Set string value created from StringFactory.newStringFromXXX() into all aliases of
491// StringFactory.newEmptyString().
492void SetStringInitValueToAllAliases(ShadowFrame* shadow_frame,
493 uint16_t this_obj_vreg,
494 JValue result);
495
Sebastien Hertzc6714852013-09-30 16:42:32 +0200496// Explicitly instantiate all DoInvoke functions.
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100497#define EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, _is_range, _do_check) \
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700498 template REQUIRES_SHARED(Locks::mutator_lock_) \
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100499 bool DoInvoke<_type, _is_range, _do_check>(Thread* self, ShadowFrame& shadow_frame, \
500 const Instruction* inst, uint16_t inst_data, \
501 JValue* result)
Sebastien Hertzc6714852013-09-30 16:42:32 +0200502
503#define EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(_type) \
504 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, false, false); \
505 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, false, true); \
506 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, true, false); \
507 EXPLICIT_DO_INVOKE_TEMPLATE_DECL(_type, true, true);
508
Andreas Gampec8ccf682014-09-29 20:07:43 -0700509EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kStatic) // invoke-static/range.
510EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kDirect) // invoke-direct/range.
511EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kVirtual) // invoke-virtual/range.
512EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kSuper) // invoke-super/range.
513EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL(kInterface) // invoke-interface/range.
Sebastien Hertzc6714852013-09-30 16:42:32 +0200514#undef EXPLICIT_DO_INVOKE_ALL_TEMPLATE_DECL
515#undef EXPLICIT_DO_INVOKE_TEMPLATE_DECL
516
Sebastien Hertzc6714852013-09-30 16:42:32 +0200517// Explicitly instantiate all DoInvokeVirtualQuick functions.
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100518#define EXPLICIT_DO_INVOKE_VIRTUAL_QUICK_TEMPLATE_DECL(_is_range) \
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700519 template REQUIRES_SHARED(Locks::mutator_lock_) \
Bernhard Rosenkränzer46053622013-12-12 02:15:52 +0100520 bool DoInvokeVirtualQuick<_is_range>(Thread* self, ShadowFrame& shadow_frame, \
521 const Instruction* inst, uint16_t inst_data, \
522 JValue* result)
Sebastien Hertzc6714852013-09-30 16:42:32 +0200523
524EXPLICIT_DO_INVOKE_VIRTUAL_QUICK_TEMPLATE_DECL(false); // invoke-virtual-quick.
525EXPLICIT_DO_INVOKE_VIRTUAL_QUICK_TEMPLATE_DECL(true); // invoke-virtual-quick-range.
526#undef EXPLICIT_INSTANTIATION_DO_INVOKE_VIRTUAL_QUICK
527
Sebastien Hertz8ece0502013-08-07 11:26:41 +0200528} // namespace interpreter
529} // namespace art
530
531#endif // ART_RUNTIME_INTERPRETER_INTERPRETER_COMMON_H_