Exception.h revision d4524479b8b87b88b75f269b3757bbc22361f7df
1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * you may not use this file except in compliance with the License. 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * You may obtain a copy of the License at 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 16d4524479b8b87b88b75f269b3757bbc22361f7dfAndy McFadden 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Exception handling. 19f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project#ifndef _DALVIK_EXCEPTION 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project#define _DALVIK_EXCEPTION 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* initialization */ 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectbool dvmExceptionStartup(void); 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmExceptionShutdown(void); 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Throw an exception in the current thread, by class descriptor. 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmThrowChainedException(const char* exceptionDescriptor, const char* msg, 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Object* cause); 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE void dvmThrowException(const char* exceptionDescriptor, 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project const char* msg) 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project{ 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project dvmThrowChainedException(exceptionDescriptor, msg, NULL); 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 37f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 38f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 390171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden * Like dvmThrowChainedException, but takes printf-style args for the message. 400171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden */ 410171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFaddenvoid dvmThrowExceptionFmtV(const char* exceptionDescriptor, const char* fmt, 420171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden va_list args); 43d4524479b8b87b88b75f269b3757bbc22361f7dfAndy McFaddenvoid dvmThrowExceptionFmt(const char* exceptionDescriptor, const char* fmt, ...) 44d4524479b8b87b88b75f269b3757bbc22361f7dfAndy McFadden#if defined(__GNUC__) 45d4524479b8b87b88b75f269b3757bbc22361f7dfAndy McFadden __attribute__ ((format(printf, 2, 3))) 46d4524479b8b87b88b75f269b3757bbc22361f7dfAndy McFadden#endif 47d4524479b8b87b88b75f269b3757bbc22361f7dfAndy McFadden ; 480171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFaddenINLINE void dvmThrowExceptionFmt(const char* exceptionDescriptor, 490171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden const char* fmt, ...) 500171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden{ 510171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden va_list args; 520171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden va_start(args, fmt); 530171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden dvmThrowExceptionFmtV(exceptionDescriptor, fmt, args); 540171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden va_end(args); 550171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden} 560171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden 570171812e59e2520a4345b9bbadd4f7afa0a1de16Andy McFadden/* 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Throw an exception in the current thread, by class object. 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmThrowChainedExceptionByClass(ClassObject* exceptionClass, 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project const char* msg, Object* cause); 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE void dvmThrowExceptionByClass(ClassObject* exceptionClass, 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project const char* msg) 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project{ 65f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project dvmThrowChainedExceptionByClass(exceptionClass, msg, NULL); 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 67f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 68f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Throw the named exception using the name of a class as the exception 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * message. 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 72f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmThrowChainedExceptionWithClassMessage(const char* exceptionDescriptor, 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project const char* messageDescriptor, Object* cause); 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE void dvmThrowExceptionWithClassMessage(const char* exceptionDescriptor, 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project const char* messageDescriptor) 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project{ 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project dvmThrowChainedExceptionWithClassMessage(exceptionDescriptor, 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project messageDescriptor, NULL); 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 81f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Like dvmThrowExceptionWithMessageFromDescriptor, but take a 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * class object instead of a name. 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmThrowExceptionByClassWithClassMessage(ClassObject* exceptionClass, 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project const char* messageDescriptor); 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Return the exception being thrown in the current thread, or NULL if 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * no exception is pending. 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE Object* dvmGetException(Thread* self) { 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return self->exception; 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 96f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Set the exception being thrown in the current thread. 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE void dvmSetException(Thread* self, Object* exception) 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project{ 101f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project assert(exception != NULL); 102f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project self->exception = exception; 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 104f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Clear the pending exception. 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * (We use this rather than "set(null)" because we may need to have special 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * fixups here for StackOverflowError stuff. Calling "clear" in the code 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * makes it obvious.) 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 112f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE void dvmClearException(Thread* self) { 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project self->exception = NULL; 114f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Clear the pending exception. Used by the optimization and verification 118f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * code, which has to run with "initializing" set to avoid going into a 119f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * death-spin if the "class not found" exception can't be found. 120f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 121f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmClearOptException(Thread* self); 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 123f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 124f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns "true" if an exception is pending. Use this if you have a 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * "self" pointer. 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE bool dvmCheckException(Thread* self) { 128f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return (self->exception != NULL); 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 132f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns "true" if this is a "checked" exception, i.e. it's a subclass 133f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * of Throwable (assumed) but not a subclass of RuntimeException or Error. 134f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 135f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectbool dvmIsCheckedException(const Object* exception); 136f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 137f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 138f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Wrap the now-pending exception in a different exception. 139f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 140f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * If something fails, an (unchecked) exception related to that failure 141f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * will be pending instead. 142f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 143f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmWrapException(const char* newExcepStr); 144f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 145f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 146686e1e23324f1c1f358f29f13f23e57b41c00eaaAndy McFadden * Get the "cause" field from an exception. 147686e1e23324f1c1f358f29f13f23e57b41c00eaaAndy McFadden * 148686e1e23324f1c1f358f29f13f23e57b41c00eaaAndy McFadden * Returns NULL if the field is null or uninitialized. 149686e1e23324f1c1f358f29f13f23e57b41c00eaaAndy McFadden */ 150686e1e23324f1c1f358f29f13f23e57b41c00eaaAndy McFaddenObject* dvmGetExceptionCause(const Object* exception); 151686e1e23324f1c1f358f29f13f23e57b41c00eaaAndy McFadden 152686e1e23324f1c1f358f29f13f23e57b41c00eaaAndy McFadden/* 153f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Print the exception stack trace on stderr. Calls the exception's 154f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * print function. 155f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 156f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmPrintExceptionStackTrace(void); 157f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 158f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 159f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Print the exception stack trace to the log file. The exception stack 160f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * trace is computed within the VM. 161f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 162f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmLogExceptionStackTrace(void); 163f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 164f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 165f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Search for a catch block that matches "exception". 166f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 167f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * "*newFrame" gets a copy of the new frame pointer. 168f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 169f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * If "doUnroll" is set, we unroll "thread"s stack as we go (and update 170f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * self->curFrame with the same value as in *newFrame). 171f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 172f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns the offset to the catch code on success, or -1 if we couldn't 173f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * find a catcher. 174f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 175f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectint dvmFindCatchBlock(Thread* self, int relPc, Object* exception, 176f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project bool doUnroll, void** newFrame); 177f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 178f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 179f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Support for saving exception stack traces and converting them to 180f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * usable form. Use the "FillIn" function to generate a compact array 181f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * that represents the stack frames, then "GetStackTrace" to convert it 182f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * to an array of StackTraceElement objects. 183f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 184f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Don't call the "Internal" form of the function directly. 185f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 186f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid* dvmFillInStackTraceInternal(Thread* thread, bool wantObject, int* pCount); 187f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* return an [I for use by interpreted code */ 188f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE Object* dvmFillInStackTrace(Thread* thread) { 189f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return (Object*) dvmFillInStackTraceInternal(thread, true, NULL); 190f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 191f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectArrayObject* dvmGetStackTrace(const Object* stackState); 192f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* return an int* and array count; caller must free() the return value */ 193f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectINLINE int* dvmFillInStackTraceRaw(Thread* thread, int* pCount) { 194f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return (int*) dvmFillInStackTraceInternal(thread, false, pCount); 195f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 196f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source ProjectArrayObject* dvmGetStackTraceRaw(const int* intVals, int stackDepth); 197f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 198f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 199f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Print a formatted version of a raw stack trace to the log file. 200f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 201f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectvoid dvmLogRawStackTrace(const int* intVals, int stackDepth); 202f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 203f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project#endif /*_DALVIK_EXCEPTION*/ 204