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