Tue, 24 Jul 2012 10:51:00 -0700
7023639: JSR 292 method handle invocation needs a fast path for compiled code
6984705: JSR 292 method handle creation should not go through JNI
Summary: remove assembly code for JDK 7 chained method handles
Reviewed-by: jrose, twisti, kvn, mhaupt
Contributed-by: John Rose <john.r.rose@oracle.com>, Christian Thalinger <christian.thalinger@oracle.com>, Michael Haupt <michael.haupt@oracle.com>
1 /*
2 * Copyright (c) 1998, 2010, 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 */
25 #ifndef SHARE_VM_CODE_CODEBLOB_HPP
26 #define SHARE_VM_CODE_CODEBLOB_HPP
28 #include "asm/codeBuffer.hpp"
29 #include "compiler/oopMap.hpp"
30 #include "runtime/frame.hpp"
31 #include "runtime/handles.hpp"
33 // CodeBlob - superclass for all entries in the CodeCache.
34 //
35 // Suptypes are:
36 // nmethod : Compiled Java methods (include method that calls to native code)
37 // RuntimeStub : Call to VM runtime methods
38 // DeoptimizationBlob : Used for deoptimizatation
39 // ExceptionBlob : Used for stack unrolling
40 // SafepointBlob : Used to handle illegal instruction exceptions
41 //
42 //
43 // Layout:
44 // - header
45 // - relocation
46 // - content space
47 // - instruction space
48 // - data space
49 class DeoptimizationBlob;
51 class CodeBlob VALUE_OBJ_CLASS_SPEC {
53 friend class VMStructs;
55 private:
56 const char* _name;
57 int _size; // total size of CodeBlob in bytes
58 int _header_size; // size of header (depends on subclass)
59 int _relocation_size; // size of relocation
60 int _content_offset; // offset to where content region begins (this includes consts, insts, stubs)
61 int _code_offset; // offset to where instructions region begins (this includes insts, stubs)
62 int _frame_complete_offset; // instruction offsets in [0.._frame_complete_offset) have
63 // not finished setting up their frame. Beware of pc's in
64 // that range. There is a similar range(s) on returns
65 // which we don't detect.
66 int _data_offset; // offset to where data region begins
67 int _frame_size; // size of stack frame
68 OopMapSet* _oop_maps; // OopMap for this CodeBlob
69 CodeComments _comments;
71 friend class OopRecorder;
73 public:
74 // Returns the space needed for CodeBlob
75 static unsigned int allocation_size(CodeBuffer* cb, int header_size);
77 // Creation
78 // a) simple CodeBlob
79 // frame_complete is the offset from the beginning of the instructions
80 // to where the frame setup (from stackwalk viewpoint) is complete.
81 CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size);
83 // b) full CodeBlob
84 CodeBlob(
85 const char* name,
86 CodeBuffer* cb,
87 int header_size,
88 int size,
89 int frame_complete,
90 int frame_size,
91 OopMapSet* oop_maps
92 );
94 // Deletion
95 void flush();
97 // Typing
98 virtual bool is_buffer_blob() const { return false; }
99 virtual bool is_nmethod() const { return false; }
100 virtual bool is_runtime_stub() const { return false; }
101 virtual bool is_deoptimization_stub() const { return false; }
102 virtual bool is_uncommon_trap_stub() const { return false; }
103 virtual bool is_exception_stub() const { return false; }
104 virtual bool is_safepoint_stub() const { return false; }
105 virtual bool is_adapter_blob() const { return false; }
106 virtual bool is_method_handles_adapter_blob() const { return false; }
108 virtual bool is_compiled_by_c2() const { return false; }
109 virtual bool is_compiled_by_c1() const { return false; }
111 // Casting
112 nmethod* as_nmethod_or_null() { return is_nmethod() ? (nmethod*) this : NULL; }
114 // Boundaries
115 address header_begin() const { return (address) this; }
116 address header_end() const { return ((address) this) + _header_size; };
117 relocInfo* relocation_begin() const { return (relocInfo*) header_end(); };
118 relocInfo* relocation_end() const { return (relocInfo*)(header_end() + _relocation_size); }
119 address content_begin() const { return (address) header_begin() + _content_offset; }
120 address content_end() const { return (address) header_begin() + _data_offset; }
121 address code_begin() const { return (address) header_begin() + _code_offset; }
122 address code_end() const { return (address) header_begin() + _data_offset; }
123 address data_begin() const { return (address) header_begin() + _data_offset; }
124 address data_end() const { return (address) header_begin() + _size; }
126 // Offsets
127 int relocation_offset() const { return _header_size; }
128 int content_offset() const { return _content_offset; }
129 int code_offset() const { return _code_offset; }
130 int data_offset() const { return _data_offset; }
132 // Sizes
133 int size() const { return _size; }
134 int header_size() const { return _header_size; }
135 int relocation_size() const { return (address) relocation_end() - (address) relocation_begin(); }
136 int content_size() const { return content_end() - content_begin(); }
137 int code_size() const { return code_end() - code_begin(); }
138 int data_size() const { return data_end() - data_begin(); }
140 // Containment
141 bool blob_contains(address addr) const { return header_begin() <= addr && addr < data_end(); }
142 bool relocation_contains(relocInfo* addr) const{ return relocation_begin() <= addr && addr < relocation_end(); }
143 bool content_contains(address addr) const { return content_begin() <= addr && addr < content_end(); }
144 bool code_contains(address addr) const { return code_begin() <= addr && addr < code_end(); }
145 bool data_contains(address addr) const { return data_begin() <= addr && addr < data_end(); }
146 bool contains(address addr) const { return content_contains(addr); }
147 bool is_frame_complete_at(address addr) const { return code_contains(addr) &&
148 addr >= code_begin() + _frame_complete_offset; }
150 // CodeCache support: really only used by the nmethods, but in order to get
151 // asserts and certain bookkeeping to work in the CodeCache they are defined
152 // virtual here.
153 virtual bool is_zombie() const { return false; }
154 virtual bool is_locked_by_vm() const { return false; }
156 virtual bool is_unloaded() const { return false; }
157 virtual bool is_not_entrant() const { return false; }
159 // GC support
160 virtual bool is_alive() const = 0;
162 // OopMap for frame
163 OopMapSet* oop_maps() const { return _oop_maps; }
164 void set_oop_maps(OopMapSet* p);
165 OopMap* oop_map_for_return_address(address return_address);
166 virtual void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { ShouldNotReachHere(); }
168 // Frame support
169 int frame_size() const { return _frame_size; }
170 void set_frame_size(int size) { _frame_size = size; }
172 // Returns true, if the next frame is responsible for GC'ing oops passed as arguments
173 virtual bool caller_must_gc_arguments(JavaThread* thread) const { return false; }
175 // Naming
176 const char* name() const { return _name; }
177 void set_name(const char* name) { _name = name; }
179 // Debugging
180 virtual void verify();
181 void print() const { print_on(tty); }
182 virtual void print_on(outputStream* st) const;
183 virtual void print_value_on(outputStream* st) const;
185 // Deal with Disassembler, VTune, Forte, JvmtiExport, MemoryService.
186 static void trace_new_stub(CodeBlob* blob, const char* name1, const char* name2 = "");
188 // Print the comment associated with offset on stream, if there is one
189 virtual void print_block_comment(outputStream* stream, address block_begin) {
190 intptr_t offset = (intptr_t)(block_begin - code_begin());
191 _comments.print_block_comment(stream, offset);
192 }
194 // Transfer ownership of comments to this CodeBlob
195 void set_comments(CodeComments& comments) {
196 _comments.assign(comments);
197 }
198 };
201 //----------------------------------------------------------------------------------------------------
202 // BufferBlob: used to hold non-relocatable machine code such as the interpreter, stubroutines, etc.
204 class BufferBlob: public CodeBlob {
205 friend class VMStructs;
206 friend class AdapterBlob;
207 friend class MethodHandlesAdapterBlob;
209 private:
210 // Creation support
211 BufferBlob(const char* name, int size);
212 BufferBlob(const char* name, int size, CodeBuffer* cb);
214 void* operator new(size_t s, unsigned size);
216 public:
217 // Creation
218 static BufferBlob* create(const char* name, int buffer_size);
219 static BufferBlob* create(const char* name, CodeBuffer* cb);
221 static void free(BufferBlob* buf);
223 // Typing
224 virtual bool is_buffer_blob() const { return true; }
226 // GC/Verification support
227 void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { /* nothing to do */ }
228 bool is_alive() const { return true; }
230 void verify();
231 void print_on(outputStream* st) const;
232 void print_value_on(outputStream* st) const;
233 };
236 //----------------------------------------------------------------------------------------------------
237 // AdapterBlob: used to hold C2I/I2C adapters
239 class AdapterBlob: public BufferBlob {
240 private:
241 AdapterBlob(int size, CodeBuffer* cb);
243 public:
244 // Creation
245 static AdapterBlob* create(CodeBuffer* cb);
247 // Typing
248 virtual bool is_adapter_blob() const { return true; }
249 };
252 //----------------------------------------------------------------------------------------------------
253 // MethodHandlesAdapterBlob: used to hold MethodHandles adapters
255 class MethodHandlesAdapterBlob: public BufferBlob {
256 private:
257 MethodHandlesAdapterBlob(int size) : BufferBlob("MethodHandles adapters", size) {}
258 MethodHandlesAdapterBlob(int size, CodeBuffer* cb) : BufferBlob("MethodHandles adapters", size, cb) {}
260 public:
261 // Creation
262 static MethodHandlesAdapterBlob* create(int buffer_size);
264 // Typing
265 virtual bool is_method_handles_adapter_blob() const { return true; }
266 };
269 //----------------------------------------------------------------------------------------------------
270 // RuntimeStub: describes stubs used by compiled code to call a (static) C++ runtime routine
272 class RuntimeStub: public CodeBlob {
273 friend class VMStructs;
274 private:
275 bool _caller_must_gc_arguments;
277 // Creation support
278 RuntimeStub(
279 const char* name,
280 CodeBuffer* cb,
281 int size,
282 int frame_complete,
283 int frame_size,
284 OopMapSet* oop_maps,
285 bool caller_must_gc_arguments
286 );
288 void* operator new(size_t s, unsigned size);
290 public:
291 // Creation
292 static RuntimeStub* new_runtime_stub(
293 const char* stub_name,
294 CodeBuffer* cb,
295 int frame_complete,
296 int frame_size,
297 OopMapSet* oop_maps,
298 bool caller_must_gc_arguments
299 );
301 // Typing
302 bool is_runtime_stub() const { return true; }
304 // GC support
305 bool caller_must_gc_arguments(JavaThread* thread) const { return _caller_must_gc_arguments; }
307 address entry_point() { return code_begin(); }
309 // GC/Verification support
310 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* nothing to do */ }
311 bool is_alive() const { return true; }
313 void verify();
314 void print_on(outputStream* st) const;
315 void print_value_on(outputStream* st) const;
316 };
319 //----------------------------------------------------------------------------------------------------
320 // Super-class for all blobs that exist in only one instance. Implements default behaviour.
322 class SingletonBlob: public CodeBlob {
323 friend class VMStructs;
325 protected:
326 void* operator new(size_t s, unsigned size);
328 public:
329 SingletonBlob(
330 const char* name,
331 CodeBuffer* cb,
332 int header_size,
333 int size,
334 int frame_size,
335 OopMapSet* oop_maps
336 )
337 : CodeBlob(name, cb, header_size, size, CodeOffsets::frame_never_safe, frame_size, oop_maps)
338 {};
340 address entry_point() { return code_begin(); }
342 bool is_alive() const { return true; }
344 void verify(); // does nothing
345 void print_on(outputStream* st) const;
346 void print_value_on(outputStream* st) const;
347 };
350 //----------------------------------------------------------------------------------------------------
351 // DeoptimizationBlob
353 class DeoptimizationBlob: public SingletonBlob {
354 friend class VMStructs;
355 private:
356 int _unpack_offset;
357 int _unpack_with_exception;
358 int _unpack_with_reexecution;
360 int _unpack_with_exception_in_tls;
362 // Creation support
363 DeoptimizationBlob(
364 CodeBuffer* cb,
365 int size,
366 OopMapSet* oop_maps,
367 int unpack_offset,
368 int unpack_with_exception_offset,
369 int unpack_with_reexecution_offset,
370 int frame_size
371 );
373 public:
374 // Creation
375 static DeoptimizationBlob* create(
376 CodeBuffer* cb,
377 OopMapSet* oop_maps,
378 int unpack_offset,
379 int unpack_with_exception_offset,
380 int unpack_with_reexecution_offset,
381 int frame_size
382 );
384 // Typing
385 bool is_deoptimization_stub() const { return true; }
386 bool exception_address_is_unpack_entry(address pc) const {
387 address unpack_pc = unpack();
388 return (pc == unpack_pc || (pc + frame::pc_return_offset) == unpack_pc);
389 }
394 // GC for args
395 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* Nothing to do */ }
397 // Printing
398 void print_value_on(outputStream* st) const;
400 address unpack() const { return code_begin() + _unpack_offset; }
401 address unpack_with_exception() const { return code_begin() + _unpack_with_exception; }
402 address unpack_with_reexecution() const { return code_begin() + _unpack_with_reexecution; }
404 // Alternate entry point for C1 where the exception and issuing pc
405 // are in JavaThread::_exception_oop and JavaThread::_exception_pc
406 // instead of being in registers. This is needed because C1 doesn't
407 // model exception paths in a way that keeps these registers free so
408 // there may be live values in those registers during deopt.
409 void set_unpack_with_exception_in_tls_offset(int offset) {
410 _unpack_with_exception_in_tls = offset;
411 assert(code_contains(code_begin() + _unpack_with_exception_in_tls), "must be PC inside codeblob");
412 }
413 address unpack_with_exception_in_tls() const { return code_begin() + _unpack_with_exception_in_tls; }
414 };
417 //----------------------------------------------------------------------------------------------------
418 // UncommonTrapBlob (currently only used by Compiler 2)
420 #ifdef COMPILER2
422 class UncommonTrapBlob: public SingletonBlob {
423 friend class VMStructs;
424 private:
425 // Creation support
426 UncommonTrapBlob(
427 CodeBuffer* cb,
428 int size,
429 OopMapSet* oop_maps,
430 int frame_size
431 );
433 public:
434 // Creation
435 static UncommonTrapBlob* create(
436 CodeBuffer* cb,
437 OopMapSet* oop_maps,
438 int frame_size
439 );
441 // GC for args
442 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* nothing to do */ }
444 // Typing
445 bool is_uncommon_trap_stub() const { return true; }
446 };
449 //----------------------------------------------------------------------------------------------------
450 // ExceptionBlob: used for exception unwinding in compiled code (currently only used by Compiler 2)
452 class ExceptionBlob: public SingletonBlob {
453 friend class VMStructs;
454 private:
455 // Creation support
456 ExceptionBlob(
457 CodeBuffer* cb,
458 int size,
459 OopMapSet* oop_maps,
460 int frame_size
461 );
463 public:
464 // Creation
465 static ExceptionBlob* create(
466 CodeBuffer* cb,
467 OopMapSet* oop_maps,
468 int frame_size
469 );
471 // GC for args
472 void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { /* nothing to do */ }
474 // Typing
475 bool is_exception_stub() const { return true; }
476 };
477 #endif // COMPILER2
480 //----------------------------------------------------------------------------------------------------
481 // SafepointBlob: handles illegal_instruction exceptions during a safepoint
483 class SafepointBlob: public SingletonBlob {
484 friend class VMStructs;
485 private:
486 // Creation support
487 SafepointBlob(
488 CodeBuffer* cb,
489 int size,
490 OopMapSet* oop_maps,
491 int frame_size
492 );
494 public:
495 // Creation
496 static SafepointBlob* create(
497 CodeBuffer* cb,
498 OopMapSet* oop_maps,
499 int frame_size
500 );
502 // GC for args
503 void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { /* nothing to do */ }
505 // Typing
506 bool is_safepoint_stub() const { return true; }
507 };
509 #endif // SHARE_VM_CODE_CODEBLOB_HPP