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