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 | 700a402 | 2014-05-19 16:49:03 -0700 | [diff] [blame] | 20 | #include <memory> |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 21 | #include <set> |
| 22 | #include <vector> |
| 23 | |
Elliott Hughes | 1aa246d | 2012-12-13 09:29:36 -0800 | [diff] [blame] | 24 | #include "base/casts.h" |
Elliott Hughes | 7616005 | 2012-12-12 16:31:20 -0800 | [diff] [blame] | 25 | #include "base/macros.h" |
Elliott Hughes | 1aa246d | 2012-12-13 09:29:36 -0800 | [diff] [blame] | 26 | #include "base/stl_util.h" |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 27 | #include "class_reference.h" |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 28 | #include "dex_file.h" |
| 29 | #include "dex_instruction.h" |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 30 | #include "instruction_flags.h" |
Brian Carlstrom | 51c2467 | 2013-07-11 16:00:56 -0700 | [diff] [blame] | 31 | #include "method_reference.h" |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 32 | #include "reg_type.h" |
Ian Rogers | 576ca0c | 2014-06-06 15:58:22 -0700 | [diff] [blame^] | 33 | #include "reg_type_cache.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 | |
| 37 | namespace art { |
| 38 | |
| 39 | struct ReferenceMap2Visitor; |
Mathieu Chartier | eb8167a | 2014-05-07 15:43:14 -0700 | [diff] [blame] | 40 | template<class T> class Handle; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 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: |
Ian Rogers | d0fbd85 | 2013-09-24 18:17:04 -0700 | [diff] [blame] | 113 | PcToRegisterLineTable() : size_(0) {} |
| 114 | ~PcToRegisterLineTable(); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 115 | |
| 116 | // Initialize the RegisterTable. Every instruction address can have a different set of information |
| 117 | // about what's in which register, but for verification purposes we only need to store it at |
| 118 | // branch target addresses (because we merge into that). |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 119 | void Init(RegisterTrackingMode mode, InstructionFlags* flags, uint32_t insns_size, |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 120 | uint16_t registers_size, MethodVerifier* verifier); |
| 121 | |
| 122 | RegisterLine* GetLine(size_t idx) { |
Ian Rogers | d0fbd85 | 2013-09-24 18:17:04 -0700 | [diff] [blame] | 123 | DCHECK_LT(idx, size_); |
| 124 | return register_lines_[idx]; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | private: |
Ian Rogers | 700a402 | 2014-05-19 16:49:03 -0700 | [diff] [blame] | 128 | std::unique_ptr<RegisterLine*[]> register_lines_; |
Ian Rogers | d0fbd85 | 2013-09-24 18:17:04 -0700 | [diff] [blame] | 129 | size_t size_; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 130 | }; |
| 131 | |
| 132 | // The verifier |
| 133 | class MethodVerifier { |
| 134 | public: |
jeffhao | f1e6b7c | 2012-06-05 18:33:30 -0700 | [diff] [blame] | 135 | enum FailureKind { |
| 136 | kNoFailure, |
| 137 | kSoftFailure, |
| 138 | kHardFailure, |
| 139 | }; |
| 140 | |
| 141 | /* Verify a class. Returns "kNoFailure" on success. */ |
Ian Rogers | ef7d42f | 2014-01-06 12:55:46 -0800 | [diff] [blame] | 142 | static FailureKind VerifyClass(mirror::Class* klass, bool allow_soft_failures, std::string* error) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 143 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Mathieu Chartier | 0cd8135 | 2014-05-22 16:48:55 -0700 | [diff] [blame] | 144 | static FailureKind VerifyClass(const DexFile* dex_file, Handle<mirror::DexCache> dex_cache, |
| 145 | Handle<mirror::ClassLoader> class_loader, |
Ian Rogers | 8b2c0b9 | 2013-09-19 02:56:49 -0700 | [diff] [blame] | 146 | const DexFile::ClassDef* class_def, |
| 147 | bool allow_soft_failures, std::string* error) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 148 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 149 | |
Ian Rogers | 2bcb4a4 | 2012-11-08 10:39:18 -0800 | [diff] [blame] | 150 | static void VerifyMethodAndDump(std::ostream& os, uint32_t method_idx, const DexFile* dex_file, |
Mathieu Chartier | 0cd8135 | 2014-05-22 16:48:55 -0700 | [diff] [blame] | 151 | Handle<mirror::DexCache> dex_cache, |
| 152 | Handle<mirror::ClassLoader> class_loader, |
Ian Rogers | 8b2c0b9 | 2013-09-19 02:56:49 -0700 | [diff] [blame] | 153 | const DexFile::ClassDef* class_def, |
| 154 | const DexFile::CodeItem* code_item, |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 155 | mirror::ArtMethod* method, uint32_t method_access_flags) |
Ian Rogers | 2bcb4a4 | 2012-11-08 10:39:18 -0800 | [diff] [blame] | 156 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 157 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 158 | uint8_t EncodePcToReferenceMapData() const; |
| 159 | |
| 160 | uint32_t DexFileVersion() const { |
| 161 | return dex_file_->GetVersion(); |
| 162 | } |
| 163 | |
| 164 | RegTypeCache* GetRegTypeCache() { |
| 165 | return ®_types_; |
| 166 | } |
| 167 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 168 | // Log a verification failure. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 169 | std::ostream& Fail(VerifyError error); |
| 170 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 171 | // Log for verification information. |
Ian Rogers | 576ca0c | 2014-06-06 15:58:22 -0700 | [diff] [blame^] | 172 | std::ostream& LogVerifyInfo(); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 173 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 174 | // Dump the failures encountered by the verifier. |
| 175 | std::ostream& DumpFailures(std::ostream& os); |
| 176 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 177 | // Dump the state of the verifier, namely each instruction, what flags are set on it, register |
| 178 | // information |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 179 | void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 180 | |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 181 | // 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] | 182 | // to the locks held at 'dex_pc' in method 'm'. |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 183 | static void FindLocksAtDexPc(mirror::ArtMethod* m, uint32_t dex_pc, |
Ian Rogers | 46960fe | 2014-05-23 10:43:43 -0700 | [diff] [blame] | 184 | std::vector<uint32_t>* monitor_enter_dex_pcs) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 185 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 186 | |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 187 | // Returns the accessed field corresponding to the quick instruction's field |
| 188 | // offset at 'dex_pc' in method 'm'. |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 189 | static mirror::ArtField* FindAccessedFieldAtDexPc(mirror::ArtMethod* m, uint32_t dex_pc) |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 190 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 191 | |
| 192 | // Returns the invoked method corresponding to the quick instruction's vtable |
| 193 | // index at 'dex_pc' in method 'm'. |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 194 | static mirror::ArtMethod* FindInvokedMethodAtDexPc(mirror::ArtMethod* m, uint32_t dex_pc) |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 195 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 196 | |
Sameer Abu Asal | 51a5fb7 | 2013-02-19 14:25:01 -0800 | [diff] [blame] | 197 | static void Init() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 0a1038b | 2012-06-14 16:24:17 -0700 | [diff] [blame] | 198 | static void Shutdown(); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 199 | |
Elliott Hughes | 4993bbc | 2013-01-10 15:41:25 -0800 | [diff] [blame] | 200 | bool CanLoadClasses() const { |
| 201 | return can_load_classes_; |
| 202 | } |
| 203 | |
Mathieu Chartier | eb8167a | 2014-05-07 15:43:14 -0700 | [diff] [blame] | 204 | MethodVerifier(const DexFile* dex_file, Handle<mirror::DexCache>* dex_cache, |
| 205 | Handle<mirror::ClassLoader>* class_loader, const DexFile::ClassDef* class_def, |
Mathieu Chartier | 590fee9 | 2013-09-13 13:46:47 -0700 | [diff] [blame] | 206 | const DexFile::CodeItem* code_item, uint32_t method_idx, mirror::ArtMethod* method, |
Ian Rogers | 46960fe | 2014-05-23 10:43:43 -0700 | [diff] [blame] | 207 | uint32_t access_flags, bool can_load_classes, bool allow_soft_failures, |
| 208 | bool need_precise_constants) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 209 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 210 | |
Mathieu Chartier | 590fee9 | 2013-09-13 13:46:47 -0700 | [diff] [blame] | 211 | ~MethodVerifier(); |
Sebastien Hertz | 33691ab | 2013-08-02 14:19:57 +0200 | [diff] [blame] | 212 | |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 213 | // Run verification on the method. Returns true if verification completes and false if the input |
| 214 | // has an irrecoverable corruption. |
| 215 | bool Verify() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 216 | |
| 217 | // Describe VRegs at the given dex pc. |
| 218 | std::vector<int32_t> DescribeVRegs(uint32_t dex_pc); |
| 219 | |
Mathieu Chartier | 83c8ee0 | 2014-01-28 14:50:23 -0800 | [diff] [blame] | 220 | void VisitRoots(RootCallback* callback, void* arg) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Mathieu Chartier | c528dba | 2013-11-26 12:00:11 -0800 | [diff] [blame] | 221 | |
Vladimir Marko | 2b5eaa2 | 2013-12-13 13:59:30 +0000 | [diff] [blame] | 222 | // Accessors used by the compiler via CompilerCallback |
| 223 | const DexFile::CodeItem* CodeItem() const; |
| 224 | RegisterLine* GetRegLine(uint32_t dex_pc); |
| 225 | const InstructionFlags& GetInstructionFlags(size_t index) const; |
| 226 | mirror::ClassLoader* GetClassLoader() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 227 | mirror::DexCache* GetDexCache() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 228 | MethodReference GetMethodReference() const; |
| 229 | uint32_t GetAccessFlags() const; |
| 230 | bool HasCheckCasts() const; |
| 231 | bool HasVirtualOrInterfaceInvokes() const; |
| 232 | bool HasFailures() const; |
| 233 | const RegType& ResolveCheckedClass(uint32_t class_idx) |
| 234 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 235 | |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 236 | private: |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 237 | // Adds the given string to the beginning of the last failure message. |
| 238 | void PrependToLastFailMessage(std::string); |
| 239 | |
| 240 | // Adds the given string to the end of the last failure message. |
| 241 | void AppendToLastFailMessage(std::string); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 242 | |
| 243 | /* |
| 244 | * Perform verification on a single method. |
| 245 | * |
| 246 | * We do this in three passes: |
| 247 | * (1) Walk through all code units, determining instruction locations, |
| 248 | * widths, and other characteristics. |
| 249 | * (2) Walk through all code units, performing static checks on |
| 250 | * operands. |
| 251 | * (3) Iterate through the method, checking type safety and looking |
| 252 | * for code flow problems. |
Ian Rogers | e1758fe | 2012-04-19 11:31:15 -0700 | [diff] [blame] | 253 | */ |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 254 | static FailureKind VerifyMethod(uint32_t method_idx, const DexFile* dex_file, |
Mathieu Chartier | 0cd8135 | 2014-05-22 16:48:55 -0700 | [diff] [blame] | 255 | Handle<mirror::DexCache> dex_cache, |
| 256 | Handle<mirror::ClassLoader> class_loader, |
Ian Rogers | 8b2c0b9 | 2013-09-19 02:56:49 -0700 | [diff] [blame] | 257 | const DexFile::ClassDef* class_def_idx, |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 258 | const DexFile::CodeItem* code_item, |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 259 | mirror::ArtMethod* method, uint32_t method_access_flags, |
Ian Rogers | 46960fe | 2014-05-23 10:43:43 -0700 | [diff] [blame] | 260 | bool allow_soft_failures, bool need_precise_constants) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 261 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | e1758fe | 2012-04-19 11:31:15 -0700 | [diff] [blame] | 262 | |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 263 | void FindLocksAtDexPc() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 264 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 265 | mirror::ArtField* FindAccessedFieldAtDexPc(uint32_t dex_pc) |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 266 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 267 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 268 | mirror::ArtMethod* FindInvokedMethodAtDexPc(uint32_t dex_pc) |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 269 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 270 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 271 | /* |
| 272 | * Compute the width of the instruction at each address in the instruction stream, and store it in |
| 273 | * insn_flags_. Addresses that are in the middle of an instruction, or that are part of switch |
| 274 | * table data, are not touched (so the caller should probably initialize "insn_flags" to zero). |
| 275 | * |
| 276 | * The "new_instance_count_" and "monitor_enter_count_" fields in vdata are also set. |
| 277 | * |
| 278 | * Performs some static checks, notably: |
| 279 | * - opcode of first instruction begins at index 0 |
| 280 | * - only documented instructions may appear |
| 281 | * - each instruction follows the last |
| 282 | * - last byte of last instruction is at (code_length-1) |
| 283 | * |
| 284 | * Logs an error and returns "false" on failure. |
| 285 | */ |
| 286 | bool ComputeWidthsAndCountOps(); |
| 287 | |
| 288 | /* |
| 289 | * Set the "in try" flags for all instructions protected by "try" statements. Also sets the |
| 290 | * "branch target" flags for exception handlers. |
| 291 | * |
| 292 | * Call this after widths have been set in "insn_flags". |
| 293 | * |
| 294 | * Returns "false" if something in the exception table looks fishy, but we're expecting the |
| 295 | * exception table to be somewhat sane. |
| 296 | */ |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 297 | bool ScanTryCatchBlocks() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 298 | |
| 299 | /* |
| 300 | * Perform static verification on all instructions in a method. |
| 301 | * |
| 302 | * Walks through instructions in a method calling VerifyInstruction on each. |
| 303 | */ |
| 304 | bool VerifyInstructions(); |
| 305 | |
| 306 | /* |
| 307 | * Perform static verification on an instruction. |
| 308 | * |
| 309 | * As a side effect, this sets the "branch target" flags in InsnFlags. |
| 310 | * |
| 311 | * "(CF)" items are handled during code-flow analysis. |
| 312 | * |
| 313 | * v3 4.10.1 |
| 314 | * - target of each jump and branch instruction must be valid |
| 315 | * - targets of switch statements must be valid |
| 316 | * - operands referencing constant pool entries must be valid |
| 317 | * - (CF) operands of getfield, putfield, getstatic, putstatic must be valid |
| 318 | * - (CF) operands of method invocation instructions must be valid |
| 319 | * - (CF) only invoke-direct can call a method starting with '<' |
| 320 | * - (CF) <clinit> must never be called explicitly |
| 321 | * - operands of instanceof, checkcast, new (and variants) must be valid |
| 322 | * - new-array[-type] limited to 255 dimensions |
| 323 | * - can't use "new" on an array class |
| 324 | * - (?) limit dimensions in multi-array creation |
| 325 | * - local variable load/store register values must be in valid range |
| 326 | * |
| 327 | * v3 4.11.1.2 |
| 328 | * - branches must be within the bounds of the code array |
| 329 | * - targets of all control-flow instructions are the start of an instruction |
| 330 | * - register accesses fall within range of allocated registers |
| 331 | * - (N/A) access to constant pool must be of appropriate type |
| 332 | * - code does not end in the middle of an instruction |
| 333 | * - execution cannot fall off the end of the code |
| 334 | * - (earlier) for each exception handler, the "try" area must begin and |
| 335 | * end at the start of an instruction (end can be at the end of the code) |
| 336 | * - (earlier) for each exception handler, the handler must start at a valid |
| 337 | * instruction |
| 338 | */ |
| 339 | bool VerifyInstruction(const Instruction* inst, uint32_t code_offset); |
| 340 | |
| 341 | /* Ensure that the register index is valid for this code item. */ |
| 342 | bool CheckRegisterIndex(uint32_t idx); |
| 343 | |
| 344 | /* Ensure that the wide register index is valid for this code item. */ |
| 345 | bool CheckWideRegisterIndex(uint32_t idx); |
| 346 | |
Mathieu Chartier | eb8167a | 2014-05-07 15:43:14 -0700 | [diff] [blame] | 347 | // Perform static checks on a field Get or set instruction. All we do here is ensure that the |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 348 | // field index is in the valid range. |
| 349 | bool CheckFieldIndex(uint32_t idx); |
| 350 | |
| 351 | // Perform static checks on a method invocation instruction. All we do here is ensure that the |
| 352 | // method index is in the valid range. |
| 353 | bool CheckMethodIndex(uint32_t idx); |
| 354 | |
| 355 | // Perform static checks on a "new-instance" instruction. Specifically, make sure the class |
| 356 | // reference isn't for an array class. |
| 357 | bool CheckNewInstance(uint32_t idx); |
| 358 | |
| 359 | /* Ensure that the string index is in the valid range. */ |
| 360 | bool CheckStringIndex(uint32_t idx); |
| 361 | |
| 362 | // Perform static checks on an instruction that takes a class constant. Ensure that the class |
| 363 | // index is in the valid range. |
| 364 | bool CheckTypeIndex(uint32_t idx); |
| 365 | |
| 366 | // Perform static checks on a "new-array" instruction. Specifically, make sure they aren't |
| 367 | // creating an array of arrays that causes the number of dimensions to exceed 255. |
| 368 | bool CheckNewArray(uint32_t idx); |
| 369 | |
| 370 | // Verify an array data table. "cur_offset" is the offset of the fill-array-data instruction. |
| 371 | bool CheckArrayData(uint32_t cur_offset); |
| 372 | |
| 373 | // Verify that the target of a branch instruction is valid. We don't expect code to jump directly |
| 374 | // into an exception handler, but it's valid to do so as long as the target isn't a |
| 375 | // "move-exception" instruction. We verify that in a later stage. |
| 376 | // The dex format forbids certain instructions from branching to themselves. |
Elliott Hughes | 24edeb5 | 2012-06-18 15:29:46 -0700 | [diff] [blame] | 377 | // Updates "insn_flags_", setting the "branch target" flag. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 378 | bool CheckBranchTarget(uint32_t cur_offset); |
| 379 | |
| 380 | // 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] | 381 | // Updates "insn_flags_", setting the "branch target" flag. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 382 | bool CheckSwitchTargets(uint32_t cur_offset); |
| 383 | |
| 384 | // Check the register indices used in a "vararg" instruction, such as invoke-virtual or |
| 385 | // filled-new-array. |
| 386 | // - vA holds word count (0-5), args[] have values. |
| 387 | // There are some tests we don't do here, e.g. we don't try to verify that invoking a method that |
| 388 | // takes a double is done with consecutive registers. This requires parsing the target method |
| 389 | // signature, which we will be doing later on during the code flow analysis. |
| 390 | bool CheckVarArgRegs(uint32_t vA, uint32_t arg[]); |
| 391 | |
| 392 | // Check the register indices used in a "vararg/range" instruction, such as invoke-virtual/range |
| 393 | // or filled-new-array/range. |
| 394 | // - vA holds word count, vC holds index of first reg. |
| 395 | bool CheckVarArgRangeRegs(uint32_t vA, uint32_t vC); |
| 396 | |
| 397 | // Extract the relative offset from a branch instruction. |
| 398 | // Returns "false" on failure (e.g. this isn't a branch instruction). |
| 399 | bool GetBranchOffset(uint32_t cur_offset, int32_t* pOffset, bool* pConditional, |
| 400 | bool* selfOkay); |
| 401 | |
| 402 | /* Perform detailed code-flow analysis on a single method. */ |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 403 | bool VerifyCodeFlow() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 404 | |
| 405 | // Set the register types for the first instruction in the method based on the method signature. |
| 406 | // This has the side-effect of validating the signature. |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 407 | bool SetTypesFromSignature() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 408 | |
| 409 | /* |
| 410 | * Perform code flow on a method. |
| 411 | * |
| 412 | * The basic strategy is as outlined in v3 4.11.1.2: set the "changed" bit on the first |
| 413 | * instruction, process it (setting additional "changed" bits), and repeat until there are no |
| 414 | * more. |
| 415 | * |
| 416 | * v3 4.11.1.1 |
| 417 | * - (N/A) operand stack is always the same size |
| 418 | * - operand stack [registers] contain the correct types of values |
| 419 | * - local variables [registers] contain the correct types of values |
| 420 | * - methods are invoked with the appropriate arguments |
| 421 | * - fields are assigned using values of appropriate types |
| 422 | * - opcodes have the correct type values in operand registers |
| 423 | * - there is never an uninitialized class instance in a local variable in code protected by an |
| 424 | * exception handler (operand stack is okay, because the operand stack is discarded when an |
| 425 | * exception is thrown) [can't know what's a local var w/o the debug info -- should fall out of |
| 426 | * register typing] |
| 427 | * |
| 428 | * v3 4.11.1.2 |
| 429 | * - execution cannot fall off the end of the code |
| 430 | * |
| 431 | * (We also do many of the items described in the "static checks" sections, because it's easier to |
| 432 | * do them here.) |
| 433 | * |
| 434 | * We need an array of RegType values, one per register, for every instruction. If the method uses |
| 435 | * monitor-enter, we need extra data for every register, and a stack for every "interesting" |
| 436 | * instruction. In theory this could become quite large -- up to several megabytes for a monster |
| 437 | * function. |
| 438 | * |
| 439 | * NOTE: |
| 440 | * The spec forbids backward branches when there's an uninitialized reference in a register. The |
| 441 | * idea is to prevent something like this: |
| 442 | * loop: |
| 443 | * move r1, r0 |
| 444 | * new-instance r0, MyClass |
| 445 | * ... |
| 446 | * if-eq rN, loop // once |
| 447 | * initialize r0 |
| 448 | * |
| 449 | * This leaves us with two different instances, both allocated by the same instruction, but only |
| 450 | * one is initialized. The scheme outlined in v3 4.11.1.4 wouldn't catch this, so they work around |
| 451 | * it by preventing backward branches. We achieve identical results without restricting code |
| 452 | * reordering by specifying that you can't execute the new-instance instruction if a register |
| 453 | * contains an uninitialized instance created by that same instruction. |
| 454 | */ |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 455 | bool CodeFlowVerifyMethod() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 456 | |
| 457 | /* |
| 458 | * Perform verification for a single instruction. |
| 459 | * |
| 460 | * This requires fully decoding the instruction to determine the effect it has on registers. |
| 461 | * |
| 462 | * Finds zero or more following instructions and sets the "changed" flag if execution at that |
| 463 | * point needs to be (re-)evaluated. Register changes are merged into "reg_types_" at the target |
| 464 | * addresses. Does not set or clear any other flags in "insn_flags_". |
| 465 | */ |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 466 | bool CodeFlowVerifyInstruction(uint32_t* start_guess) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 467 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 468 | |
| 469 | // Perform verification of a new array instruction |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 470 | void VerifyNewArray(const Instruction* inst, bool is_filled, bool is_range) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 471 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 472 | |
Jeff Hao | fe1f7c8 | 2013-08-01 14:50:24 -0700 | [diff] [blame] | 473 | // Helper to perform verification on puts of primitive type. |
| 474 | void VerifyPrimitivePut(const RegType& target_type, const RegType& insn_type, |
| 475 | const uint32_t vregA) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 476 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 477 | // Perform verification of an aget instruction. The destination register's type will be set to |
| 478 | // be that of component type of the array unless the array type is unknown, in which case a |
| 479 | // bottom type inferred from the type of instruction is used. is_primitive is false for an |
| 480 | // aget-object. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 481 | void VerifyAGet(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 482 | bool is_primitive) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 483 | |
| 484 | // Perform verification of an aput instruction. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 485 | void VerifyAPut(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 486 | bool is_primitive) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 487 | |
| 488 | // Lookup instance field and fail for resolution violations |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 489 | mirror::ArtField* GetInstanceField(const RegType& obj_type, int field_idx) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 490 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 491 | |
| 492 | // Lookup static field and fail for resolution violations |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 493 | mirror::ArtField* GetStaticField(int field_idx) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 494 | |
| 495 | // Perform verification of an iget or sget instruction. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 496 | void VerifyISGet(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 497 | bool is_primitive, bool is_static) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 498 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 499 | |
| 500 | // Perform verification of an iput or sput instruction. |
Sebastien Hertz | 5243e91 | 2013-05-21 10:55:07 +0200 | [diff] [blame] | 501 | void VerifyISPut(const Instruction* inst, const RegType& insn_type, |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 502 | bool is_primitive, bool is_static) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 503 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 504 | |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 505 | // Returns the access field of a quick field access (iget/iput-quick) or NULL |
| 506 | // if it cannot be found. |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 507 | mirror::ArtField* GetQuickFieldAccess(const Instruction* inst, RegisterLine* reg_line) |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 508 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 509 | |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 510 | // Perform verification of an iget-quick instruction. |
| 511 | void VerifyIGetQuick(const Instruction* inst, const RegType& insn_type, |
| 512 | bool is_primitive) |
| 513 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 514 | |
| 515 | // Perform verification of an iput-quick instruction. |
| 516 | void VerifyIPutQuick(const Instruction* inst, const RegType& insn_type, |
| 517 | bool is_primitive) |
| 518 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 519 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 520 | // Resolves a class based on an index and performs access checks to ensure the referrer can |
| 521 | // access the resolved class. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 522 | const RegType& ResolveClassAndCheckAccess(uint32_t class_idx) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 523 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 524 | |
| 525 | /* |
| 526 | * For the "move-exception" instruction at "work_insn_idx_", which must be at an exception handler |
| 527 | * address, determine the Join of all exceptions that can land here. Fails if no matching |
| 528 | * exception handler can be found or if the Join of exception types fails. |
| 529 | */ |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 530 | const RegType& GetCaughtExceptionType() |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 531 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 532 | |
| 533 | /* |
| 534 | * Resolves a method based on an index and performs access checks to ensure |
| 535 | * the referrer can access the resolved method. |
| 536 | * Does not throw exceptions. |
| 537 | */ |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 538 | mirror::ArtMethod* ResolveMethodAndCheckAccess(uint32_t method_idx, MethodType method_type) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 539 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 540 | |
| 541 | /* |
| 542 | * Verify the arguments to a method. We're executing in "method", making |
| 543 | * a call to the method reference in vB. |
| 544 | * |
| 545 | * If this is a "direct" invoke, we allow calls to <init>. For calls to |
| 546 | * <init>, the first argument may be an uninitialized reference. Otherwise, |
| 547 | * calls to anything starting with '<' will be rejected, as will any |
| 548 | * uninitialized reference arguments. |
| 549 | * |
| 550 | * For non-static method calls, this will verify that the method call is |
| 551 | * appropriate for the "this" argument. |
| 552 | * |
| 553 | * The method reference is in vBBBB. The "is_range" parameter determines |
| 554 | * whether we use 0-4 "args" values or a range of registers defined by |
| 555 | * vAA and vCCCC. |
| 556 | * |
| 557 | * Widening conversions on integers and references are allowed, but |
| 558 | * narrowing conversions are not. |
| 559 | * |
| 560 | * Returns the resolved method on success, NULL on failure (with *failure |
| 561 | * set appropriately). |
| 562 | */ |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 563 | mirror::ArtMethod* VerifyInvocationArgs(const Instruction* inst, |
| 564 | MethodType method_type, |
| 565 | bool is_range, bool is_super) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 566 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 567 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 568 | mirror::ArtMethod* GetQuickInvokedMethod(const Instruction* inst, |
| 569 | RegisterLine* reg_line, |
| 570 | bool is_range) |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 571 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 572 | |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 573 | mirror::ArtMethod* VerifyInvokeVirtualQuickArgs(const Instruction* inst, bool is_range) |
Sebastien Hertz | 2d6ba51 | 2013-05-17 11:31:37 +0200 | [diff] [blame] | 574 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
| 575 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 576 | /* |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 577 | * Verify that the target instruction is not "move-exception". It's important that the only way |
| 578 | * to execute a move-exception is as the first instruction of an exception handler. |
| 579 | * Returns "true" if all is well, "false" if the target instruction is move-exception. |
| 580 | */ |
| 581 | bool CheckNotMoveException(const uint16_t* insns, int insn_idx); |
| 582 | |
| 583 | /* |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 584 | * Control can transfer to "next_insn". Merge the registers from merge_line into the table at |
| 585 | * next_insn, and set the changed flag on the target address if any of the registers were changed. |
| 586 | * Returns "false" if an error is encountered. |
| 587 | */ |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 588 | bool UpdateRegisters(uint32_t next_insn, const RegisterLine* merge_line) |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 589 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 590 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 591 | // Is the method being verified a constructor? |
| 592 | bool IsConstructor() const { |
| 593 | return (method_access_flags_ & kAccConstructor) != 0; |
| 594 | } |
| 595 | |
| 596 | // Is the method verified static? |
| 597 | bool IsStatic() const { |
| 598 | return (method_access_flags_ & kAccStatic) != 0; |
| 599 | } |
| 600 | |
| 601 | // Return the register type for the method. |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 602 | const RegType& GetMethodReturnType() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 603 | |
| 604 | // Get a type representing the declaring class of the method. |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 605 | const RegType& GetDeclaringClass() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 606 | |
Ian Rogers | 7b3ddd2 | 2013-02-21 15:19:52 -0800 | [diff] [blame] | 607 | InstructionFlags* CurrentInsnFlags(); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 608 | |
Sebastien Hertz | 849600b | 2013-12-20 10:28:08 +0100 | [diff] [blame] | 609 | const RegType& DetermineCat1Constant(int32_t value, bool precise) |
| 610 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Elliott Hughes | 0a1038b | 2012-06-14 16:24:17 -0700 | [diff] [blame] | 611 | |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 612 | RegTypeCache reg_types_; |
| 613 | |
| 614 | PcToRegisterLineTable reg_table_; |
| 615 | |
| 616 | // Storage for the register status we're currently working on. |
Ian Rogers | 700a402 | 2014-05-19 16:49:03 -0700 | [diff] [blame] | 617 | std::unique_ptr<RegisterLine> work_line_; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 618 | |
| 619 | // The address of the instruction we're currently working on, note that this is in 2 byte |
| 620 | // quantities |
| 621 | uint32_t work_insn_idx_; |
| 622 | |
| 623 | // Storage for the register status we're saving for later. |
Ian Rogers | 700a402 | 2014-05-19 16:49:03 -0700 | [diff] [blame] | 624 | std::unique_ptr<RegisterLine> saved_line_; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 625 | |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 626 | const uint32_t dex_method_idx_; // The method we're working on. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 627 | // Its object representation if known. |
Brian Carlstrom | ea46f95 | 2013-07-30 01:26:50 -0700 | [diff] [blame] | 628 | mirror::ArtMethod* mirror_method_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 629 | const uint32_t method_access_flags_; // Method's access flags. |
Ian Rogers | fc0e94b | 2013-09-23 23:51:32 -0700 | [diff] [blame] | 630 | const RegType* return_type_; // Lazily computed return type of the method. |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 631 | const DexFile* const dex_file_; // The dex file containing the method. |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 632 | // The dex_cache for the declaring class of the method. |
Mathieu Chartier | eb8167a | 2014-05-07 15:43:14 -0700 | [diff] [blame] | 633 | Handle<mirror::DexCache>* dex_cache_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 634 | // The class loader for the declaring class of the method. |
Mathieu Chartier | eb8167a | 2014-05-07 15:43:14 -0700 | [diff] [blame] | 635 | Handle<mirror::ClassLoader>* class_loader_ GUARDED_BY(Locks::mutator_lock_); |
Ian Rogers | 8b2c0b9 | 2013-09-19 02:56:49 -0700 | [diff] [blame] | 636 | const DexFile::ClassDef* const class_def_; // The class def of the declaring class of the method. |
Ian Rogers | 637c65b | 2013-05-31 11:46:00 -0700 | [diff] [blame] | 637 | const DexFile::CodeItem* const code_item_; // The code item containing the code for the method. |
| 638 | 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] | 639 | // Instruction widths and flags, one entry per code unit. |
Ian Rogers | 700a402 | 2014-05-19 16:49:03 -0700 | [diff] [blame] | 640 | std::unique_ptr<InstructionFlags[]> insn_flags_; |
Sebastien Hertz | c15853b | 2013-06-25 17:36:27 +0200 | [diff] [blame] | 641 | // The dex PC of a FindLocksAtDexPc request, -1 otherwise. |
Elliott Hughes | 08fc03a | 2012-06-26 17:34:00 -0700 | [diff] [blame] | 642 | uint32_t interesting_dex_pc_; |
| 643 | // The container into which FindLocksAtDexPc should write the registers containing held locks, |
| 644 | // NULL if we're not doing FindLocksAtDexPc. |
| 645 | std::vector<uint32_t>* monitor_enter_dex_pcs_; |
| 646 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 647 | // The types of any error that occurs. |
| 648 | std::vector<VerifyError> failures_; |
| 649 | // Error messages associated with failures. |
| 650 | std::vector<std::ostringstream*> failure_messages_; |
| 651 | // Is there a pending hard failure? |
| 652 | bool have_pending_hard_failure_; |
jeffhao | faf459e | 2012-08-31 15:32:47 -0700 | [diff] [blame] | 653 | // Is there a pending runtime throw failure? A runtime throw failure is when an instruction |
| 654 | // would fail at runtime throwing an exception. Such an instruction causes the following code |
| 655 | // to be unreachable. This is set by Fail and used to ensure we don't process unreachable |
| 656 | // instructions that would hard fail the verification. |
| 657 | bool have_pending_runtime_throw_failure_; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 658 | |
Ian Rogers | ad0b3a3 | 2012-04-16 14:50:24 -0700 | [diff] [blame] | 659 | // Info message log use primarily for verifier diagnostics. |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 660 | std::ostringstream info_messages_; |
| 661 | |
| 662 | // The number of occurrences of specific opcodes. |
| 663 | size_t new_instance_count_; |
| 664 | size_t monitor_enter_count_; |
Elliott Hughes | 80537bb | 2013-01-04 16:37:26 -0800 | [diff] [blame] | 665 | |
| 666 | const bool can_load_classes_; |
Jeff Hao | ee98895 | 2013-04-16 14:23:47 -0700 | [diff] [blame] | 667 | |
| 668 | // Converts soft failures to hard failures when false. Only false when the compiler isn't |
| 669 | // running and the verifier is called from the class linker. |
| 670 | const bool allow_soft_failures_; |
Sebastien Hertz | 4d4adb1 | 2013-07-24 16:14:19 +0200 | [diff] [blame] | 671 | |
Ian Rogers | 46960fe | 2014-05-23 10:43:43 -0700 | [diff] [blame] | 672 | // An optimization where instead of generating unique RegTypes for constants we use imprecise |
| 673 | // constants that cover a range of constants. This isn't good enough for deoptimization that |
| 674 | // avoids loading from registers in the case of a constant as the dex instruction set lost the |
| 675 | // notion of whether a value should be in a floating point or general purpose register file. |
| 676 | const bool need_precise_constants_; |
| 677 | |
Ian Rogers | a9a8254 | 2013-10-04 11:17:26 -0700 | [diff] [blame] | 678 | // Indicates the method being verified contains at least one check-cast or aput-object |
| 679 | // instruction. Aput-object operations implicitly check for array-store exceptions, similar to |
| 680 | // check-cast. |
Sebastien Hertz | 4d4adb1 | 2013-07-24 16:14:19 +0200 | [diff] [blame] | 681 | bool has_check_casts_; |
| 682 | |
Ian Rogers | a9a8254 | 2013-10-04 11:17:26 -0700 | [diff] [blame] | 683 | // Indicates the method being verified contains at least one invoke-virtual/range |
Sebastien Hertz | 4d4adb1 | 2013-07-24 16:14:19 +0200 | [diff] [blame] | 684 | // or invoke-interface/range. |
| 685 | bool has_virtual_or_interface_invokes_; |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 686 | }; |
jeffhao | e4f0b2a | 2012-08-30 11:18:57 -0700 | [diff] [blame] | 687 | std::ostream& operator<<(std::ostream& os, const MethodVerifier::FailureKind& rhs); |
Ian Rogers | 776ac1f | 2012-04-13 23:36:36 -0700 | [diff] [blame] | 688 | |
| 689 | } // namespace verifier |
| 690 | } // namespace art |
| 691 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 692 | #endif // ART_RUNTIME_VERIFIER_METHOD_VERIFIER_H_ |