VMStack.java revision 8f273343b7758c09822c74b4f8a0dcf7df3a78b5 
1/*
2 * Copyright (C) 2007 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
17package dalvik.system;
18
19/**
20 * Provides a limited interface to the Dalvik VM stack. This class is mostly
21 * used for implementing security checks.
22 *
23 * @hide
24 */
25public final class VMStack {
26    /**
27     * Returns the defining class loader of the caller's caller.
28     *
29     * @return the requested class loader, or {@code null} if this is the
30     *         bootstrap class loader.
31     */
32    native public static ClassLoader getCallingClassLoader();
33
34    /**
35     * Returns the defining class loader of the caller's caller's caller.
36     *
37     * @return the requested class loader, or {@code null} if this is the
38     *         bootstrap class loader.
39     */
40    native public static ClassLoader getCallingClassLoader2();
41
42    /**
43     * Returns the class of the caller's caller's caller.
44     *
45     * @hide
46     * @return the requested class, or {@code null}.
47     */
48    native public static Class<?> getStackClass2();
49
50    /**
51     * Creates an array of classes from the methods at the top of the stack.
52     * We continue until we reach the bottom of the stack or exceed the
53     * specified maximum depth.  If stopAtPrivileged is set, the last
54     * element of the array will be the caller of the most-recent privileged
55     * method.
56     * <p>
57     * The topmost stack frame (this method) and the one above that (the
58     * caller) are excluded from the array.  Frames with java.lang.reflect
59     * classes are skipped over.
60     * <p>
61     * The classes in the array are the defining classes of the methods.
62     * <p>
63     * This is expected to be identical to Harmony's VMStack.getClasses.
64     *
65     * @param maxDepth
66     *      maximum number of classes to return, or -1 for all
67     * @param stopAtPrivileged
68     *      stop when a privileged frame is reached
69     * @return an array with classes for the most-recent methods on the stack
70     */
71    native public static Class<?>[] getClasses(int maxDepth,
72        boolean stopAtPrivileged);
73
74    /**
75     * Retrieves the stack trace from the specified thread.
76     *
77     * @param t
78     *      thread of interest
79     * @return an array of stack trace elements, or null if the thread
80     *      doesn't have a stack trace (e.g. because it exited)
81     */
82    native public static StackTraceElement[] getThreadStackTrace(Thread t);
83}
84
85