1 /*
2 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_VM_RUNTIME_JNIHANDLES_HPP
26 #define SHARE_VM_RUNTIME_JNIHANDLES_HPP
27
28 #include "runtime/handles.hpp"
29 #include "utilities/top.hpp"
30
31 class JNIHandleBlock;
32
33
34 // Interface for creating and resolving local/global JNI handles
35
36 class JNIHandles : AllStatic {
37 friend class VMStructs;
38 private:
39 static JNIHandleBlock* _global_handles; // First global handle block
40 static JNIHandleBlock* _weak_global_handles; // First weak global handle block
41 static oop _deleted_handle; // Sentinel marking deleted handles
42
43 public:
44 // Resolve handle into oop
45 inline static oop resolve(jobject handle);
46 // Resolve externally provided handle into oop with some guards
47 inline static oop resolve_external_guard(jobject handle);
48 // Resolve handle into oop, result guaranteed not to be null
49 inline static oop resolve_non_null(jobject handle);
50
51 // Local handles
52 static jobject make_local(oop obj);
53 static jobject make_local(JNIEnv* env, oop obj); // Fast version when env is known
54 static jobject make_local(Thread* thread, oop obj); // Even faster version when current thread is known
55 inline static void destroy_local(jobject handle);
56
57 // Global handles
58 static jobject make_global(Handle obj);
59 static void destroy_global(jobject handle);
60
61 // Weak global handles
62 static jobject make_weak_global(Handle obj);
63 static void destroy_weak_global(jobject handle);
64
65 // Sentinel marking deleted handles in block. Note that we cannot store NULL as
66 // the sentinel, since clearing weak global JNI refs are done by storing NULL in
67 // the handle. The handle may not be reused before destroy_weak_global is called.
68 static oop deleted_handle() { return _deleted_handle; }
69
70 // Initialization
71 static void initialize();
72
73 // Debugging
74 static void print_on(outputStream* st);
75 static void print() { print_on(tty); }
76 static void verify();
77 static bool is_local_handle(Thread* thread, jobject handle);
78 static bool is_frame_handle(JavaThread* thr, jobject obj);
79 static bool is_global_handle(jobject handle);
80 static bool is_weak_global_handle(jobject handle);
81 static long global_handle_memory_usage();
82 static long weak_global_handle_memory_usage();
83
84 // Garbage collection support(global handles only, local handles are traversed from thread)
85 // Traversal of regular global handles
86 static void oops_do(OopClosure* f);
87 // Traversal of weak global handles. Unreachable oops are cleared.
88 static void weak_oops_do(BoolObjectClosure* is_alive, OopClosure* f);
89 // Traversal of weak global handles.
90 static void weak_oops_do(OopClosure* f);
91 };
92
93
94
95 // JNI handle blocks holding local/global JNI handles
96
97 class JNIHandleBlock : public CHeapObj<mtInternal> {
98 friend class VMStructs;
99 friend class CppInterpreter;
100
101 private:
102 enum SomeConstants {
103 block_size_in_oops = 32 // Number of handles per handle block
104 };
105
106 oop _handles[block_size_in_oops]; // The handles
107 int _top; // Index of next unused handle
108 JNIHandleBlock* _next; // Link to next block
109
110 // The following instance variables are only used by the first block in a chain.
111 // Having two types of blocks complicates the code and the space overhead in negligible.
112 JNIHandleBlock* _last; // Last block in use
113 JNIHandleBlock* _pop_frame_link; // Block to restore on PopLocalFrame call
114 oop* _free_list; // Handle free list
115 int _allocate_before_rebuild; // Number of blocks to allocate before rebuilding free list
116
117 // Check JNI, "planned capacity" for current frame (or push/ensure)
118 size_t _planned_capacity;
119
120 #ifndef PRODUCT
121 JNIHandleBlock* _block_list_link; // Link for list below
122 static JNIHandleBlock* _block_list; // List of all allocated blocks (for debugging only)
123 #endif
124
125 static JNIHandleBlock* _block_free_list; // Free list of currently unused blocks
126 static int _blocks_allocated; // For debugging/printing
127
128 // Fill block with bad_handle values
129 void zap();
130
131 protected:
132 // No more handles in the both the current and following blocks
133 void clear() { _top = 0; }
134
135 private:
136 // Free list computation
137 void rebuild_free_list();
138
139 public:
140 // Handle allocation
141 jobject allocate_handle(oop obj);
142
143 // Block allocation and block free list management
144 static JNIHandleBlock* allocate_block(Thread* thread = NULL);
145 static void release_block(JNIHandleBlock* block, Thread* thread = NULL);
146
147 // JNI PushLocalFrame/PopLocalFrame support
148 JNIHandleBlock* pop_frame_link() const { return _pop_frame_link; }
149 void set_pop_frame_link(JNIHandleBlock* block) { _pop_frame_link = block; }
150
151 // Stub generator support
152 static int top_offset_in_bytes() { return offset_of(JNIHandleBlock, _top); }
153
154 // Garbage collection support
155 // Traversal of regular handles
156 void oops_do(OopClosure* f);
157 // Traversal of weak handles. Unreachable oops are cleared.
158 void weak_oops_do(BoolObjectClosure* is_alive, OopClosure* f);
159
160 // Checked JNI support
161 void set_planned_capacity(size_t planned_capacity) { _planned_capacity = planned_capacity; }
162 const size_t get_planned_capacity() { return _planned_capacity; }
163 const size_t get_number_of_live_handles();
164
165 // Debugging
166 bool chain_contains(jobject handle) const; // Does this block or following blocks contain handle
167 bool contains(jobject handle) const; // Does this block contain handle
168 int length() const; // Length of chain starting with this block
169 long memory_usage() const;
170 #ifndef PRODUCT
171 static bool any_contains(jobject handle); // Does any block currently in use contain handle
172 static void print_statistics();
173 #endif
174 };
175
176
177 inline oop JNIHandles::resolve(jobject handle) {
178 oop result = (handle == NULL ? (oop)NULL : *(oop*)handle);
179 assert(result != NULL || (handle == NULL || !CheckJNICalls || is_weak_global_handle(handle)), "Invalid value read from jni handle");
180 assert(result != badJNIHandle, "Pointing to zapped jni handle area");
181 return result;
182 };
183
184
185 inline oop JNIHandles::resolve_external_guard(jobject handle) {
186 if (handle == NULL) return NULL;
187 oop result = *(oop*)handle;
188 if (result == NULL || result == badJNIHandle) return NULL;
189 return result;
190 };
191
192
193 inline oop JNIHandles::resolve_non_null(jobject handle) {
194 assert(handle != NULL, "JNI handle should not be null");
195 oop result = *(oop*)handle;
196 assert(result != NULL, "Invalid value read from jni handle");
197 assert(result != badJNIHandle, "Pointing to zapped jni handle area");
198 // Don't let that private _deleted_handle object escape into the wild.
199 assert(result != deleted_handle(), "Used a deleted global handle.");
200 return result;
201 };
202
203 inline void JNIHandles::destroy_local(jobject handle) {
204 if (handle != NULL) {
205 *((oop*)handle) = deleted_handle(); // Mark the handle as deleted, allocate will reuse it
206 }
207 }
208
209 #endif // SHARE_VM_RUNTIME_JNIHANDLES_HPP