blob: 8eef71aa37fbaf9e8c550eaaa0b0e70ac98b6a45 [file] [log] [blame]
Ian Rogers776ac1f2012-04-13 23:36:36 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_SRC_VERIFIER_METHOD_VERIFIER_H_
18#define ART_SRC_VERIFIER_METHOD_VERIFIER_H_
19
20#include <deque>
21#include <limits>
22#include <set>
23#include <vector>
24
25#include "casts.h"
26#include "compiler.h"
27#include "dex_file.h"
28#include "dex_instruction.h"
29#include "macros.h"
30#include "object.h"
31#include "reg_type.h"
32#include "reg_type_cache.h"
33#include "register_line.h"
34#include "safe_map.h"
35#include "stl_util.h"
36#include "UniquePtr.h"
37
38namespace art {
39
40struct ReferenceMap2Visitor;
41
42#if defined(ART_USE_LLVM_COMPILER)
43namespace compiler_llvm {
44 class InferredRegCategoryMap;
45} // namespace compiler_llvm
46#endif
47
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -070048#if defined(ART_USE_GREENLAND_COMPILER)
49namespace greenland {
50 class InferredRegCategoryMap;
51} // namespace greenland
52#endif
53
Ian Rogers776ac1f2012-04-13 23:36:36 -070054namespace verifier {
55
56class MethodVerifier;
57class InsnFlags;
58class PcToReferenceMap;
59
60/*
61 * Set this to enable dead code scanning. This is not required, but it's very useful when testing
62 * changes to the verifier (to make sure we're not skipping over stuff). The only reason not to do
63 * it is that it slightly increases the time required to perform verification.
64 */
65#define DEAD_CODE_SCAN kIsDebugBuild
66
67/*
68 * "Direct" and "virtual" methods are stored independently. The type of call used to invoke the
69 * method determines which list we search, and whether we travel up into superclasses.
70 *
71 * (<clinit>, <init>, and methods declared "private" or "static" are stored in the "direct" list.
72 * All others are stored in the "virtual" list.)
73 */
74enum MethodType {
75 METHOD_UNKNOWN = 0,
76 METHOD_DIRECT, // <init>, private
77 METHOD_STATIC, // static
78 METHOD_VIRTUAL, // virtual, super
79 METHOD_INTERFACE // interface
80};
81
82/*
83 * An enumeration of problems that can turn up during verification.
84 * Both VERIFY_ERROR_BAD_CLASS_SOFT and VERIFY_ERROR_BAD_CLASS_HARD denote failures that cause
85 * the entire class to be rejected. However, VERIFY_ERROR_BAD_CLASS_SOFT denotes a soft failure
86 * that can potentially be corrected, and the verifier will try again at runtime.
87 * VERIFY_ERROR_BAD_CLASS_HARD denotes a hard failure that can't be corrected, and will cause
88 * the class to remain uncompiled. Other errors denote verification errors that cause bytecode
89 * to be rewritten to fail at runtime.
90 */
91enum VerifyError {
Ian Rogers776ac1f2012-04-13 23:36:36 -070092 VERIFY_ERROR_BAD_CLASS_HARD, // VerifyError; hard error that skips compilation.
93 VERIFY_ERROR_BAD_CLASS_SOFT, // VerifyError; soft error that verifies again at runtime.
94
95 VERIFY_ERROR_NO_CLASS, // NoClassDefFoundError.
96 VERIFY_ERROR_NO_FIELD, // NoSuchFieldError.
97 VERIFY_ERROR_NO_METHOD, // NoSuchMethodError.
98 VERIFY_ERROR_ACCESS_CLASS, // IllegalAccessError.
99 VERIFY_ERROR_ACCESS_FIELD, // IllegalAccessError.
100 VERIFY_ERROR_ACCESS_METHOD, // IllegalAccessError.
101 VERIFY_ERROR_CLASS_CHANGE, // IncompatibleClassChangeError.
102 VERIFY_ERROR_INSTANTIATION, // InstantiationError.
103};
104std::ostream& operator<<(std::ostream& os, const VerifyError& rhs);
105
106/*
107 * Identifies the type of reference in the instruction that generated the verify error
108 * (e.g. VERIFY_ERROR_ACCESS_CLASS could come from a method, field, or class reference).
109 *
110 * This must fit in two bits.
111 */
112enum VerifyErrorRefType {
113 VERIFY_ERROR_REF_CLASS = 0,
114 VERIFY_ERROR_REF_FIELD = 1,
115 VERIFY_ERROR_REF_METHOD = 2,
116};
117const int kVerifyErrorRefTypeShift = 6;
118
119// We don't need to store the register data for many instructions, because we either only need
120// it at branch points (for verification) or GC points and branches (for verification +
121// type-precise register analysis).
122enum RegisterTrackingMode {
123 kTrackRegsBranches,
124 kTrackRegsGcPoints,
125 kTrackRegsAll,
126};
127
128class PcToRegisterLineTable {
129 public:
130 PcToRegisterLineTable() {}
131 ~PcToRegisterLineTable() {
132 STLDeleteValues(&pc_to_register_line_);
133 }
134
135 // Initialize the RegisterTable. Every instruction address can have a different set of information
136 // about what's in which register, but for verification purposes we only need to store it at
137 // branch target addresses (because we merge into that).
138 void Init(RegisterTrackingMode mode, InsnFlags* flags, uint32_t insns_size,
139 uint16_t registers_size, MethodVerifier* verifier);
140
141 RegisterLine* GetLine(size_t idx) {
142 Table::iterator result = pc_to_register_line_.find(idx); // TODO: C++0x auto
143 if (result == pc_to_register_line_.end()) {
144 return NULL;
145 } else {
146 return result->second;
147 }
148 }
149
150 private:
151 typedef SafeMap<int32_t, RegisterLine*> Table;
152 // Map from a dex pc to the register status associated with it
153 Table pc_to_register_line_;
154};
155
156// The verifier
157class MethodVerifier {
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -0700158#if defined(ART_USE_LLVM_COMPILER)
159 typedef compiler_llvm::InferredRegCategoryMap InferredRegCategoryMap;
160#elif defined(ART_USE_GREENLAND_COMPILER)
161 typedef greenland::InferredRegCategoryMap InferredRegCategoryMap;
162#endif
Elliott Hughesa21039c2012-06-21 12:09:25 -0700163
Ian Rogers776ac1f2012-04-13 23:36:36 -0700164 public:
jeffhaof1e6b7c2012-06-05 18:33:30 -0700165 enum FailureKind {
166 kNoFailure,
167 kSoftFailure,
168 kHardFailure,
169 };
170
171 /* Verify a class. Returns "kNoFailure" on success. */
172 static FailureKind VerifyClass(const Class* klass, std::string& error);
173 static FailureKind VerifyClass(const DexFile* dex_file, DexCache* dex_cache,
Ian Rogers365c1022012-06-22 15:05:28 -0700174 ClassLoader* class_loader, uint32_t class_def_idx,
175 std::string& error);
Ian Rogers776ac1f2012-04-13 23:36:36 -0700176
177 uint8_t EncodePcToReferenceMapData() const;
178
179 uint32_t DexFileVersion() const {
180 return dex_file_->GetVersion();
181 }
182
183 RegTypeCache* GetRegTypeCache() {
184 return &reg_types_;
185 }
186
Ian Rogersad0b3a32012-04-16 14:50:24 -0700187 // Log a verification failure.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700188 std::ostream& Fail(VerifyError error);
189
Ian Rogersad0b3a32012-04-16 14:50:24 -0700190 // Log for verification information.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700191 std::ostream& LogVerifyInfo() {
Ian Rogersad0b3a32012-04-16 14:50:24 -0700192 return info_messages_ << "VFY: " << PrettyMethod(method_idx_, *dex_file_)
Ian Rogers776ac1f2012-04-13 23:36:36 -0700193 << '[' << reinterpret_cast<void*>(work_insn_idx_) << "] : ";
194 }
195
Ian Rogersad0b3a32012-04-16 14:50:24 -0700196 // Dump the failures encountered by the verifier.
197 std::ostream& DumpFailures(std::ostream& os);
198
Ian Rogers776ac1f2012-04-13 23:36:36 -0700199 // Dump the state of the verifier, namely each instruction, what flags are set on it, register
200 // information
201 void Dump(std::ostream& os);
202
203 static const std::vector<uint8_t>* GetGcMap(Compiler::MethodReference ref);
Elliott Hughes0a1038b2012-06-14 16:24:17 -0700204
Elliott Hughes08fc03a2012-06-26 17:34:00 -0700205 // Fills 'monitor_enter_dex_pcs' with the dex pcs of the monitor-enter instructions corresponding
206 // to the locks held at 'dex_pc' in 'm'.
207 static void FindLocksAtDexPc(Method* m, uint32_t dex_pc, std::vector<uint32_t>& monitor_enter_dex_pcs);
208
Elliott Hughes0a1038b2012-06-14 16:24:17 -0700209 static void Init();
210 static void Shutdown();
Ian Rogers776ac1f2012-04-13 23:36:36 -0700211
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -0700212#if defined(ART_USE_LLVM_COMPILER) || defined(ART_USE_GREENLAND_COMPILER)
213 static const InferredRegCategoryMap* GetInferredRegCategoryMap(Compiler::MethodReference ref);
Ian Rogers776ac1f2012-04-13 23:36:36 -0700214#endif
215
216 static bool IsClassRejected(Compiler::ClassReference ref);
217
218 private:
Ian Rogers776ac1f2012-04-13 23:36:36 -0700219 explicit MethodVerifier(const DexFile* dex_file, DexCache* dex_cache,
Ian Rogers365c1022012-06-22 15:05:28 -0700220 ClassLoader* class_loader, uint32_t class_def_idx, const DexFile::CodeItem* code_item,
Ian Rogersad0b3a32012-04-16 14:50:24 -0700221 uint32_t method_idx, Method* method, uint32_t access_flags);
222
223 // Adds the given string to the beginning of the last failure message.
224 void PrependToLastFailMessage(std::string);
225
226 // Adds the given string to the end of the last failure message.
227 void AppendToLastFailMessage(std::string);
Ian Rogers776ac1f2012-04-13 23:36:36 -0700228
229 /*
230 * Perform verification on a single method.
231 *
232 * We do this in three passes:
233 * (1) Walk through all code units, determining instruction locations,
234 * widths, and other characteristics.
235 * (2) Walk through all code units, performing static checks on
236 * operands.
237 * (3) Iterate through the method, checking type safety and looking
238 * for code flow problems.
Ian Rogerse1758fe2012-04-19 11:31:15 -0700239 */
jeffhaof1e6b7c2012-06-05 18:33:30 -0700240 static FailureKind VerifyMethod(uint32_t method_idx, const DexFile* dex_file, DexCache* dex_cache,
Ian Rogers365c1022012-06-22 15:05:28 -0700241 ClassLoader* class_loader, uint32_t class_def_idx, const DexFile::CodeItem* code_item,
Ian Rogersad0b3a32012-04-16 14:50:24 -0700242 Method* method, uint32_t method_access_flags);
243 static void VerifyMethodAndDump(Method* method);
Ian Rogerse1758fe2012-04-19 11:31:15 -0700244
Ian Rogersad0b3a32012-04-16 14:50:24 -0700245 // Run verification on the method. Returns true if verification completes and false if the input
246 // has an irrecoverable corruption.
247 bool Verify();
Ian Rogers776ac1f2012-04-13 23:36:36 -0700248
Elliott Hughes08fc03a2012-06-26 17:34:00 -0700249 void FindLocksAtDexPc();
250
Ian Rogers776ac1f2012-04-13 23:36:36 -0700251 /*
252 * Compute the width of the instruction at each address in the instruction stream, and store it in
253 * insn_flags_. Addresses that are in the middle of an instruction, or that are part of switch
254 * table data, are not touched (so the caller should probably initialize "insn_flags" to zero).
255 *
256 * The "new_instance_count_" and "monitor_enter_count_" fields in vdata are also set.
257 *
258 * Performs some static checks, notably:
259 * - opcode of first instruction begins at index 0
260 * - only documented instructions may appear
261 * - each instruction follows the last
262 * - last byte of last instruction is at (code_length-1)
263 *
264 * Logs an error and returns "false" on failure.
265 */
266 bool ComputeWidthsAndCountOps();
267
268 /*
269 * Set the "in try" flags for all instructions protected by "try" statements. Also sets the
270 * "branch target" flags for exception handlers.
271 *
272 * Call this after widths have been set in "insn_flags".
273 *
274 * Returns "false" if something in the exception table looks fishy, but we're expecting the
275 * exception table to be somewhat sane.
276 */
277 bool ScanTryCatchBlocks();
278
279 /*
280 * Perform static verification on all instructions in a method.
281 *
282 * Walks through instructions in a method calling VerifyInstruction on each.
283 */
284 bool VerifyInstructions();
285
286 /*
287 * Perform static verification on an instruction.
288 *
289 * As a side effect, this sets the "branch target" flags in InsnFlags.
290 *
291 * "(CF)" items are handled during code-flow analysis.
292 *
293 * v3 4.10.1
294 * - target of each jump and branch instruction must be valid
295 * - targets of switch statements must be valid
296 * - operands referencing constant pool entries must be valid
297 * - (CF) operands of getfield, putfield, getstatic, putstatic must be valid
298 * - (CF) operands of method invocation instructions must be valid
299 * - (CF) only invoke-direct can call a method starting with '<'
300 * - (CF) <clinit> must never be called explicitly
301 * - operands of instanceof, checkcast, new (and variants) must be valid
302 * - new-array[-type] limited to 255 dimensions
303 * - can't use "new" on an array class
304 * - (?) limit dimensions in multi-array creation
305 * - local variable load/store register values must be in valid range
306 *
307 * v3 4.11.1.2
308 * - branches must be within the bounds of the code array
309 * - targets of all control-flow instructions are the start of an instruction
310 * - register accesses fall within range of allocated registers
311 * - (N/A) access to constant pool must be of appropriate type
312 * - code does not end in the middle of an instruction
313 * - execution cannot fall off the end of the code
314 * - (earlier) for each exception handler, the "try" area must begin and
315 * end at the start of an instruction (end can be at the end of the code)
316 * - (earlier) for each exception handler, the handler must start at a valid
317 * instruction
318 */
319 bool VerifyInstruction(const Instruction* inst, uint32_t code_offset);
320
321 /* Ensure that the register index is valid for this code item. */
322 bool CheckRegisterIndex(uint32_t idx);
323
324 /* Ensure that the wide register index is valid for this code item. */
325 bool CheckWideRegisterIndex(uint32_t idx);
326
327 // Perform static checks on a field get or set instruction. All we do here is ensure that the
328 // field index is in the valid range.
329 bool CheckFieldIndex(uint32_t idx);
330
331 // Perform static checks on a method invocation instruction. All we do here is ensure that the
332 // method index is in the valid range.
333 bool CheckMethodIndex(uint32_t idx);
334
335 // Perform static checks on a "new-instance" instruction. Specifically, make sure the class
336 // reference isn't for an array class.
337 bool CheckNewInstance(uint32_t idx);
338
339 /* Ensure that the string index is in the valid range. */
340 bool CheckStringIndex(uint32_t idx);
341
342 // Perform static checks on an instruction that takes a class constant. Ensure that the class
343 // index is in the valid range.
344 bool CheckTypeIndex(uint32_t idx);
345
346 // Perform static checks on a "new-array" instruction. Specifically, make sure they aren't
347 // creating an array of arrays that causes the number of dimensions to exceed 255.
348 bool CheckNewArray(uint32_t idx);
349
350 // Verify an array data table. "cur_offset" is the offset of the fill-array-data instruction.
351 bool CheckArrayData(uint32_t cur_offset);
352
353 // Verify that the target of a branch instruction is valid. We don't expect code to jump directly
354 // into an exception handler, but it's valid to do so as long as the target isn't a
355 // "move-exception" instruction. We verify that in a later stage.
356 // The dex format forbids certain instructions from branching to themselves.
Elliott Hughes24edeb52012-06-18 15:29:46 -0700357 // Updates "insn_flags_", setting the "branch target" flag.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700358 bool CheckBranchTarget(uint32_t cur_offset);
359
360 // Verify a switch table. "cur_offset" is the offset of the switch instruction.
Elliott Hughes24edeb52012-06-18 15:29:46 -0700361 // Updates "insn_flags_", setting the "branch target" flag.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700362 bool CheckSwitchTargets(uint32_t cur_offset);
363
364 // Check the register indices used in a "vararg" instruction, such as invoke-virtual or
365 // filled-new-array.
366 // - vA holds word count (0-5), args[] have values.
367 // There are some tests we don't do here, e.g. we don't try to verify that invoking a method that
368 // takes a double is done with consecutive registers. This requires parsing the target method
369 // signature, which we will be doing later on during the code flow analysis.
370 bool CheckVarArgRegs(uint32_t vA, uint32_t arg[]);
371
372 // Check the register indices used in a "vararg/range" instruction, such as invoke-virtual/range
373 // or filled-new-array/range.
374 // - vA holds word count, vC holds index of first reg.
375 bool CheckVarArgRangeRegs(uint32_t vA, uint32_t vC);
376
377 // Extract the relative offset from a branch instruction.
378 // Returns "false" on failure (e.g. this isn't a branch instruction).
379 bool GetBranchOffset(uint32_t cur_offset, int32_t* pOffset, bool* pConditional,
380 bool* selfOkay);
381
382 /* Perform detailed code-flow analysis on a single method. */
383 bool VerifyCodeFlow();
384
385 // Set the register types for the first instruction in the method based on the method signature.
386 // This has the side-effect of validating the signature.
387 bool SetTypesFromSignature();
388
389 /*
390 * Perform code flow on a method.
391 *
392 * The basic strategy is as outlined in v3 4.11.1.2: set the "changed" bit on the first
393 * instruction, process it (setting additional "changed" bits), and repeat until there are no
394 * more.
395 *
396 * v3 4.11.1.1
397 * - (N/A) operand stack is always the same size
398 * - operand stack [registers] contain the correct types of values
399 * - local variables [registers] contain the correct types of values
400 * - methods are invoked with the appropriate arguments
401 * - fields are assigned using values of appropriate types
402 * - opcodes have the correct type values in operand registers
403 * - there is never an uninitialized class instance in a local variable in code protected by an
404 * exception handler (operand stack is okay, because the operand stack is discarded when an
405 * exception is thrown) [can't know what's a local var w/o the debug info -- should fall out of
406 * register typing]
407 *
408 * v3 4.11.1.2
409 * - execution cannot fall off the end of the code
410 *
411 * (We also do many of the items described in the "static checks" sections, because it's easier to
412 * do them here.)
413 *
414 * We need an array of RegType values, one per register, for every instruction. If the method uses
415 * monitor-enter, we need extra data for every register, and a stack for every "interesting"
416 * instruction. In theory this could become quite large -- up to several megabytes for a monster
417 * function.
418 *
419 * NOTE:
420 * The spec forbids backward branches when there's an uninitialized reference in a register. The
421 * idea is to prevent something like this:
422 * loop:
423 * move r1, r0
424 * new-instance r0, MyClass
425 * ...
426 * if-eq rN, loop // once
427 * initialize r0
428 *
429 * This leaves us with two different instances, both allocated by the same instruction, but only
430 * one is initialized. The scheme outlined in v3 4.11.1.4 wouldn't catch this, so they work around
431 * it by preventing backward branches. We achieve identical results without restricting code
432 * reordering by specifying that you can't execute the new-instance instruction if a register
433 * contains an uninitialized instance created by that same instruction.
434 */
435 bool CodeFlowVerifyMethod();
436
437 /*
438 * Perform verification for a single instruction.
439 *
440 * This requires fully decoding the instruction to determine the effect it has on registers.
441 *
442 * Finds zero or more following instructions and sets the "changed" flag if execution at that
443 * point needs to be (re-)evaluated. Register changes are merged into "reg_types_" at the target
444 * addresses. Does not set or clear any other flags in "insn_flags_".
445 */
446 bool CodeFlowVerifyInstruction(uint32_t* start_guess);
447
448 // Perform verification of a new array instruction
449 void VerifyNewArray(const DecodedInstruction& dec_insn, bool is_filled,
450 bool is_range);
451
452 // Perform verification of an aget instruction. The destination register's type will be set to
453 // be that of component type of the array unless the array type is unknown, in which case a
454 // bottom type inferred from the type of instruction is used. is_primitive is false for an
455 // aget-object.
456 void VerifyAGet(const DecodedInstruction& insn, const RegType& insn_type,
457 bool is_primitive);
458
459 // Perform verification of an aput instruction.
460 void VerifyAPut(const DecodedInstruction& insn, const RegType& insn_type,
461 bool is_primitive);
462
463 // Lookup instance field and fail for resolution violations
464 Field* GetInstanceField(const RegType& obj_type, int field_idx);
465
466 // Lookup static field and fail for resolution violations
467 Field* GetStaticField(int field_idx);
468
469 // Perform verification of an iget or sget instruction.
470 void VerifyISGet(const DecodedInstruction& insn, const RegType& insn_type,
471 bool is_primitive, bool is_static);
472
473 // Perform verification of an iput or sput instruction.
474 void VerifyISPut(const DecodedInstruction& insn, const RegType& insn_type,
475 bool is_primitive, bool is_static);
476
477 // Resolves a class based on an index and performs access checks to ensure the referrer can
478 // access the resolved class.
479 const RegType& ResolveClassAndCheckAccess(uint32_t class_idx);
480
481 /*
482 * For the "move-exception" instruction at "work_insn_idx_", which must be at an exception handler
483 * address, determine the Join of all exceptions that can land here. Fails if no matching
484 * exception handler can be found or if the Join of exception types fails.
485 */
486 const RegType& GetCaughtExceptionType();
487
488 /*
489 * Resolves a method based on an index and performs access checks to ensure
490 * the referrer can access the resolved method.
491 * Does not throw exceptions.
492 */
493 Method* ResolveMethodAndCheckAccess(uint32_t method_idx, MethodType method_type);
494
495 /*
496 * Verify the arguments to a method. We're executing in "method", making
497 * a call to the method reference in vB.
498 *
499 * If this is a "direct" invoke, we allow calls to <init>. For calls to
500 * <init>, the first argument may be an uninitialized reference. Otherwise,
501 * calls to anything starting with '<' will be rejected, as will any
502 * uninitialized reference arguments.
503 *
504 * For non-static method calls, this will verify that the method call is
505 * appropriate for the "this" argument.
506 *
507 * The method reference is in vBBBB. The "is_range" parameter determines
508 * whether we use 0-4 "args" values or a range of registers defined by
509 * vAA and vCCCC.
510 *
511 * Widening conversions on integers and references are allowed, but
512 * narrowing conversions are not.
513 *
514 * Returns the resolved method on success, NULL on failure (with *failure
515 * set appropriately).
516 */
517 Method* VerifyInvocationArgs(const DecodedInstruction& dec_insn,
518 MethodType method_type, bool is_range, bool is_super);
519
520 /*
Ian Rogers776ac1f2012-04-13 23:36:36 -0700521 * Verify that the target instruction is not "move-exception". It's important that the only way
522 * to execute a move-exception is as the first instruction of an exception handler.
523 * Returns "true" if all is well, "false" if the target instruction is move-exception.
524 */
525 bool CheckNotMoveException(const uint16_t* insns, int insn_idx);
526
527 /*
528 * Replace an instruction with "throw-verification-error". This allows us to
529 * defer error reporting until the code path is first used.
530 */
531 void ReplaceFailingInstruction();
532
533 /*
534 * Control can transfer to "next_insn". Merge the registers from merge_line into the table at
535 * next_insn, and set the changed flag on the target address if any of the registers were changed.
536 * Returns "false" if an error is encountered.
537 */
538 bool UpdateRegisters(uint32_t next_insn, const RegisterLine* merge_line);
539
Ian Rogersad0b3a32012-04-16 14:50:24 -0700540 // Is the method being verified a constructor?
541 bool IsConstructor() const {
542 return (method_access_flags_ & kAccConstructor) != 0;
543 }
544
545 // Is the method verified static?
546 bool IsStatic() const {
547 return (method_access_flags_ & kAccStatic) != 0;
548 }
549
550 // Return the register type for the method.
551 const RegType& GetMethodReturnType();
552
553 // Get a type representing the declaring class of the method.
554 const RegType& GetDeclaringClass();
555
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -0700556#if defined(ART_USE_LLVM_COMPILER) || defined(ART_USE_GREENLAND_COMPILER)
Ian Rogers776ac1f2012-04-13 23:36:36 -0700557 /*
558 * Generate the inferred register category for LLVM-based code generator.
559 * Returns a pointer to a two-dimension Class array, or NULL on failure.
560 */
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -0700561 const InferredRegCategoryMap* GenerateInferredRegCategoryMap();
Ian Rogers776ac1f2012-04-13 23:36:36 -0700562#endif
563
564 /*
565 * Generate the GC map for a method that has just been verified (i.e. we're doing this as part of
566 * verification). For type-precise determination we have all the data we need, so we just need to
567 * encode it in some clever fashion.
568 * Returns a pointer to a newly-allocated RegisterMap, or NULL on failure.
569 */
570 const std::vector<uint8_t>* GenerateGcMap();
571
572 // Verify that the GC map associated with method_ is well formed
573 void VerifyGcMap(const std::vector<uint8_t>& data);
574
575 // Compute sizes for GC map data
576 void ComputeGcMapSizes(size_t* gc_points, size_t* ref_bitmap_bits, size_t* log2_max_gc_pc);
577
578 InsnFlags* CurrentInsnFlags();
579
580 // All the GC maps that the verifier has created
581 typedef SafeMap<const Compiler::MethodReference, const std::vector<uint8_t>*> GcMapTable;
582 static Mutex* gc_maps_lock_;
583 static GcMapTable* gc_maps_;
584 static void SetGcMap(Compiler::MethodReference ref, const std::vector<uint8_t>& gc_map);
585
Elliott Hughes0a1038b2012-06-14 16:24:17 -0700586 typedef std::set<Compiler::ClassReference> RejectedClassesTable;
587 static Mutex* rejected_classes_lock_;
588 static RejectedClassesTable* rejected_classes_;
589
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -0700590#if defined(ART_USE_LLVM_COMPILER) || defined(ART_USE_GREENLAND_COMPILER)
Elliott Hughes0a1038b2012-06-14 16:24:17 -0700591 // All the inferred register category maps that the verifier has created.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700592 typedef SafeMap<const Compiler::MethodReference,
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -0700593 const InferredRegCategoryMap*> InferredRegCategoryMapTable;
Ian Rogers776ac1f2012-04-13 23:36:36 -0700594 static Mutex* inferred_reg_category_maps_lock_;
595 static InferredRegCategoryMapTable* inferred_reg_category_maps_;
596 static void SetInferredRegCategoryMap(Compiler::MethodReference ref,
Shih-wei Liaoe94d9b22012-05-22 09:01:24 -0700597 const InferredRegCategoryMap& m);
Ian Rogers776ac1f2012-04-13 23:36:36 -0700598#endif
599
600 static void AddRejectedClass(Compiler::ClassReference ref);
601
602 RegTypeCache reg_types_;
603
604 PcToRegisterLineTable reg_table_;
605
606 // Storage for the register status we're currently working on.
607 UniquePtr<RegisterLine> work_line_;
608
609 // The address of the instruction we're currently working on, note that this is in 2 byte
610 // quantities
611 uint32_t work_insn_idx_;
612
613 // Storage for the register status we're saving for later.
614 UniquePtr<RegisterLine> saved_line_;
615
Ian Rogersad0b3a32012-04-16 14:50:24 -0700616 uint32_t method_idx_; // The method we're working on.
617 Method* foo_method_; // Its object representation if known.
618 uint32_t method_access_flags_; // Method's access flags.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700619 const DexFile* dex_file_; // The dex file containing the method.
620 DexCache* dex_cache_; // The dex_cache for the declaring class of the method.
Ian Rogers365c1022012-06-22 15:05:28 -0700621 ClassLoader* class_loader_; // The class loader for the declaring class of the method.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700622 uint32_t class_def_idx_; // The class def index of the declaring class of the method.
623 const DexFile::CodeItem* code_item_; // The code item containing the code for the method.
624 UniquePtr<InsnFlags[]> insn_flags_; // Instruction widths and flags, one entry per code unit.
625
Elliott Hughes08fc03a2012-06-26 17:34:00 -0700626 // The dex PC of a FindLocksAtDexPc request, -1 otherwise.
627 uint32_t interesting_dex_pc_;
628 // The container into which FindLocksAtDexPc should write the registers containing held locks,
629 // NULL if we're not doing FindLocksAtDexPc.
630 std::vector<uint32_t>* monitor_enter_dex_pcs_;
631
Ian Rogersad0b3a32012-04-16 14:50:24 -0700632 // The types of any error that occurs.
633 std::vector<VerifyError> failures_;
634 // Error messages associated with failures.
635 std::vector<std::ostringstream*> failure_messages_;
636 // Is there a pending hard failure?
637 bool have_pending_hard_failure_;
638 // Is there a pending failure that will cause dex opcodes to be rewritten.
639 bool have_pending_rewrite_failure_;
Ian Rogers776ac1f2012-04-13 23:36:36 -0700640
Ian Rogersad0b3a32012-04-16 14:50:24 -0700641 // Info message log use primarily for verifier diagnostics.
Ian Rogers776ac1f2012-04-13 23:36:36 -0700642 std::ostringstream info_messages_;
643
644 // The number of occurrences of specific opcodes.
645 size_t new_instance_count_;
646 size_t monitor_enter_count_;
647
648 friend struct art::ReferenceMap2Visitor; // for VerifyMethodAndDump
649};
650
651} // namespace verifier
652} // namespace art
653
654#endif // ART_SRC_VERIFIER_METHOD_VERIFIER_H_