Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2014 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 | |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_QUICK_EXCEPTION_HANDLER_H_ |
| 18 | #define ART_RUNTIME_QUICK_EXCEPTION_HANDLER_H_ |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 19 | |
Andreas Gampe | 5794381 | 2017-12-06 21:39:13 -0800 | [diff] [blame] | 20 | #include <android-base/logging.h> |
| 21 | |
Andreas Gampe | 794ad76 | 2015-02-23 08:12:24 -0800 | [diff] [blame] | 22 | #include "base/macros.h" |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 23 | #include "base/mutex.h" |
Nicolas Geoffray | 4e92c3c | 2017-05-08 09:34:26 +0100 | [diff] [blame] | 24 | #include "deoptimization_kind.h" |
Vladimir Marko | 3a21e38 | 2016-09-02 12:38:38 +0100 | [diff] [blame] | 25 | #include "stack_reference.h" |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 26 | |
| 27 | namespace art { |
| 28 | |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 29 | namespace mirror { |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 30 | class Throwable; |
| 31 | } // namespace mirror |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 32 | class ArtMethod; |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 33 | class Context; |
Vladimir Marko | 3a21e38 | 2016-09-02 12:38:38 +0100 | [diff] [blame] | 34 | class OatQuickMethodHeader; |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 35 | class Thread; |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 36 | class ShadowFrame; |
Vladimir Marko | 3a21e38 | 2016-09-02 12:38:38 +0100 | [diff] [blame] | 37 | class StackVisitor; |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 38 | |
Elliott Hughes | 956af0f | 2014-12-11 14:34:28 -0800 | [diff] [blame] | 39 | // Manages exception delivery for Quick backend. |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 40 | class QuickExceptionHandler { |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 41 | public: |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 42 | QuickExceptionHandler(Thread* self, bool is_deoptimization) |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 43 | REQUIRES_SHARED(Locks::mutator_lock_); |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 44 | |
Andreas Gampe | 65b798e | 2015-04-06 09:35:22 -0700 | [diff] [blame] | 45 | NO_RETURN ~QuickExceptionHandler() { |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 46 | LOG(FATAL) << "UNREACHABLE"; // Expected to take long jump. |
Ian Rogers | 2c4257b | 2014-10-24 14:20:06 -0700 | [diff] [blame] | 47 | UNREACHABLE(); |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 48 | } |
| 49 | |
Alex Light | 2c8206f | 2018-06-08 14:51:09 -0700 | [diff] [blame] | 50 | // Find the catch handler for the given exception and call all required Instrumentation methods. |
| 51 | // Note this might result in the exception being caught being different from 'exception'. |
Mathieu Chartier | f5769e1 | 2017-01-10 15:54:41 -0800 | [diff] [blame] | 52 | void FindCatch(ObjPtr<mirror::Throwable> exception) REQUIRES_SHARED(Locks::mutator_lock_); |
Sebastien Hertz | 520633b | 2015-09-08 17:03:36 +0200 | [diff] [blame] | 53 | |
Mingyao Yang | f711f2c | 2016-05-23 12:29:39 -0700 | [diff] [blame] | 54 | // Deoptimize the stack to the upcall/some code that's not deoptimizeable. For |
| 55 | // every compiled frame, we create a "copy" shadow frame that will be executed |
| 56 | // with the interpreter. |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 57 | void DeoptimizeStack() REQUIRES_SHARED(Locks::mutator_lock_); |
Mingyao Yang | f711f2c | 2016-05-23 12:29:39 -0700 | [diff] [blame] | 58 | |
| 59 | // Deoptimize a single frame. It's directly triggered from compiled code. It |
| 60 | // has the following properties: |
| 61 | // - It deoptimizes a single frame, which can include multiple inlined frames. |
| 62 | // - It doesn't have return result or pending exception at the deoptimization point. |
| 63 | // - It always deoptimizes, even if IsDeoptimizeable() returns false for the |
| 64 | // code, since HDeoptimize always saves the full environment. So it overrides |
| 65 | // the result of IsDeoptimizeable(). |
| 66 | // - It can be either full-fragment, or partial-fragment deoptimization, depending |
| 67 | // on whether that single frame covers full or partial fragment. |
Nicolas Geoffray | 4e92c3c | 2017-05-08 09:34:26 +0100 | [diff] [blame] | 68 | void DeoptimizeSingleFrame(DeoptimizationKind kind) REQUIRES_SHARED(Locks::mutator_lock_); |
Mingyao Yang | f711f2c | 2016-05-23 12:29:39 -0700 | [diff] [blame] | 69 | |
| 70 | void DeoptimizePartialFragmentFixup(uintptr_t return_pc) |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 71 | REQUIRES_SHARED(Locks::mutator_lock_); |
Andreas Gampe | 639bdd1 | 2015-06-03 11:22:45 -0700 | [diff] [blame] | 72 | |
Sebastien Hertz | 520633b | 2015-09-08 17:03:36 +0200 | [diff] [blame] | 73 | // Update the instrumentation stack by removing all methods that will be unwound |
| 74 | // by the exception being thrown. |
Mingyao Yang | f711f2c | 2016-05-23 12:29:39 -0700 | [diff] [blame] | 75 | // Return the return pc of the last frame that's unwound. |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 76 | uintptr_t UpdateInstrumentationStack() REQUIRES_SHARED(Locks::mutator_lock_); |
Sebastien Hertz | 520633b | 2015-09-08 17:03:36 +0200 | [diff] [blame] | 77 | |
David Brazdil | 77a48ae | 2015-09-15 12:34:04 +0000 | [diff] [blame] | 78 | // Set up environment before delivering an exception to optimized code. |
| 79 | void SetCatchEnvironmentForOptimizedHandler(StackVisitor* stack_visitor) |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 80 | REQUIRES_SHARED(Locks::mutator_lock_); |
David Brazdil | 77a48ae | 2015-09-15 12:34:04 +0000 | [diff] [blame] | 81 | |
Sebastien Hertz | 520633b | 2015-09-08 17:03:36 +0200 | [diff] [blame] | 82 | // Long jump either to a catch handler or to the upcall. |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 83 | NO_RETURN void DoLongJump(bool smash_caller_saves = true) REQUIRES_SHARED(Locks::mutator_lock_); |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 84 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 85 | void SetHandlerQuickFrame(ArtMethod** handler_quick_frame) { |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 86 | handler_quick_frame_ = handler_quick_frame; |
| 87 | } |
| 88 | |
| 89 | void SetHandlerQuickFramePc(uintptr_t handler_quick_frame_pc) { |
| 90 | handler_quick_frame_pc_ = handler_quick_frame_pc; |
| 91 | } |
| 92 | |
Nicolas Geoffray | 524e7ea | 2015-10-16 17:13:34 +0100 | [diff] [blame] | 93 | void SetHandlerMethodHeader(const OatQuickMethodHeader* handler_method_header) { |
| 94 | handler_method_header_ = handler_method_header; |
| 95 | } |
| 96 | |
Andreas Gampe | 639bdd1 | 2015-06-03 11:22:45 -0700 | [diff] [blame] | 97 | void SetHandlerQuickArg0(uintptr_t handler_quick_arg0) { |
| 98 | handler_quick_arg0_ = handler_quick_arg0; |
| 99 | } |
| 100 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 101 | ArtMethod* GetHandlerMethod() const { |
Nicolas Geoffray | 51ad7fe | 2020-02-04 12:46:47 +0000 | [diff] [blame] | 102 | return *handler_quick_frame_; |
Ian Rogers | 5cf9819 | 2014-05-29 21:31:50 -0700 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | uint32_t GetHandlerDexPc() const { |
| 106 | return handler_dex_pc_; |
| 107 | } |
| 108 | |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 109 | void SetHandlerDexPc(uint32_t dex_pc) { |
| 110 | handler_dex_pc_ = dex_pc; |
| 111 | } |
| 112 | |
Roland Levillain | b77b698 | 2017-06-08 18:03:48 +0100 | [diff] [blame] | 113 | bool GetClearException() const { |
| 114 | return clear_exception_; |
| 115 | } |
| 116 | |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 117 | void SetClearException(bool clear_exception) { |
| 118 | clear_exception_ = clear_exception; |
| 119 | } |
| 120 | |
Hiroshi Yamauchi | 649278c | 2014-08-13 11:12:22 -0700 | [diff] [blame] | 121 | void SetHandlerFrameDepth(size_t frame_depth) { |
| 122 | handler_frame_depth_ = frame_depth; |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 123 | } |
| 124 | |
Mingyao Yang | f711f2c | 2016-05-23 12:29:39 -0700 | [diff] [blame] | 125 | bool IsFullFragmentDone() const { |
| 126 | return full_fragment_done_; |
| 127 | } |
| 128 | |
| 129 | void SetFullFragmentDone(bool full_fragment_done) { |
| 130 | full_fragment_done_ = full_fragment_done; |
| 131 | } |
| 132 | |
Andreas Gampe | 639bdd1 | 2015-06-03 11:22:45 -0700 | [diff] [blame] | 133 | // Walk the stack frames of the given thread, printing out non-runtime methods with their types |
Mingyao Yang | f711f2c | 2016-05-23 12:29:39 -0700 | [diff] [blame] | 134 | // of frames. Helps to verify that partial-fragment deopt really works as expected. |
Andreas Gampe | 639bdd1 | 2015-06-03 11:22:45 -0700 | [diff] [blame] | 135 | static void DumpFramesWithType(Thread* self, bool details = false) |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 136 | REQUIRES_SHARED(Locks::mutator_lock_); |
Andreas Gampe | 639bdd1 | 2015-06-03 11:22:45 -0700 | [diff] [blame] | 137 | |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 138 | private: |
| 139 | Thread* const self_; |
| 140 | Context* const context_; |
Sebastien Hertz | 520633b | 2015-09-08 17:03:36 +0200 | [diff] [blame] | 141 | // Should we deoptimize the stack? |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 142 | const bool is_deoptimization_; |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 143 | // Is method tracing active? |
Sebastien Hertz | 520633b | 2015-09-08 17:03:36 +0200 | [diff] [blame] | 144 | const bool method_tracing_active_; |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 145 | // Quick frame with found handler or last frame if no handler found. |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 146 | ArtMethod** handler_quick_frame_; |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 147 | // PC to branch to for the handler. |
| 148 | uintptr_t handler_quick_frame_pc_; |
Nicolas Geoffray | 524e7ea | 2015-10-16 17:13:34 +0100 | [diff] [blame] | 149 | // Quick code of the handler. |
| 150 | const OatQuickMethodHeader* handler_method_header_; |
Andreas Gampe | 639bdd1 | 2015-06-03 11:22:45 -0700 | [diff] [blame] | 151 | // The value for argument 0. |
| 152 | uintptr_t handler_quick_arg0_; |
Ian Rogers | 5cf9819 | 2014-05-29 21:31:50 -0700 | [diff] [blame] | 153 | // The handler's dex PC, zero implies an uncaught exception. |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 154 | uint32_t handler_dex_pc_; |
| 155 | // Should the exception be cleared as the catch block has no move-exception? |
| 156 | bool clear_exception_; |
Hiroshi Yamauchi | 649278c | 2014-08-13 11:12:22 -0700 | [diff] [blame] | 157 | // Frame depth of the catch handler or the upcall. |
| 158 | size_t handler_frame_depth_; |
Mingyao Yang | f711f2c | 2016-05-23 12:29:39 -0700 | [diff] [blame] | 159 | // Does the handler successfully walk the full fragment (not stopped |
| 160 | // by some code that's not deoptimizeable)? Even single-frame deoptimization |
| 161 | // can set this to true if the fragment contains only one quick frame. |
| 162 | bool full_fragment_done_; |
| 163 | |
| 164 | void PrepareForLongJumpToInvokeStubOrInterpreterBridge() |
Andreas Gampe | bdf7f1c | 2016-08-30 16:38:47 -0700 | [diff] [blame] | 165 | REQUIRES_SHARED(Locks::mutator_lock_); |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 166 | |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 167 | DISALLOW_COPY_AND_ASSIGN(QuickExceptionHandler); |
Sebastien Hertz | d45a1f5 | 2014-01-09 14:56:54 +0100 | [diff] [blame] | 168 | }; |
| 169 | |
| 170 | } // namespace art |
Sebastien Hertz | fd3077e | 2014-04-23 10:32:43 +0200 | [diff] [blame] | 171 | #endif // ART_RUNTIME_QUICK_EXCEPTION_HANDLER_H_ |