Home | History | Annotate | Download | only in compiler 
      1 /*
      2  * Copyright (C) 2011 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 #include <memory>
     18 
     19 #include "base/arena_allocator.h"
     20 #include "base/enums.h"
     21 #include "class_linker.h"
     22 #include "common_runtime_test.h"
     23 #include "dex_file.h"
     24 #include "dex_file-inl.h"
     25 #include "gtest/gtest.h"
     26 #include "leb128.h"
     27 #include "mirror/class-inl.h"
     28 #include "mirror/object_array-inl.h"
     29 #include "mirror/object-inl.h"
     30 #include "mirror/stack_trace_element.h"
     31 #include "oat_quick_method_header.h"
     32 #include "optimizing/stack_map_stream.h"
     33 #include "runtime-inl.h"
     34 #include "scoped_thread_state_change-inl.h"
     35 #include "handle_scope-inl.h"
     36 #include "thread.h"
     37 
     38 namespace art {
     39 
     40 class ExceptionTest : public CommonRuntimeTest {
     41  protected:
     42   virtual void SetUp() {
     43     CommonRuntimeTest::SetUp();
     44 
     45     ScopedObjectAccess soa(Thread::Current());
     46     StackHandleScope<2> hs(soa.Self());
     47     Handle<mirror::ClassLoader> class_loader(
     48         hs.NewHandle(soa.Decode<mirror::ClassLoader>(LoadDex("ExceptionHandle"))));
     49     my_klass_ = class_linker_->FindClass(soa.Self(), "LExceptionHandle;", class_loader);
     50     ASSERT_TRUE(my_klass_ != nullptr);
     51     Handle<mirror::Class> klass(hs.NewHandle(my_klass_));
     52     class_linker_->EnsureInitialized(soa.Self(), klass, true, true);
     53     my_klass_ = klass.Get();
     54 
     55     dex_ = my_klass_->GetDexCache()->GetDexFile();
     56 
     57     uint32_t code_size = 12;
     58     for (size_t i = 0 ; i < code_size; i++) {
     59       fake_code_.push_back(0x70 | i);
     60     }
     61 
     62     ArenaPool pool;
     63     ArenaAllocator allocator(&pool);
     64     StackMapStream stack_maps(&allocator, kRuntimeISA);
     65     stack_maps.BeginStackMapEntry(/* dex_pc */ 3u,
     66                                   /* native_pc_offset */ 3u,
     67                                   /* register_mask */ 0u,
     68                                   /* sp_mask */ nullptr,
     69                                   /* num_dex_registers */ 0u,
     70                                   /* inlining_depth */ 0u);
     71     stack_maps.EndStackMapEntry();
     72     size_t stack_maps_size = stack_maps.PrepareForFillIn();
     73     size_t stack_maps_offset = stack_maps_size +  sizeof(OatQuickMethodHeader);
     74 
     75     fake_header_code_and_maps_.resize(stack_maps_offset + fake_code_.size());
     76     MemoryRegion stack_maps_region(&fake_header_code_and_maps_[0], stack_maps_size);
     77     stack_maps.FillInCodeInfo(stack_maps_region);
     78     OatQuickMethodHeader method_header(stack_maps_offset, 0u, 4 * sizeof(void*), 0u, 0u, code_size);
     79     memcpy(&fake_header_code_and_maps_[stack_maps_size], &method_header, sizeof(method_header));
     80     std::copy(fake_code_.begin(),
     81               fake_code_.end(),
     82               fake_header_code_and_maps_.begin() + stack_maps_offset);
     83 
     84     // Align the code.
     85     const size_t alignment = GetInstructionSetAlignment(kRuntimeISA);
     86     fake_header_code_and_maps_.reserve(fake_header_code_and_maps_.size() + alignment);
     87     const void* unaligned_code_ptr =
     88         fake_header_code_and_maps_.data() + (fake_header_code_and_maps_.size() - code_size);
     89     size_t offset = dchecked_integral_cast<size_t>(reinterpret_cast<uintptr_t>(unaligned_code_ptr));
     90     size_t padding = RoundUp(offset, alignment) - offset;
     91     // Make sure no resizing takes place.
     92     CHECK_GE(fake_header_code_and_maps_.capacity(), fake_header_code_and_maps_.size() + padding);
     93     fake_header_code_and_maps_.insert(fake_header_code_and_maps_.begin(), padding, 0);
     94     const void* code_ptr = reinterpret_cast<const uint8_t*>(unaligned_code_ptr) + padding;
     95     CHECK_EQ(code_ptr,
     96              static_cast<const void*>(fake_header_code_and_maps_.data() +
     97                                           (fake_header_code_and_maps_.size() - code_size)));
     98 
     99     if (kRuntimeISA == kArm) {
    100       // Check that the Thumb2 adjustment will be a NOP, see EntryPointToCodePointer().
    101       CHECK_ALIGNED(stack_maps_offset, 2);
    102     }
    103 
    104     method_f_ = my_klass_->FindVirtualMethod("f", "()I", kRuntimePointerSize);
    105     ASSERT_TRUE(method_f_ != nullptr);
    106     method_f_->SetEntryPointFromQuickCompiledCode(code_ptr);
    107 
    108     method_g_ = my_klass_->FindVirtualMethod("g", "(I)V", kRuntimePointerSize);
    109     ASSERT_TRUE(method_g_ != nullptr);
    110     method_g_->SetEntryPointFromQuickCompiledCode(code_ptr);
    111   }
    112 
    113   const DexFile* dex_;
    114 
    115   std::vector<uint8_t> fake_code_;
    116   std::vector<uint8_t> fake_header_code_and_maps_;
    117 
    118   ArtMethod* method_f_;
    119   ArtMethod* method_g_;
    120 
    121  private:
    122   mirror::Class* my_klass_;
    123 };
    124 
    125 TEST_F(ExceptionTest, FindCatchHandler) {
    126   ScopedObjectAccess soa(Thread::Current());
    127   const DexFile::CodeItem* code_item = dex_->GetCodeItem(method_f_->GetCodeItemOffset());
    128 
    129   ASSERT_TRUE(code_item != nullptr);
    130 
    131   ASSERT_EQ(2u, code_item->tries_size_);
    132   ASSERT_NE(0u, code_item->insns_size_in_code_units_);
    133 
    134   const DexFile::TryItem *t0, *t1;
    135   t0 = dex_->GetTryItems(*code_item, 0);
    136   t1 = dex_->GetTryItems(*code_item, 1);
    137   EXPECT_LE(t0->start_addr_, t1->start_addr_);
    138   {
    139     CatchHandlerIterator iter(*code_item, 4 /* Dex PC in the first try block */);
    140     EXPECT_STREQ("Ljava/io/IOException;", dex_->StringByTypeIdx(iter.GetHandlerTypeIndex()));
    141     ASSERT_TRUE(iter.HasNext());
    142     iter.Next();
    143     EXPECT_STREQ("Ljava/lang/Exception;", dex_->StringByTypeIdx(iter.GetHandlerTypeIndex()));
    144     ASSERT_TRUE(iter.HasNext());
    145     iter.Next();
    146     EXPECT_FALSE(iter.HasNext());
    147   }
    148   {
    149     CatchHandlerIterator iter(*code_item, 8 /* Dex PC in the second try block */);
    150     EXPECT_STREQ("Ljava/io/IOException;", dex_->StringByTypeIdx(iter.GetHandlerTypeIndex()));
    151     ASSERT_TRUE(iter.HasNext());
    152     iter.Next();
    153     EXPECT_FALSE(iter.HasNext());
    154   }
    155   {
    156     CatchHandlerIterator iter(*code_item, 11 /* Dex PC not in any try block */);
    157     EXPECT_FALSE(iter.HasNext());
    158   }
    159 }
    160 
    161 TEST_F(ExceptionTest, StackTraceElement) {
    162   Thread* thread = Thread::Current();
    163   thread->TransitionFromSuspendedToRunnable();
    164   bool started = runtime_->Start();
    165   CHECK(started);
    166   JNIEnv* env = thread->GetJniEnv();
    167   ScopedObjectAccess soa(env);
    168 
    169   std::vector<uintptr_t> fake_stack;
    170   Runtime* r = Runtime::Current();
    171   r->SetInstructionSet(kRuntimeISA);
    172   ArtMethod* save_method = r->CreateCalleeSaveMethod();
    173   r->SetCalleeSaveMethod(save_method, Runtime::kSaveAllCalleeSaves);
    174   QuickMethodFrameInfo frame_info = r->GetRuntimeMethodFrameInfo(save_method);
    175 
    176   ASSERT_EQ(kStackAlignment, 16U);
    177   // ASSERT_EQ(sizeof(uintptr_t), sizeof(uint32_t));
    178 
    179 
    180   // Create three fake stack frames with mapping data created in SetUp. We map offset 3 in the
    181   // code to dex pc 3.
    182   const uint32_t dex_pc = 3;
    183 
    184   // Create the stack frame for the callee save method, expected by the runtime.
    185   fake_stack.push_back(reinterpret_cast<uintptr_t>(save_method));
    186   for (size_t i = 0; i < frame_info.FrameSizeInBytes() - 2 * sizeof(uintptr_t);
    187        i += sizeof(uintptr_t)) {
    188     fake_stack.push_back(0);
    189   }
    190 
    191   fake_stack.push_back(method_g_->GetOatQuickMethodHeader(0)->ToNativeQuickPc(
    192       method_g_, dex_pc, /* is_catch_handler */ false));  // return pc
    193 
    194   // Create/push fake 16byte stack frame for method g
    195   fake_stack.push_back(reinterpret_cast<uintptr_t>(method_g_));
    196   fake_stack.push_back(0);
    197   fake_stack.push_back(0);
    198   fake_stack.push_back(method_g_->GetOatQuickMethodHeader(0)->ToNativeQuickPc(
    199       method_g_, dex_pc, /* is_catch_handler */ false));  // return pc
    200 
    201   // Create/push fake 16byte stack frame for method f
    202   fake_stack.push_back(reinterpret_cast<uintptr_t>(method_f_));
    203   fake_stack.push_back(0);
    204   fake_stack.push_back(0);
    205   fake_stack.push_back(0xEBAD6070);  // return pc
    206 
    207   // Push Method* of null to terminate the trace
    208   fake_stack.push_back(0);
    209 
    210   // Push null values which will become null incoming arguments.
    211   fake_stack.push_back(0);
    212   fake_stack.push_back(0);
    213   fake_stack.push_back(0);
    214 
    215   // Set up thread to appear as if we called out of method_g_ at pc dex 3
    216   thread->SetTopOfStack(reinterpret_cast<ArtMethod**>(&fake_stack[0]));
    217 
    218   jobject internal = thread->CreateInternalStackTrace<false>(soa);
    219   ASSERT_TRUE(internal != nullptr);
    220   jobjectArray ste_array = Thread::InternalStackTraceToStackTraceElementArray(soa, internal);
    221   ASSERT_TRUE(ste_array != nullptr);
    222   auto trace_array = soa.Decode<mirror::ObjectArray<mirror::StackTraceElement>>(ste_array);
    223 
    224   ASSERT_TRUE(trace_array != nullptr);
    225   ASSERT_TRUE(trace_array->Get(0) != nullptr);
    226   EXPECT_STREQ("ExceptionHandle",
    227                trace_array->Get(0)->GetDeclaringClass()->ToModifiedUtf8().c_str());
    228   EXPECT_STREQ("ExceptionHandle.java",
    229                trace_array->Get(0)->GetFileName()->ToModifiedUtf8().c_str());
    230   EXPECT_STREQ("g", trace_array->Get(0)->GetMethodName()->ToModifiedUtf8().c_str());
    231   EXPECT_EQ(37, trace_array->Get(0)->GetLineNumber());
    232 
    233   ASSERT_TRUE(trace_array->Get(1) != nullptr);
    234   EXPECT_STREQ("ExceptionHandle",
    235                trace_array->Get(1)->GetDeclaringClass()->ToModifiedUtf8().c_str());
    236   EXPECT_STREQ("ExceptionHandle.java",
    237                trace_array->Get(1)->GetFileName()->ToModifiedUtf8().c_str());
    238   EXPECT_STREQ("f", trace_array->Get(1)->GetMethodName()->ToModifiedUtf8().c_str());
    239   EXPECT_EQ(22, trace_array->Get(1)->GetLineNumber());
    240 
    241   thread->SetTopOfStack(nullptr);  // Disarm the assertion that no code is running when we detach.
    242 }
    243 
    244 }  // namespace art
    245