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 "art_method-inl.h"
18 #include "check_reference_map_visitor.h"
19 #include "jni.h"
20 
21 namespace art {
22 
23 #define CHECK_REGS_CONTAIN_REFS(dex_pc, abort_if_not_found, ...) do {                         \
24   int t[] = {__VA_ARGS__};                                                                    \
25   int t_size = sizeof(t) / sizeof(*t);                                                        \
26   const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();               \
27   uintptr_t native_quick_pc = method_header->ToNativeQuickPc(GetMethod(),                     \
28                                                              dex_pc,                          \
29                                                              abort_if_not_found);             \
30   if (native_quick_pc != UINTPTR_MAX) {                                                       \
31     CheckReferences(t,                                                                        \
32                     t_size,                                                                   \
33                     dex_pc,                                                                   \
34                     method_header->NativeQuickPcOffset(native_quick_pc),                      \
35                     /* search_for_valid_stack_map= */ true);                                  \
36   }                                                                                           \
37 } while (false);
38 
39 struct ReferenceMap2Visitor : public CheckReferenceMapVisitor {
REQUIRES_SHAREDart::ReferenceMap2Visitor40   explicit ReferenceMap2Visitor(Thread* thread) REQUIRES_SHARED(Locks::mutator_lock_)
41       : CheckReferenceMapVisitor(thread) {}
42 
VisitFrameart::ReferenceMap2Visitor43   bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
44     if (CheckReferenceMapVisitor::VisitFrame()) {
45       return true;
46     }
47     ArtMethod* m = GetMethod();
48     std::string m_name(m->GetName());
49 
50     // Given the method name and the number of times the method has been called,
51     // we know the Dex registers with live reference values. Assert that what we
52     // find is what is expected.
53     if (m_name.compare("f") == 0) {
54       CHECK_REGS_CONTAIN_REFS(0x06U, true, 8, 1);  // v8: this, v1: x
55       CHECK_REGS_CONTAIN_REFS(0x0cU, true, 8, 3, 1);  // v8: this, v3: y, v1: x
56       CHECK_REGS_CONTAIN_REFS(0x10U, true, 8, 3, 1);  // v8: this, v3: y, v1: x
57       // v2 is added because of the instruction at DexPC 0024. Object merges with 0 is Object. See:
58       //   0024: move-object v3, v2
59       //   0025: goto 0013
60       // Detailed dex instructions for ReferenceMap.java are at the end of this function.
61       // CHECK_REGS_CONTAIN_REFS(8, 3, 2, 1);  // v8: this, v3: y, v2: y, v1: x
62       // We eliminate the non-live registers at a return, so only v3 is live.
63       // Note that it is OK for a compiler to not have a dex map at this dex PC because
64       // a return is not necessarily a safepoint.
65       CHECK_REGS_CONTAIN_REFS(0x13U, false, 3);  // v3: y
66       // Note that v0: ex can be eliminated because it's a dead merge of two different exceptions.
67       CHECK_REGS_CONTAIN_REFS(0x18U, true, 8, 2, 1);  // v8: this, v2: y, v1: x (dead v0: ex)
68       CHECK_REGS_CONTAIN_REFS(0x21U, true, 8, 2, 1);  // v8: this, v2: y, v1: x (dead v0: ex)
69 
70       if (!GetCurrentOatQuickMethodHeader()->IsOptimized()) {
71         CHECK_REGS_CONTAIN_REFS(0x27U, true, 8, 4, 2, 1);  // v8: this, v4: ex, v2: y, v1: x
72       }
73       CHECK_REGS_CONTAIN_REFS(0x29U, true, 8, 4, 2, 1);  // v8: this, v4: ex, v2: y, v1: x
74       CHECK_REGS_CONTAIN_REFS(0x2cU, true, 8, 4, 2, 1);  // v8: this, v4: ex, v2: y, v1: x
75       // Note that it is OK for a compiler to not have a dex map at these two dex PCs because
76       // a goto is not necessarily a safepoint.
77       CHECK_REGS_CONTAIN_REFS(0x2fU, false, 8, 4, 3, 2, 1);  // v8: this, v4: ex, v3: y, v2: y, v1: x
78       CHECK_REGS_CONTAIN_REFS(0x32U, false, 8, 3, 2, 1, 0);  // v8: this, v3: y, v2: y, v1: x, v0: ex
79     }
80 
81     return true;
82   }
83 };
84 
85 // Dex instructions for the function 'f' in ReferenceMap.java
86 // Virtual methods   -
87 //    #0              : (in LReferenceMap;)
88 //      name          : 'f'
89 //      type          : '()Ljava/lang/Object;'
90 //      access        : 0x0000 ()
91 //      code          -
92 //      registers     : 9
93 //      ins           : 1
94 //      outs          : 2
95 //      insns size    : 51 16-bit code units
96 //      |[0001e8] ReferenceMap.f:()Ljava/lang/Object;
97 //      |0000: const/4 v4, #int 2 // #2
98 //      |0001: const/4 v7, #int 0 // #0
99 //      |0002: const/4 v6, #int 1 // #1
100 //
101 // 0:[Unknown],1:[Unknown],2:[Unknown],3:[Unknown],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
102 //      |0003: new-array v1, v4, [Ljava/lang/Object;  // type@0007
103 //      |0005: const/4 v2, #int 0 // #0
104 
105 // 0:[Unknown],1:[Reference: java.lang.Object[]],2:[Zero],3:[Unknown],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
106 //      |0006: new-instance v3, Ljava/lang/Object;  // type@0003
107 
108 // [Unknown],1:[Reference: java.lang.Object[]],2:[Zero],3:[Uninitialized Reference: java.lang.Object],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
109 //      |0008: +invoke-object-init/range {}, Ljava/lang/Object;.<init>:()V // method@0005
110 //      |000b: const/4 v4, #int 2 // #2
111 
112 // 0:[Unknown],1:[Reference: java.lang.Object[]],2:[Zero],3:[Reference: java.lang.Object],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
113 //      |000c: aput-object v3, v1, v4
114 
115 // 0:[Unknown],1:[Reference: java.lang.Object[]],2:[Zero],3:[Reference: java.lang.Object],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
116 //      |000e: aput-object v3, v1, v6
117 
118 // 0:[Unknown],1:[Reference: java.lang.Object[]],2:[Zero],3:[Reference: java.lang.Object],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
119 //      |0010: +invoke-virtual-quick {v8, v7}, [000c] // vtable #000c
120 
121 // 0:[Conflict],1:[Conflict],2:[Conflict],3:[Reference: java.lang.Object],4:[Conflict],5:[Conflict],6:[Conflict],7:[Conflict],8:[Conflict],
122 //      |0013: return-object v3
123 //      |0014: move-exception v0
124 
125 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
126 //      |0015: if-nez v2, 001f // +000a
127 //      |0017: const/4 v4, #int 1 // #1
128 
129 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[32-bit Constant: 1],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
130 //      |0018: new-instance v5, Ljava/lang/Object;  // type@0003
131 
132 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[32-bit Constant: 1],5:[Uninitialized Reference: java.lang.Object],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
133 //      |001a: +invoke-object-init/range {}, Ljava/lang/Object;.<init>:()V // method@0005
134 
135 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[32-bit Constant: 1],5:[Reference: java.lang.Object],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
136 //      |001d: aput-object v5, v1, v4
137 
138 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[32-bit Constant: 2],5:[Conflict],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
139 //      |001f: aput-object v2, v1, v6
140 
141 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[32-bit Constant: 2],5:[Conflict],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
142 //      |0021: +invoke-virtual-quick {v8, v7}, [000c] // vtable #000c
143 //      |0024: move-object v3, v2
144 
145 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Reference: java.lang.Object],4:[32-bit Constant: 2],5:[Conflict],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
146 //      |0025: goto 0013 // -0012
147 //      |0026: move-exception v4
148 
149 // 0:[Conflict],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[Reference: java.lang.Throwable],5:[Conflict],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
150 //      |0027: aput-object v2, v1, v6
151 
152 // 0:[Conflict],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[Reference: java.lang.Throwable],5:[Conflict],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
153 //      |0029: +invoke-virtual-quick {v8, v7}, [000c] // vtable #000c
154 
155 // 0:[Conflict],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Conflict],4:[Reference: java.lang.Throwable],5:[Conflict],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
156 //      |002c: throw v4
157 //      |002d: move-exception v4
158 //      |002e: move-object v2, v3
159 
160 // 0:[Unknown],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Reference: java.lang.Object],4:[Reference: java.lang.Throwable],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
161 //      |002f: goto 0027 // -0008
162 //      |0030: move-exception v0
163 //      |0031: move-object v2, v3
164 
165 // 0:[Reference: java.lang.Exception],1:[Reference: java.lang.Object[]],2:[Reference: java.lang.Object],3:[Reference: java.lang.Object],4:[32-bit Constant: 2],5:[Unknown],6:[32-bit Constant: 1],7:[Zero],8:[Reference: ReferenceMap],
166 //      |0032: goto 0015 // -001d
167 //      catches       : 3
168 //        0x0006 - 0x000b
169 //          Ljava/lang/Exception; -> 0x0014
170 //          <any> -> 0x0026
171 //        0x000c - 0x000e
172 //          Ljava/lang/Exception; -> 0x0030
173 //          <any> -> 0x002d
174 //        0x0018 - 0x001f
175 //          <any> -> 0x0026
176 //      positions     :
177 //        0x0003 line=8
178 //        0x0005 line=9
179 //        0x0006 line=11
180 //        0x000b line=12
181 //        0x000e line=18
182 //        0x0010 line=19
183 //        0x0013 line=21
184 //        0x0014 line=13
185 //        0x0015 line=14
186 //        0x0017 line=15
187 //        0x001f line=18
188 //        0x0021 line=19
189 //        0x0025 line=20
190 //        0x0026 line=18
191 //        0x0029 line=19
192 //        0x002d line=18
193 //        0x0030 line=13
194 //      locals        :
195 //        0x0006 - 0x000b reg=2 y Ljava/lang/Object;
196 //        0x000b - 0x0013 reg=3 y Ljava/lang/Object;
197 //        0x0014 - 0x0015 reg=2 y Ljava/lang/Object;
198 //        0x0015 - 0x0026 reg=0 ex Ljava/lang/Exception;
199 //        0x002d - 0x0032 reg=3 y Ljava/lang/Object;
200 //        0x0005 - 0x0033 reg=1 x [Ljava/lang/Object;
201 //        0x0032 - 0x0033 reg=2 y Ljava/lang/Object;
202 //        0x0000 - 0x0033 reg=8 this LReferenceMap;
203 
Java_Main_refmap(JNIEnv *,jobject,jint count)204 extern "C" JNIEXPORT jint JNICALL Java_Main_refmap(JNIEnv*, jobject, jint count) {
205   // Visitor
206   ScopedObjectAccess soa(Thread::Current());
207   ReferenceMap2Visitor mapper(soa.Self());
208   mapper.WalkStack();
209 
210   return count + 1;
211 }
212 
213 }  // namespace art
214