Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 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 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_VERIFIER_METHOD_VERIFIER_H_ |
| 18 | #define ART_RUNTIME_VERIFIER_METHOD_VERIFIER_H_ |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 19 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 20 | #include <set> |
| 21 | #include <vector> |
| 22 | |
Elliott Hughes | 1aa246d | 2012-12-13 09:29:36 -0800 | [diff] [blame] | 23 | #include "base/casts.h" |
Elliott Hughes | 7616005 | 2012-12-12 16:31:20 -0800 | [diff] [blame] | 24 | #include "base/macros.h" |
Elliott Hughes | 1aa246d | 2012-12-13 09:29:36 -0800 | [diff] [blame] | 25 | #include "base/stl_util.h" |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 26 | #include "class_reference.h" |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 27 | #include "dex_file.h" |
| 28 | #include "dex_instruction.h" |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 29 | #include "instruction_flags.h" |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 30 | #include "method_reference.h" |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 31 | #include "mirror/object.h" |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 32 | #include "reg_type.h" |
Sameer Abu Asal | 51a5fb7 | 2013-02-19 14:25:01 -0800 | [diff] [blame] | 33 | #include "reg_type_cache-inl.h" |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 34 | #include "register_line.h" |
| 35 | #include "safe_map.h" |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 36 | #include "UniquePtr.h" |
| 37 | |
| 38 | namespace art { |
| 39 | |
| 40 | struct ReferenceMap2Visitor; |
| 41 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 42 | namespace verifier { |
| 43 | |
| 44 | class MethodVerifier; |
Ian Rogers | 46c6bb2 | 2012-09-18 13:47:36 -0700 | [diff] [blame] | 45 | class DexPcToReferenceMap; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 46 | |
| 47 | /* |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 48 | * "Direct" and "virtual" methods are stored independently. The type of call used to invoke the |
| 49 | * method determines which list we search, and whether we travel up into superclasses. |
| 50 | * |
| 51 | * (<clinit>, <init>, and methods declared "private" or "static" are stored in the "direct" list. |
| 52 | * All others are stored in the "virtual" list.) |
| 53 | */ |
| 54 | enum MethodType { |
| 55 | METHOD_UNKNOWN = 0, |
| 56 | METHOD_DIRECT, // <init>, private |
| 57 | METHOD_STATIC, // static |
| 58 | METHOD_VIRTUAL, // virtual, super |
| 59 | METHOD_INTERFACE // interface |
| 60 | }; |
Ian Rogers | 2fc1427 | 2012-08-30 10:56:57 -0700 | [diff] [blame] | 61 | std::ostream& operator<<(std::ostream& os, const MethodType& rhs); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 62 | |
| 63 | /* |
| 64 | * An enumeration of problems that can turn up during verification. |
| 65 | * Both VERIFY_ERROR_BAD_CLASS_SOFT and VERIFY_ERROR_BAD_CLASS_HARD denote failures that cause |
| 66 | * the entire class to be rejected. However, VERIFY_ERROR_BAD_CLASS_SOFT denotes a soft failure |
| 67 | * that can potentially be corrected, and the verifier will try again at runtime. |
| 68 | * VERIFY_ERROR_BAD_CLASS_HARD denotes a hard failure that can't be corrected, and will cause |
| 69 | * the class to remain uncompiled. Other errors denote verification errors that cause bytecode |
| 70 | * to be rewritten to fail at runtime. |
| 71 | */ |
| 72 | enum VerifyError { |
Brian Carlstrom | 7934ac2 | 2013-07-26 10:54:15 -0700 | [diff] [blame] | 73 | VERIFY_ERROR_BAD_CLASS_HARD, // VerifyError; hard error that skips compilation. |
| 74 | VERIFY_ERROR_BAD_CLASS_SOFT, // VerifyError; soft error that verifies again at runtime. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 75 | |
Brian Carlstrom | 7934ac2 | 2013-07-26 10:54:15 -0700 | [diff] [blame] | 76 | VERIFY_ERROR_NO_CLASS, // NoClassDefFoundError. |
| 77 | VERIFY_ERROR_NO_FIELD, // NoSuchFieldError. |
| 78 | VERIFY_ERROR_NO_METHOD, // NoSuchMethodError. |
| 79 | VERIFY_ERROR_ACCESS_CLASS, // IllegalAccessError. |
| 80 | VERIFY_ERROR_ACCESS_FIELD, // IllegalAccessError. |
| 81 | VERIFY_ERROR_ACCESS_METHOD, // IllegalAccessError. |
| 82 | VERIFY_ERROR_CLASS_CHANGE, // IncompatibleClassChangeError. |
| 83 | VERIFY_ERROR_INSTANTIATION, // InstantiationError. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 84 | }; |
| 85 | std::ostream& operator<<(std::ostream& os, const VerifyError& rhs); |
| 86 | |
| 87 | /* |
| 88 | * Identifies the type of reference in the instruction that generated the verify error |
| 89 | * (e.g. VERIFY_ERROR_ACCESS_CLASS could come from a method, field, or class reference). |
| 90 | * |
| 91 | * This must fit in two bits. |
| 92 | */ |
| 93 | enum VerifyErrorRefType { |
| 94 | VERIFY_ERROR_REF_CLASS = 0, |
| 95 | VERIFY_ERROR_REF_FIELD = 1, |
| 96 | VERIFY_ERROR_REF_METHOD = 2, |
| 97 | }; |
| 98 | const int kVerifyErrorRefTypeShift = 6; |
| 99 | |
| 100 | // We don't need to store the register data for many instructions, because we either only need |
| 101 | // it at branch points (for verification) or GC points and branches (for verification + |
| 102 | // type-precise register analysis). |
| 103 | enum RegisterTrackingMode { |
| 104 | kTrackRegsBranches, |
Sameer Abu Asal | 02c4223 | 2013-04-30 12:09:45 -0700 | [diff] [blame] | 105 | kTrackCompilerInterestPoints, |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 106 | kTrackRegsAll, |
| 107 | }; |
| 108 | |
Ian Rogers | 2bcb4a4 | 2012-11-08 10:39:18 -0800 | [diff] [blame] | 109 | // A mapping from a dex pc to the register line statuses as they are immediately prior to the |
| 110 | // execution of that instruction. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 111 | class PcToRegisterLineTable { |
| 112 | public: |
| 113 | PcToRegisterLineTable() {} |
| 114 | ~PcToRegisterLineTable() { |
| 115 | STLDeleteValues(&pc_to_register_line_); |
| 116 | } |
| 117 | |
| 118 | // Initialize the RegisterTable. Every instruction address can have a different set of information |
| 119 | // about what's in which register, but for verification purposes we only need to store it at |
| 120 | // branch target addresses (because we merge into that). |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 121 | void Init(RegisterTrackingMode mode, InstructionFlags* flags, uint32_t insns_size, |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 122 | uint16_t registers_size, MethodVerifier* verifier); |
| 123 | |
| 124 | RegisterLine* GetLine(size_t idx) { |
| 125 | Table::iterator result = pc_to_register_line_.find(idx); // TODO: C++0x auto |
| 126 | if (result == pc_to_register_line_.end()) { |
| 127 | return NULL; |
| 128 | } else { |
| 129 | return result->second; |
| 130 | } |
| 131 | } |
| 132 | |
| 133 | private: |
| 134 | typedef SafeMap<int32_t, RegisterLine*> Table; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 135 | Table pc_to_register_line_; |
| 136 | }; |
| 137 | |
| 138 | // The verifier |
| 139 | class MethodVerifier { |
| 140 | public: |
jeffhao | f1e6b7c | 2012-06-05 18:33:30 -0700 | [diff] [blame] | 141 | enum FailureKind { |
| 142 | kNoFailure, |
| 143 | kSoftFailure, |
| 144 | kHardFailure, |
| 145 | }; |
| 146 | |
| 147 | /* Verify a class. Returns "kNoFailure" on success. */ |
Jeff Hao | ee98895 | 2013-04-16 14:23:47 -0700 | [diff] [blame] | 148 | static FailureKind VerifyClass(const mirror::Class* klass, std::string& error, |
| 149 | bool allow_soft_failures) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 150 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 151 | static FailureKind VerifyClass(const DexFile* dex_file, mirror::DexCache* dex_cache, |
| 152 | mirror::ClassLoader* class_loader, uint32_t class_def_idx, |
Jeff Hao | ee98895 | 2013-04-16 14:23:47 -0700 | [diff] [blame] | 153 | std::string& error, bool allow_soft_failures) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 154 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 155 | |
Ian Rogers | 2bcb4a4 | 2012-11-08 10:39:18 -0800 | [diff] [blame] | 156 | static void VerifyMethodAndDump(std::ostream& os, uint32_t method_idx, const DexFile* dex_file, |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 157 | mirror::DexCache* dex_cache, mirror::ClassLoader* class_loader, |
Ian Rogers | 2bcb4a4 | 2012-11-08 10:39:18 -0800 | [diff] [blame] | 158 | uint32_t class_def_idx, const DexFile::CodeItem* code_item, |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 159 | mirror::AbstractMethod* method, uint32_t method_access_flags) |
Ian Rogers | 2bcb4a4 | 2012-11-08 10:39:18 -0800 | [diff] [blame] | 160 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 161 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 162 | uint8_t EncodePcToReferenceMapData() const; |
| 163 | |
| 164 | uint32_t DexFileVersion() const { |
| 165 | return dex_file_->GetVersion(); |
| 166 | } |
| 167 | |
| 168 | RegTypeCache* GetRegTypeCache() { |
| 169 | return ®_types_; |
| 170 | } |
| 171 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 172 | // Log a verification failure. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 173 | std::ostream& Fail(VerifyError error); |
| 174 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 175 | // Log for verification information. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 176 | std::ostream& LogVerifyInfo() { |
Ian Rogers | 2bcb4a4 | 2012-11-08 10:39:18 -0800 | [diff] [blame] | 177 | return info_messages_ << "VFY: " << PrettyMethod(dex_method_idx_, *dex_file_) |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 178 | << '[' << reinterpret_cast<void*>(work_insn_idx_) << "] : "; |
| 179 | } |
| 180 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 181 | // Dump the failures encountered by the verifier. |
| 182 | std::ostream& DumpFailures(std::ostream& os); |
| 183 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 184 | // Dump the state of the verifier, namely each instruction, what flags are set on it, register |
| 185 | // information |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 186 | void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 187 | |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 188 | static const std::vector<uint8_t>* GetDexGcMap(MethodReference ref) |
Ian Rogers | 0c7abda | 2012-09-19 13:33:42 -0700 | [diff] [blame] | 189 | LOCKS_EXCLUDED(dex_gc_maps_lock_); |
Elliott Hughes | 0a1038b | 2012-06-14 16:24:17 -0700 | [diff] [blame] | 190 | |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 191 | static const MethodReference* GetDevirtMap(const MethodReference& ref, uint32_t dex_pc) |
Sameer Abu Asal | 02c4223 | 2013-04-30 12:09:45 -0700 | [diff] [blame] | 192 | LOCKS_EXCLUDED(devirt_maps_lock_); |
| 193 | |
Dragos Sbirlea | 980d16b | 2013-06-04 15:01:40 -0700 | [diff] [blame] | 194 | // Returns true if the cast can statically be verified to be redundant |
| 195 | // by using the check-cast elision peephole optimization in the verifier |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 196 | static bool IsSafeCast(MethodReference ref, uint32_t pc) LOCKS_EXCLUDED(safecast_map_lock_); |
Dragos Sbirlea | 980d16b | 2013-06-04 15:01:40 -0700 | [diff] [blame] | 197 | |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 198 | // Fills 'monitor_enter_dex_pcs' with the dex pcs of the monitor-enter instructions corresponding |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 199 | // to the locks held at 'dex_pc' in method 'm'. |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 200 | static void FindLocksAtDexPc(mirror::AbstractMethod* m, uint32_t dex_pc, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 201 | std::vector<uint32_t>& monitor_enter_dex_pcs) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 202 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 203 | |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 204 | // Returns the accessed field corresponding to the quick instruction's field |
| 205 | // offset at 'dex_pc' in method 'm'. |
| 206 | static mirror::Field* FindAccessedFieldAtDexPc(mirror::AbstractMethod* m, |
| 207 | uint32_t dex_pc) |
| 208 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 209 | |
| 210 | // Returns the invoked method corresponding to the quick instruction's vtable |
| 211 | // index at 'dex_pc' in method 'm'. |
| 212 | static mirror::AbstractMethod* FindInvokedMethodAtDexPc(mirror::AbstractMethod* m, |
| 213 | uint32_t dex_pc) |
| 214 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 215 | |
Sameer Abu Asal | 51a5fb7 | 2013-02-19 14:25:01 -0800 | [diff] [blame] | 216 | static void Init() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 0a1038b | 2012-06-14 16:24:17 -0700 | [diff] [blame] | 217 | static void Shutdown(); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 218 | |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 219 | static bool IsClassRejected(ClassReference ref) |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 220 | LOCKS_EXCLUDED(rejected_classes_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 221 | |
Elliott Hughes | 4993bbc | 2013-01-10 15:41:25 -0800 | [diff] [blame] | 222 | bool CanLoadClasses() const { |
| 223 | return can_load_classes_; |
| 224 | } |
| 225 | |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 226 | MethodVerifier(const DexFile* dex_file, mirror::DexCache* dex_cache, |
| 227 | mirror::ClassLoader* class_loader, uint32_t class_def_idx, |
| 228 | const DexFile::CodeItem* code_item, |
| 229 | uint32_t method_idx, mirror::AbstractMethod* method, |
Jeff Hao | ee98895 | 2013-04-16 14:23:47 -0700 | [diff] [blame] | 230 | uint32_t access_flags, bool can_load_classes, bool allow_soft_failures) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 231 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 232 | |
Sebastien Hertz | c6c6e22 | 2013-08-02 14:19:57 +0200 | [diff] [blame] | 233 | ~MethodVerifier() { |
| 234 | STLDeleteElements(&failure_messages_); |
| 235 | } |
| 236 | |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 237 | // Run verification on the method. Returns true if verification completes and false if the input |
| 238 | // has an irrecoverable corruption. |
| 239 | bool Verify() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 240 | |
| 241 | // Describe VRegs at the given dex pc. |
| 242 | std::vector<int32_t> DescribeVRegs(uint32_t dex_pc); |
| 243 | |
Sebastien Hertz | 4d4adb1 | 2013-07-24 16:14:19 +0200 | [diff] [blame] | 244 | static bool IsCandidateForCompilation(const DexFile::CodeItem* code_item, |
| 245 | const uint32_t access_flags); |
| 246 | |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 247 | private: |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 248 | // Adds the given string to the beginning of the last failure message. |
| 249 | void PrependToLastFailMessage(std::string); |
| 250 | |
| 251 | // Adds the given string to the end of the last failure message. |
| 252 | void AppendToLastFailMessage(std::string); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 253 | |
| 254 | /* |
| 255 | * Perform verification on a single method. |
| 256 | * |
| 257 | * We do this in three passes: |
| 258 | * (1) Walk through all code units, determining instruction locations, |
| 259 | * widths, and other characteristics. |
| 260 | * (2) Walk through all code units, performing static checks on |
| 261 | * operands. |
| 262 | * (3) Iterate through the method, checking type safety and looking |
| 263 | * for code flow problems. |
Ian Rogers | e1758fe | 2012-04-19 11:31:15 -0700 | [diff] [blame] | 264 | */ |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 265 | static FailureKind VerifyMethod(uint32_t method_idx, const DexFile* dex_file, |
| 266 | mirror::DexCache* dex_cache, |
| 267 | mirror::ClassLoader* class_loader, uint32_t class_def_idx, |
| 268 | const DexFile::CodeItem* code_item, |
Jeff Hao | ee98895 | 2013-04-16 14:23:47 -0700 | [diff] [blame] | 269 | mirror::AbstractMethod* method, uint32_t method_access_flags, |
| 270 | bool allow_soft_failures) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 271 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | e1758fe | 2012-04-19 11:31:15 -0700 | [diff] [blame] | 272 | |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 273 | void FindLocksAtDexPc() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 274 | |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 275 | mirror::Field* FindAccessedFieldAtDexPc(uint32_t dex_pc) |
| 276 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 277 | |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 278 | mirror::AbstractMethod* FindInvokedMethodAtDexPc(uint32_t dex_pc) |
| 279 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 280 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 281 | /* |
| 282 | * Compute the width of the instruction at each address in the instruction stream, and store it in |
| 283 | * insn_flags_. Addresses that are in the middle of an instruction, or that are part of switch |
| 284 | * table data, are not touched (so the caller should probably initialize "insn_flags" to zero). |
| 285 | * |
| 286 | * The "new_instance_count_" and "monitor_enter_count_" fields in vdata are also set. |
| 287 | * |
| 288 | * Performs some static checks, notably: |
| 289 | * - opcode of first instruction begins at index 0 |
| 290 | * - only documented instructions may appear |
| 291 | * - each instruction follows the last |
| 292 | * - last byte of last instruction is at (code_length-1) |
| 293 | * |
| 294 | * Logs an error and returns "false" on failure. |
| 295 | */ |
| 296 | bool ComputeWidthsAndCountOps(); |
| 297 | |
| 298 | /* |
| 299 | * Set the "in try" flags for all instructions protected by "try" statements. Also sets the |
| 300 | * "branch target" flags for exception handlers. |
| 301 | * |
| 302 | * Call this after widths have been set in "insn_flags". |
| 303 | * |
| 304 | * Returns "false" if something in the exception table looks fishy, but we're expecting the |
| 305 | * exception table to be somewhat sane. |
| 306 | */ |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 307 | bool ScanTryCatchBlocks() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 308 | |
| 309 | /* |
| 310 | * Perform static verification on all instructions in a method. |
| 311 | * |
| 312 | * Walks through instructions in a method calling VerifyInstruction on each. |
| 313 | */ |
| 314 | bool VerifyInstructions(); |
| 315 | |
| 316 | /* |
| 317 | * Perform static verification on an instruction. |
| 318 | * |
| 319 | * As a side effect, this sets the "branch target" flags in InsnFlags. |
| 320 | * |
| 321 | * "(CF)" items are handled during code-flow analysis. |
| 322 | * |
| 323 | * v3 4.10.1 |
| 324 | * - target of each jump and branch instruction must be valid |
| 325 | * - targets of switch statements must be valid |
| 326 | * - operands referencing constant pool entries must be valid |
| 327 | * - (CF) operands of getfield, putfield, getstatic, putstatic must be valid |
| 328 | * - (CF) operands of method invocation instructions must be valid |
| 329 | * - (CF) only invoke-direct can call a method starting with '<' |
| 330 | * - (CF) <clinit> must never be called explicitly |
| 331 | * - operands of instanceof, checkcast, new (and variants) must be valid |
| 332 | * - new-array[-type] limited to 255 dimensions |
| 333 | * - can't use "new" on an array class |
| 334 | * - (?) limit dimensions in multi-array creation |
| 335 | * - local variable load/store register values must be in valid range |
| 336 | * |
| 337 | * v3 4.11.1.2 |
| 338 | * - branches must be within the bounds of the code array |
| 339 | * - targets of all control-flow instructions are the start of an instruction |
| 340 | * - register accesses fall within range of allocated registers |
| 341 | * - (N/A) access to constant pool must be of appropriate type |
| 342 | * - code does not end in the middle of an instruction |
| 343 | * - execution cannot fall off the end of the code |
| 344 | * - (earlier) for each exception handler, the "try" area must begin and |
| 345 | * end at the start of an instruction (end can be at the end of the code) |
| 346 | * - (earlier) for each exception handler, the handler must start at a valid |
| 347 | * instruction |
| 348 | */ |
| 349 | bool VerifyInstruction(const Instruction* inst, uint32_t code_offset); |
| 350 | |
| 351 | /* Ensure that the register index is valid for this code item. */ |
| 352 | bool CheckRegisterIndex(uint32_t idx); |
| 353 | |
| 354 | /* Ensure that the wide register index is valid for this code item. */ |
| 355 | bool CheckWideRegisterIndex(uint32_t idx); |
| 356 | |
| 357 | // Perform static checks on a field get or set instruction. All we do here is ensure that the |
| 358 | // field index is in the valid range. |
| 359 | bool CheckFieldIndex(uint32_t idx); |
| 360 | |
| 361 | // Perform static checks on a method invocation instruction. All we do here is ensure that the |
| 362 | // method index is in the valid range. |
| 363 | bool CheckMethodIndex(uint32_t idx); |
| 364 | |
| 365 | // Perform static checks on a "new-instance" instruction. Specifically, make sure the class |
| 366 | // reference isn't for an array class. |
| 367 | bool CheckNewInstance(uint32_t idx); |
| 368 | |
| 369 | /* Ensure that the string index is in the valid range. */ |
| 370 | bool CheckStringIndex(uint32_t idx); |
| 371 | |
| 372 | // Perform static checks on an instruction that takes a class constant. Ensure that the class |
| 373 | // index is in the valid range. |
| 374 | bool CheckTypeIndex(uint32_t idx); |
| 375 | |
| 376 | // Perform static checks on a "new-array" instruction. Specifically, make sure they aren't |
| 377 | // creating an array of arrays that causes the number of dimensions to exceed 255. |
| 378 | bool CheckNewArray(uint32_t idx); |
| 379 | |
| 380 | // Verify an array data table. "cur_offset" is the offset of the fill-array-data instruction. |
| 381 | bool CheckArrayData(uint32_t cur_offset); |
| 382 | |
| 383 | // Verify that the target of a branch instruction is valid. We don't expect code to jump directly |
| 384 | // into an exception handler, but it's valid to do so as long as the target isn't a |
| 385 | // "move-exception" instruction. We verify that in a later stage. |
| 386 | // The dex format forbids certain instructions from branching to themselves. |
Elliott Hughes | 24edeb5 | 2012-06-18 15:29:46 -0700 | [diff] [blame] | 387 | // Updates "insn_flags_", setting the "branch target" flag. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 388 | bool CheckBranchTarget(uint32_t cur_offset); |
| 389 | |
| 390 | // Verify a switch table. "cur_offset" is the offset of the switch instruction. |
Elliott Hughes | 24edeb5 | 2012-06-18 15:29:46 -0700 | [diff] [blame] | 391 | // Updates "insn_flags_", setting the "branch target" flag. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 392 | bool CheckSwitchTargets(uint32_t cur_offset); |
| 393 | |
| 394 | // Check the register indices used in a "vararg" instruction, such as invoke-virtual or |
| 395 | // filled-new-array. |
| 396 | // - vA holds word count (0-5), args[] have values. |
| 397 | // There are some tests we don't do here, e.g. we don't try to verify that invoking a method that |
| 398 | // takes a double is done with consecutive registers. This requires parsing the target method |
| 399 | // signature, which we will be doing later on during the code flow analysis. |
| 400 | bool CheckVarArgRegs(uint32_t vA, uint32_t arg[]); |
| 401 | |
| 402 | // Check the register indices used in a "vararg/range" instruction, such as invoke-virtual/range |
| 403 | // or filled-new-array/range. |
| 404 | // - vA holds word count, vC holds index of first reg. |
| 405 | bool CheckVarArgRangeRegs(uint32_t vA, uint32_t vC); |
| 406 | |
| 407 | // Extract the relative offset from a branch instruction. |
| 408 | // Returns "false" on failure (e.g. this isn't a branch instruction). |
| 409 | bool GetBranchOffset(uint32_t cur_offset, int32_t* pOffset, bool* pConditional, |
| 410 | bool* selfOkay); |
| 411 | |
| 412 | /* Perform detailed code-flow analysis on a single method. */ |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 413 | bool VerifyCodeFlow() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 414 | |
| 415 | // Set the register types for the first instruction in the method based on the method signature. |
| 416 | // This has the side-effect of validating the signature. |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 417 | bool SetTypesFromSignature() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 418 | |
| 419 | /* |
| 420 | * Perform code flow on a method. |
| 421 | * |
| 422 | * The basic strategy is as outlined in v3 4.11.1.2: set the "changed" bit on the first |
| 423 | * instruction, process it (setting additional "changed" bits), and repeat until there are no |
| 424 | * more. |
| 425 | * |
| 426 | * v3 4.11.1.1 |
| 427 | * - (N/A) operand stack is always the same size |
| 428 | * - operand stack [registers] contain the correct types of values |
| 429 | * - local variables [registers] contain the correct types of values |
| 430 | * - methods are invoked with the appropriate arguments |
| 431 | * - fields are assigned using values of appropriate types |
| 432 | * - opcodes have the correct type values in operand registers |
| 433 | * - there is never an uninitialized class instance in a local variable in code protected by an |
| 434 | * exception handler (operand stack is okay, because the operand stack is discarded when an |
| 435 | * exception is thrown) [can't know what's a local var w/o the debug info -- should fall out of |
| 436 | * register typing] |
| 437 | * |
| 438 | * v3 4.11.1.2 |
| 439 | * - execution cannot fall off the end of the code |
| 440 | * |
| 441 | * (We also do many of the items described in the "static checks" sections, because it's easier to |
| 442 | * do them here.) |
| 443 | * |
| 444 | * We need an array of RegType values, one per register, for every instruction. If the method uses |
| 445 | * monitor-enter, we need extra data for every register, and a stack for every "interesting" |
| 446 | * instruction. In theory this could become quite large -- up to several megabytes for a monster |
| 447 | * function. |
| 448 | * |
| 449 | * NOTE: |
| 450 | * The spec forbids backward branches when there's an uninitialized reference in a register. The |
| 451 | * idea is to prevent something like this: |
| 452 | * loop: |
| 453 | * move r1, r0 |
| 454 | * new-instance r0, MyClass |
| 455 | * ... |
| 456 | * if-eq rN, loop // once |
| 457 | * initialize r0 |
| 458 | * |
| 459 | * This leaves us with two different instances, both allocated by the same instruction, but only |
| 460 | * one is initialized. The scheme outlined in v3 4.11.1.4 wouldn't catch this, so they work around |
| 461 | * it by preventing backward branches. We achieve identical results without restricting code |
| 462 | * reordering by specifying that you can't execute the new-instance instruction if a register |
| 463 | * contains an uninitialized instance created by that same instruction. |
| 464 | */ |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 465 | bool CodeFlowVerifyMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 466 | |
| 467 | /* |
| 468 | * Perform verification for a single instruction. |
| 469 | * |
| 470 | * This requires fully decoding the instruction to determine the effect it has on registers. |
| 471 | * |
| 472 | * Finds zero or more following instructions and sets the "changed" flag if execution at that |
| 473 | * point needs to be (re-)evaluated. Register changes are merged into "reg_types_" at the target |
| 474 | * addresses. Does not set or clear any other flags in "insn_flags_". |
| 475 | */ |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 476 | bool CodeFlowVerifyInstruction(uint32_t* start_guess) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 477 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 478 | |
| 479 | // Perform verification of a new array instruction |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 480 | void VerifyNewArray(const Instruction* inst, bool is_filled, bool is_range) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 481 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 482 | |
| 483 | // Perform verification of an aget instruction. The destination register's type will be set to |
| 484 | // be that of component type of the array unless the array type is unknown, in which case a |
| 485 | // bottom type inferred from the type of instruction is used. is_primitive is false for an |
| 486 | // aget-object. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 487 | void VerifyAGet(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 488 | bool is_primitive) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 489 | |
| 490 | // Perform verification of an aput instruction. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 491 | void VerifyAPut(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 492 | bool is_primitive) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 493 | |
| 494 | // Lookup instance field and fail for resolution violations |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 495 | mirror::Field* GetInstanceField(const RegType& obj_type, int field_idx) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 496 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 497 | |
| 498 | // Lookup static field and fail for resolution violations |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 499 | mirror::Field* GetStaticField(int field_idx) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 500 | |
| 501 | // Perform verification of an iget or sget instruction. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 502 | void VerifyISGet(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 503 | bool is_primitive, bool is_static) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 504 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 505 | |
| 506 | // Perform verification of an iput or sput instruction. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 507 | void VerifyISPut(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 508 | bool is_primitive, bool is_static) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 509 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 510 | |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 511 | // Returns the access field of a quick field access (iget/iput-quick) or NULL |
| 512 | // if it cannot be found. |
| 513 | mirror::Field* GetQuickFieldAccess(const Instruction* inst, RegisterLine* reg_line) |
| 514 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 515 | |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 516 | // Perform verification of an iget-quick instruction. |
| 517 | void VerifyIGetQuick(const Instruction* inst, const RegType& insn_type, |
| 518 | bool is_primitive) |
| 519 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 520 | |
| 521 | // Perform verification of an iput-quick instruction. |
| 522 | void VerifyIPutQuick(const Instruction* inst, const RegType& insn_type, |
| 523 | bool is_primitive) |
| 524 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 525 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 526 | // Resolves a class based on an index and performs access checks to ensure the referrer can |
| 527 | // access the resolved class. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 528 | const RegType& ResolveClassAndCheckAccess(uint32_t class_idx) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 529 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 530 | |
| 531 | /* |
| 532 | * For the "move-exception" instruction at "work_insn_idx_", which must be at an exception handler |
| 533 | * address, determine the Join of all exceptions that can land here. Fails if no matching |
| 534 | * exception handler can be found or if the Join of exception types fails. |
| 535 | */ |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 536 | const RegType& GetCaughtExceptionType() |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 537 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 538 | |
| 539 | /* |
| 540 | * Resolves a method based on an index and performs access checks to ensure |
| 541 | * the referrer can access the resolved method. |
| 542 | * Does not throw exceptions. |
| 543 | */ |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 544 | mirror::AbstractMethod* ResolveMethodAndCheckAccess(uint32_t method_idx, MethodType method_type) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 545 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 546 | |
| 547 | /* |
| 548 | * Verify the arguments to a method. We're executing in "method", making |
| 549 | * a call to the method reference in vB. |
| 550 | * |
| 551 | * If this is a "direct" invoke, we allow calls to <init>. For calls to |
| 552 | * <init>, the first argument may be an uninitialized reference. Otherwise, |
| 553 | * calls to anything starting with '<' will be rejected, as will any |
| 554 | * uninitialized reference arguments. |
| 555 | * |
| 556 | * For non-static method calls, this will verify that the method call is |
| 557 | * appropriate for the "this" argument. |
| 558 | * |
| 559 | * The method reference is in vBBBB. The "is_range" parameter determines |
| 560 | * whether we use 0-4 "args" values or a range of registers defined by |
| 561 | * vAA and vCCCC. |
| 562 | * |
| 563 | * Widening conversions on integers and references are allowed, but |
| 564 | * narrowing conversions are not. |
| 565 | * |
| 566 | * Returns the resolved method on success, NULL on failure (with *failure |
| 567 | * set appropriately). |
| 568 | */ |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 569 | mirror::AbstractMethod* VerifyInvocationArgs(const Instruction* inst, |
| 570 | MethodType method_type, |
| 571 | bool is_range, bool is_super) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 572 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 573 | |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 574 | mirror::AbstractMethod* GetQuickInvokedMethod(const Instruction* inst, |
| 575 | RegisterLine* reg_line, |
| 576 | bool is_range) |
| 577 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 578 | |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 579 | mirror::AbstractMethod* VerifyInvokeVirtualQuickArgs(const Instruction* inst, |
| 580 | bool is_range) |
| 581 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 582 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 583 | /* |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 584 | * Verify that the target instruction is not "move-exception". It's important that the only way |
| 585 | * to execute a move-exception is as the first instruction of an exception handler. |
| 586 | * Returns "true" if all is well, "false" if the target instruction is move-exception. |
| 587 | */ |
| 588 | bool CheckNotMoveException(const uint16_t* insns, int insn_idx); |
| 589 | |
| 590 | /* |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 591 | * Control can transfer to "next_insn". Merge the registers from merge_line into the table at |
| 592 | * next_insn, and set the changed flag on the target address if any of the registers were changed. |
| 593 | * Returns "false" if an error is encountered. |
| 594 | */ |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 595 | bool UpdateRegisters(uint32_t next_insn, const RegisterLine* merge_line) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 596 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 597 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 598 | // Is the method being verified a constructor? |
| 599 | bool IsConstructor() const { |
| 600 | return (method_access_flags_ & kAccConstructor) != 0; |
| 601 | } |
| 602 | |
| 603 | // Is the method verified static? |
| 604 | bool IsStatic() const { |
| 605 | return (method_access_flags_ & kAccStatic) != 0; |
| 606 | } |
| 607 | |
| 608 | // Return the register type for the method. |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 609 | const RegType& GetMethodReturnType() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 610 | |
| 611 | // Get a type representing the declaring class of the method. |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 612 | const RegType& GetDeclaringClass() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 613 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 614 | /* |
| 615 | * Generate the GC map for a method that has just been verified (i.e. we're doing this as part of |
| 616 | * verification). For type-precise determination we have all the data we need, so we just need to |
| 617 | * encode it in some clever fashion. |
| 618 | * Returns a pointer to a newly-allocated RegisterMap, or NULL on failure. |
| 619 | */ |
| 620 | const std::vector<uint8_t>* GenerateGcMap(); |
| 621 | |
| 622 | // Verify that the GC map associated with method_ is well formed |
| 623 | void VerifyGcMap(const std::vector<uint8_t>& data); |
| 624 | |
| 625 | // Compute sizes for GC map data |
| 626 | void ComputeGcMapSizes(size_t* gc_points, size_t* ref_bitmap_bits, size_t* log2_max_gc_pc); |
| 627 | |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 628 | InstructionFlags* CurrentInsnFlags(); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 629 | |
| 630 | // All the GC maps that the verifier has created |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 631 | typedef SafeMap<const MethodReference, const std::vector<uint8_t>*, |
| 632 | MethodReferenceComparator> DexGcMapTable; |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 633 | static ReaderWriterMutex* dex_gc_maps_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; |
Ian Rogers | 0c7abda | 2012-09-19 13:33:42 -0700 | [diff] [blame] | 634 | static DexGcMapTable* dex_gc_maps_ GUARDED_BY(dex_gc_maps_lock_); |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 635 | static void SetDexGcMap(MethodReference ref, const std::vector<uint8_t>& dex_gc_map) |
Ian Rogers | 0c7abda | 2012-09-19 13:33:42 -0700 | [diff] [blame] | 636 | LOCKS_EXCLUDED(dex_gc_maps_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 637 | |
Sameer Abu Asal | 02c4223 | 2013-04-30 12:09:45 -0700 | [diff] [blame] | 638 | |
Dragos Sbirlea | 980d16b | 2013-06-04 15:01:40 -0700 | [diff] [blame] | 639 | // Cast elision types. |
| 640 | typedef std::set<uint32_t> MethodSafeCastSet; |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 641 | typedef SafeMap<const MethodReference, const MethodSafeCastSet*, |
| 642 | MethodReferenceComparator> SafeCastMap; |
Dragos Sbirlea | 980d16b | 2013-06-04 15:01:40 -0700 | [diff] [blame] | 643 | MethodVerifier::MethodSafeCastSet* GenerateSafeCastSet() |
| 644 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 645 | static void SetSafeCastMap(MethodReference ref, const MethodSafeCastSet* mscs); |
Dragos Sbirlea | 980d16b | 2013-06-04 15:01:40 -0700 | [diff] [blame] | 646 | LOCKS_EXCLUDED(safecast_map_lock_); |
Sebastien Hertz | d678802 | 2013-08-05 17:47:40 +0200 | [diff] [blame] | 647 | static ReaderWriterMutex* safecast_map_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; |
Dragos Sbirlea | 980d16b | 2013-06-04 15:01:40 -0700 | [diff] [blame] | 648 | static SafeCastMap* safecast_map_ GUARDED_BY(safecast_map_lock_); |
| 649 | |
Sameer Abu Asal | 02c4223 | 2013-04-30 12:09:45 -0700 | [diff] [blame] | 650 | // Devirtualization map. |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 651 | typedef SafeMap<const uint32_t, MethodReference> PcToConcreteMethodMap; |
| 652 | typedef SafeMap<const MethodReference, const PcToConcreteMethodMap*, |
| 653 | MethodReferenceComparator> DevirtualizationMapTable; |
Ian Rogers | d058380 | 2013-06-01 10:51:46 -0700 | [diff] [blame] | 654 | MethodVerifier::PcToConcreteMethodMap* GenerateDevirtMap() |
Ian Rogers | 33e9566 | 2013-05-20 20:29:14 -0700 | [diff] [blame] | 655 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sameer Abu Asal | 02c4223 | 2013-04-30 12:09:45 -0700 | [diff] [blame] | 656 | |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 657 | static ReaderWriterMutex* devirt_maps_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; |
Sameer Abu Asal | 02c4223 | 2013-04-30 12:09:45 -0700 | [diff] [blame] | 658 | static DevirtualizationMapTable* devirt_maps_ GUARDED_BY(devirt_maps_lock_); |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 659 | static void SetDevirtMap(MethodReference ref, |
Ian Rogers | d058380 | 2013-06-01 10:51:46 -0700 | [diff] [blame] | 660 | const PcToConcreteMethodMap* pc_method_map) |
Sameer Abu Asal | 02c4223 | 2013-04-30 12:09:45 -0700 | [diff] [blame] | 661 | LOCKS_EXCLUDED(devirt_maps_lock_); |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 662 | typedef std::set<ClassReference> RejectedClassesTable; |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 663 | static Mutex* rejected_classes_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; |
Sebastien Hertz | 4d4adb1 | 2013-07-24 16:14:19 +0200 | [diff] [blame] | 664 | static RejectedClassesTable* rejected_classes_ GUARDED_BY(rejected_classes_lock_); |
Elliott Hughes | 0a1038b | 2012-06-14 16:24:17 -0700 | [diff] [blame] | 665 | |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 666 | static void AddRejectedClass(ClassReference ref) |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 667 | LOCKS_EXCLUDED(rejected_classes_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 668 | |
| 669 | RegTypeCache reg_types_; |
| 670 | |
| 671 | PcToRegisterLineTable reg_table_; |
| 672 | |
| 673 | // Storage for the register status we're currently working on. |
| 674 | UniquePtr<RegisterLine> work_line_; |
| 675 | |
| 676 | // The address of the instruction we're currently working on, note that this is in 2 byte |
| 677 | // quantities |
| 678 | uint32_t work_insn_idx_; |
| 679 | |
| 680 | // Storage for the register status we're saving for later. |
| 681 | UniquePtr<RegisterLine> saved_line_; |
| 682 | |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 683 | const uint32_t dex_method_idx_; // The method we're working on. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 684 | // Its object representation if known. |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 685 | mirror::AbstractMethod* mirror_method_ GUARDED_BY(Locks::mutator_lock_); |
| 686 | const uint32_t method_access_flags_; // Method's access flags. |
| 687 | const DexFile* const dex_file_; // The dex file containing the method. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 688 | // The dex_cache for the declaring class of the method. |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 689 | mirror::DexCache* dex_cache_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 690 | // The class loader for the declaring class of the method. |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 691 | mirror::ClassLoader* class_loader_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 692 | const uint32_t class_def_idx_; // The class def index of the declaring class of the method. |
| 693 | const DexFile::CodeItem* const code_item_; // The code item containing the code for the method. |
| 694 | const RegType* declaring_class_; // Lazily computed reg type of the method's declaring class. |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 695 | // Instruction widths and flags, one entry per code unit. |
| 696 | UniquePtr<InstructionFlags[]> insn_flags_; |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 697 | // The dex PC of a FindLocksAtDexPc request, -1 otherwise. |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 698 | uint32_t interesting_dex_pc_; |
| 699 | // The container into which FindLocksAtDexPc should write the registers containing held locks, |
| 700 | // NULL if we're not doing FindLocksAtDexPc. |
| 701 | std::vector<uint32_t>* monitor_enter_dex_pcs_; |
| 702 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 703 | // The types of any error that occurs. |
| 704 | std::vector<VerifyError> failures_; |
| 705 | // Error messages associated with failures. |
| 706 | std::vector<std::ostringstream*> failure_messages_; |
| 707 | // Is there a pending hard failure? |
| 708 | bool have_pending_hard_failure_; |
jeffhao | faf459e | 2012-08-31 15:32:47 -0700 | [diff] [blame] | 709 | // Is there a pending runtime throw failure? A runtime throw failure is when an instruction |
| 710 | // would fail at runtime throwing an exception. Such an instruction causes the following code |
| 711 | // to be unreachable. This is set by Fail and used to ensure we don't process unreachable |
| 712 | // instructions that would hard fail the verification. |
| 713 | bool have_pending_runtime_throw_failure_; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 714 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 715 | // Info message log use primarily for verifier diagnostics. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 716 | std::ostringstream info_messages_; |
| 717 | |
| 718 | // The number of occurrences of specific opcodes. |
| 719 | size_t new_instance_count_; |
| 720 | size_t monitor_enter_count_; |
Elliott Hughes | 80537bb | 2013-01-04 16:37:26 -0800 | [diff] [blame] | 721 | |
| 722 | const bool can_load_classes_; |
Jeff Hao | ee98895 | 2013-04-16 14:23:47 -0700 | [diff] [blame] | 723 | |
| 724 | // Converts soft failures to hard failures when false. Only false when the compiler isn't |
| 725 | // running and the verifier is called from the class linker. |
| 726 | const bool allow_soft_failures_; |
Sebastien Hertz | 4d4adb1 | 2013-07-24 16:14:19 +0200 | [diff] [blame] | 727 | |
| 728 | // Indicates if the method being verified contains at least one check-cast instruction. |
| 729 | bool has_check_casts_; |
| 730 | |
| 731 | // Indicates if the method being verified contains at least one invoke-virtual/range |
| 732 | // or invoke-interface/range. |
| 733 | bool has_virtual_or_interface_invokes_; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 734 | }; |
jeffhao | e4f0b2a | 2012-08-30 11:18:57 -0700 | [diff] [blame] | 735 | std::ostream& operator<<(std::ostream& os, const MethodVerifier::FailureKind& rhs); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 736 | |
| 737 | } // namespace verifier |
| 738 | } // namespace art |
| 739 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 740 | #endif // ART_RUNTIME_VERIFIER_METHOD_VERIFIER_H_ |