Mon, 24 Sep 2012 10:30:14 -0700
7200163: add CodeComments functionality to assember stubs
Summary: Pass the codeBuffer to the Stub constructor, and adapts the disassembler to print the comments.
Reviewed-by: jrose, kvn, twisti
Contributed-by: goetz.lindenmaier@sap.com
1 /*
2 * Copyright (c) 1998, 2012, 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 #include "precompiled.hpp"
26 #include "code/codeBlob.hpp"
27 #include "code/codeCache.hpp"
28 #include "code/relocInfo.hpp"
29 #include "compiler/disassembler.hpp"
30 #include "interpreter/bytecode.hpp"
31 #include "memory/allocation.inline.hpp"
32 #include "memory/heap.hpp"
33 #include "oops/oop.inline.hpp"
34 #include "prims/forte.hpp"
35 #include "runtime/handles.inline.hpp"
36 #include "runtime/interfaceSupport.hpp"
37 #include "runtime/mutexLocker.hpp"
38 #include "runtime/safepoint.hpp"
39 #include "runtime/sharedRuntime.hpp"
40 #include "runtime/vframe.hpp"
41 #include "services/memoryService.hpp"
42 #ifdef TARGET_ARCH_x86
43 # include "nativeInst_x86.hpp"
44 #endif
45 #ifdef TARGET_ARCH_sparc
46 # include "nativeInst_sparc.hpp"
47 #endif
48 #ifdef TARGET_ARCH_zero
49 # include "nativeInst_zero.hpp"
50 #endif
51 #ifdef TARGET_ARCH_arm
52 # include "nativeInst_arm.hpp"
53 #endif
54 #ifdef TARGET_ARCH_ppc
55 # include "nativeInst_ppc.hpp"
56 #endif
57 #ifdef COMPILER1
58 #include "c1/c1_Runtime1.hpp"
59 #endif
61 unsigned int align_code_offset(int offset) {
62 // align the size to CodeEntryAlignment
63 return
64 ((offset + (int)CodeHeap::header_size() + (CodeEntryAlignment-1)) & ~(CodeEntryAlignment-1))
65 - (int)CodeHeap::header_size();
66 }
69 // This must be consistent with the CodeBlob constructor's layout actions.
70 unsigned int CodeBlob::allocation_size(CodeBuffer* cb, int header_size) {
71 unsigned int size = header_size;
72 size += round_to(cb->total_relocation_size(), oopSize);
73 // align the size to CodeEntryAlignment
74 size = align_code_offset(size);
75 size += round_to(cb->total_content_size(), oopSize);
76 size += round_to(cb->total_oop_size(), oopSize);
77 size += round_to(cb->total_metadata_size(), oopSize);
78 return size;
79 }
82 // Creates a simple CodeBlob. Sets up the size of the different regions.
83 CodeBlob::CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size) {
84 assert(size == round_to(size, oopSize), "unaligned size");
85 assert(locs_size == round_to(locs_size, oopSize), "unaligned size");
86 assert(header_size == round_to(header_size, oopSize), "unaligned size");
87 assert(!UseRelocIndex, "no space allocated for reloc index yet");
89 // Note: If UseRelocIndex is enabled, there needs to be (at least) one
90 // extra word for the relocation information, containing the reloc
91 // index table length. Unfortunately, the reloc index table imple-
92 // mentation is not easily understandable and thus it is not clear
93 // what exactly the format is supposed to be. For now, we just turn
94 // off the use of this table (gri 7/6/2000).
96 _name = name;
97 _size = size;
98 _frame_complete_offset = frame_complete;
99 _header_size = header_size;
100 _relocation_size = locs_size;
101 _content_offset = align_code_offset(header_size + _relocation_size);
102 _code_offset = _content_offset;
103 _data_offset = size;
104 _frame_size = 0;
105 set_oop_maps(NULL);
106 }
109 // Creates a CodeBlob from a CodeBuffer. Sets up the size of the different regions,
110 // and copy code and relocation info.
111 CodeBlob::CodeBlob(
112 const char* name,
113 CodeBuffer* cb,
114 int header_size,
115 int size,
116 int frame_complete,
117 int frame_size,
118 OopMapSet* oop_maps
119 ) {
120 assert(size == round_to(size, oopSize), "unaligned size");
121 assert(header_size == round_to(header_size, oopSize), "unaligned size");
123 _name = name;
124 _size = size;
125 _frame_complete_offset = frame_complete;
126 _header_size = header_size;
127 _relocation_size = round_to(cb->total_relocation_size(), oopSize);
128 _content_offset = align_code_offset(header_size + _relocation_size);
129 _code_offset = _content_offset + cb->total_offset_of(cb->insts());
130 _data_offset = _content_offset + round_to(cb->total_content_size(), oopSize);
131 assert(_data_offset <= size, "codeBlob is too small");
133 cb->copy_code_and_locs_to(this);
134 set_oop_maps(oop_maps);
135 _frame_size = frame_size;
136 #ifdef COMPILER1
137 // probably wrong for tiered
138 assert(_frame_size >= -1, "must use frame size or -1 for runtime stubs");
139 #endif // COMPILER1
140 }
143 void CodeBlob::set_oop_maps(OopMapSet* p) {
144 // Danger Will Robinson! This method allocates a big
145 // chunk of memory, its your job to free it.
146 if (p != NULL) {
147 // We need to allocate a chunk big enough to hold the OopMapSet and all of its OopMaps
148 _oop_maps = (OopMapSet* )NEW_C_HEAP_ARRAY(unsigned char, p->heap_size(), mtCode);
149 p->copy_to((address)_oop_maps);
150 } else {
151 _oop_maps = NULL;
152 }
153 }
156 void CodeBlob::trace_new_stub(CodeBlob* stub, const char* name1, const char* name2) {
157 // Do not hold the CodeCache lock during name formatting.
158 assert(!CodeCache_lock->owned_by_self(), "release CodeCache before registering the stub");
160 if (stub != NULL) {
161 char stub_id[256];
162 assert(strlen(name1) + strlen(name2) < sizeof(stub_id), "");
163 jio_snprintf(stub_id, sizeof(stub_id), "%s%s", name1, name2);
164 if (PrintStubCode) {
165 ttyLocker ttyl;
166 tty->print_cr("Decoding %s " INTPTR_FORMAT, stub_id, (intptr_t) stub);
167 Disassembler::decode(stub->code_begin(), stub->code_end());
168 tty->cr();
169 }
170 Forte::register_stub(stub_id, stub->code_begin(), stub->code_end());
172 if (JvmtiExport::should_post_dynamic_code_generated()) {
173 const char* stub_name = name2;
174 if (name2[0] == '\0') stub_name = name1;
175 JvmtiExport::post_dynamic_code_generated(stub_name, stub->code_begin(), stub->code_end());
176 }
177 }
179 // Track memory usage statistic after releasing CodeCache_lock
180 MemoryService::track_code_cache_memory_usage();
181 }
184 void CodeBlob::flush() {
185 if (_oop_maps) {
186 FREE_C_HEAP_ARRAY(unsigned char, _oop_maps, mtCode);
187 _oop_maps = NULL;
188 }
189 _comments.free();
190 }
193 OopMap* CodeBlob::oop_map_for_return_address(address return_address) {
194 assert(oop_maps() != NULL, "nope");
195 return oop_maps()->find_map_at_offset((intptr_t) return_address - (intptr_t) code_begin());
196 }
199 //----------------------------------------------------------------------------------------------------
200 // Implementation of BufferBlob
203 BufferBlob::BufferBlob(const char* name, int size)
204 : CodeBlob(name, sizeof(BufferBlob), size, CodeOffsets::frame_never_safe, /*locs_size:*/ 0)
205 {}
207 BufferBlob* BufferBlob::create(const char* name, int buffer_size) {
208 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
210 BufferBlob* blob = NULL;
211 unsigned int size = sizeof(BufferBlob);
212 // align the size to CodeEntryAlignment
213 size = align_code_offset(size);
214 size += round_to(buffer_size, oopSize);
215 assert(name != NULL, "must provide a name");
216 {
217 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
218 blob = new (size) BufferBlob(name, size);
219 }
220 // Track memory usage statistic after releasing CodeCache_lock
221 MemoryService::track_code_cache_memory_usage();
223 return blob;
224 }
227 BufferBlob::BufferBlob(const char* name, int size, CodeBuffer* cb)
228 : CodeBlob(name, cb, sizeof(BufferBlob), size, CodeOffsets::frame_never_safe, 0, NULL)
229 {}
231 BufferBlob* BufferBlob::create(const char* name, CodeBuffer* cb) {
232 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
234 BufferBlob* blob = NULL;
235 unsigned int size = allocation_size(cb, sizeof(BufferBlob));
236 assert(name != NULL, "must provide a name");
237 {
238 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
239 blob = new (size) BufferBlob(name, size, cb);
240 }
241 // Track memory usage statistic after releasing CodeCache_lock
242 MemoryService::track_code_cache_memory_usage();
244 return blob;
245 }
248 void* BufferBlob::operator new(size_t s, unsigned size) {
249 void* p = CodeCache::allocate(size);
250 return p;
251 }
254 void BufferBlob::free( BufferBlob *blob ) {
255 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
256 {
257 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
258 CodeCache::free((CodeBlob*)blob);
259 }
260 // Track memory usage statistic after releasing CodeCache_lock
261 MemoryService::track_code_cache_memory_usage();
262 }
265 //----------------------------------------------------------------------------------------------------
266 // Implementation of AdapterBlob
268 AdapterBlob::AdapterBlob(int size, CodeBuffer* cb) :
269 BufferBlob("I2C/C2I adapters", size, cb) {
270 CodeCache::commit(this);
271 }
273 AdapterBlob* AdapterBlob::create(CodeBuffer* cb) {
274 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
276 AdapterBlob* blob = NULL;
277 unsigned int size = allocation_size(cb, sizeof(AdapterBlob));
278 {
279 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
280 blob = new (size) AdapterBlob(size, cb);
281 }
282 // Track memory usage statistic after releasing CodeCache_lock
283 MemoryService::track_code_cache_memory_usage();
285 return blob;
286 }
289 //----------------------------------------------------------------------------------------------------
290 // Implementation of MethodHandlesAdapterBlob
292 MethodHandlesAdapterBlob* MethodHandlesAdapterBlob::create(int buffer_size) {
293 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
295 MethodHandlesAdapterBlob* blob = NULL;
296 unsigned int size = sizeof(MethodHandlesAdapterBlob);
297 // align the size to CodeEntryAlignment
298 size = align_code_offset(size);
299 size += round_to(buffer_size, oopSize);
300 {
301 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
302 blob = new (size) MethodHandlesAdapterBlob(size);
303 }
304 // Track memory usage statistic after releasing CodeCache_lock
305 MemoryService::track_code_cache_memory_usage();
307 return blob;
308 }
311 //----------------------------------------------------------------------------------------------------
312 // Implementation of RuntimeStub
314 RuntimeStub::RuntimeStub(
315 const char* name,
316 CodeBuffer* cb,
317 int size,
318 int frame_complete,
319 int frame_size,
320 OopMapSet* oop_maps,
321 bool caller_must_gc_arguments
322 )
323 : CodeBlob(name, cb, sizeof(RuntimeStub), size, frame_complete, frame_size, oop_maps)
324 {
325 _caller_must_gc_arguments = caller_must_gc_arguments;
326 }
329 RuntimeStub* RuntimeStub::new_runtime_stub(const char* stub_name,
330 CodeBuffer* cb,
331 int frame_complete,
332 int frame_size,
333 OopMapSet* oop_maps,
334 bool caller_must_gc_arguments)
335 {
336 RuntimeStub* stub = NULL;
337 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
338 {
339 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
340 unsigned int size = allocation_size(cb, sizeof(RuntimeStub));
341 stub = new (size) RuntimeStub(stub_name, cb, size, frame_complete, frame_size, oop_maps, caller_must_gc_arguments);
342 }
344 trace_new_stub(stub, "RuntimeStub - ", stub_name);
346 return stub;
347 }
350 void* RuntimeStub::operator new(size_t s, unsigned size) {
351 void* p = CodeCache::allocate(size);
352 if (!p) fatal("Initial size of CodeCache is too small");
353 return p;
354 }
356 // operator new shared by all singletons:
357 void* SingletonBlob::operator new(size_t s, unsigned size) {
358 void* p = CodeCache::allocate(size);
359 if (!p) fatal("Initial size of CodeCache is too small");
360 return p;
361 }
364 //----------------------------------------------------------------------------------------------------
365 // Implementation of DeoptimizationBlob
367 DeoptimizationBlob::DeoptimizationBlob(
368 CodeBuffer* cb,
369 int size,
370 OopMapSet* oop_maps,
371 int unpack_offset,
372 int unpack_with_exception_offset,
373 int unpack_with_reexecution_offset,
374 int frame_size
375 )
376 : SingletonBlob("DeoptimizationBlob", cb, sizeof(DeoptimizationBlob), size, frame_size, oop_maps)
377 {
378 _unpack_offset = unpack_offset;
379 _unpack_with_exception = unpack_with_exception_offset;
380 _unpack_with_reexecution = unpack_with_reexecution_offset;
381 #ifdef COMPILER1
382 _unpack_with_exception_in_tls = -1;
383 #endif
384 }
387 DeoptimizationBlob* DeoptimizationBlob::create(
388 CodeBuffer* cb,
389 OopMapSet* oop_maps,
390 int unpack_offset,
391 int unpack_with_exception_offset,
392 int unpack_with_reexecution_offset,
393 int frame_size)
394 {
395 DeoptimizationBlob* blob = NULL;
396 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
397 {
398 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
399 unsigned int size = allocation_size(cb, sizeof(DeoptimizationBlob));
400 blob = new (size) DeoptimizationBlob(cb,
401 size,
402 oop_maps,
403 unpack_offset,
404 unpack_with_exception_offset,
405 unpack_with_reexecution_offset,
406 frame_size);
407 }
409 trace_new_stub(blob, "DeoptimizationBlob");
411 return blob;
412 }
415 //----------------------------------------------------------------------------------------------------
416 // Implementation of UncommonTrapBlob
418 #ifdef COMPILER2
419 UncommonTrapBlob::UncommonTrapBlob(
420 CodeBuffer* cb,
421 int size,
422 OopMapSet* oop_maps,
423 int frame_size
424 )
425 : SingletonBlob("UncommonTrapBlob", cb, sizeof(UncommonTrapBlob), size, frame_size, oop_maps)
426 {}
429 UncommonTrapBlob* UncommonTrapBlob::create(
430 CodeBuffer* cb,
431 OopMapSet* oop_maps,
432 int frame_size)
433 {
434 UncommonTrapBlob* blob = NULL;
435 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
436 {
437 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
438 unsigned int size = allocation_size(cb, sizeof(UncommonTrapBlob));
439 blob = new (size) UncommonTrapBlob(cb, size, oop_maps, frame_size);
440 }
442 trace_new_stub(blob, "UncommonTrapBlob");
444 return blob;
445 }
448 #endif // COMPILER2
451 //----------------------------------------------------------------------------------------------------
452 // Implementation of ExceptionBlob
454 #ifdef COMPILER2
455 ExceptionBlob::ExceptionBlob(
456 CodeBuffer* cb,
457 int size,
458 OopMapSet* oop_maps,
459 int frame_size
460 )
461 : SingletonBlob("ExceptionBlob", cb, sizeof(ExceptionBlob), size, frame_size, oop_maps)
462 {}
465 ExceptionBlob* ExceptionBlob::create(
466 CodeBuffer* cb,
467 OopMapSet* oop_maps,
468 int frame_size)
469 {
470 ExceptionBlob* blob = NULL;
471 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
472 {
473 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
474 unsigned int size = allocation_size(cb, sizeof(ExceptionBlob));
475 blob = new (size) ExceptionBlob(cb, size, oop_maps, frame_size);
476 }
478 trace_new_stub(blob, "ExceptionBlob");
480 return blob;
481 }
484 #endif // COMPILER2
487 //----------------------------------------------------------------------------------------------------
488 // Implementation of SafepointBlob
490 SafepointBlob::SafepointBlob(
491 CodeBuffer* cb,
492 int size,
493 OopMapSet* oop_maps,
494 int frame_size
495 )
496 : SingletonBlob("SafepointBlob", cb, sizeof(SafepointBlob), size, frame_size, oop_maps)
497 {}
500 SafepointBlob* SafepointBlob::create(
501 CodeBuffer* cb,
502 OopMapSet* oop_maps,
503 int frame_size)
504 {
505 SafepointBlob* blob = NULL;
506 ThreadInVMfromUnknown __tiv; // get to VM state in case we block on CodeCache_lock
507 {
508 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
509 unsigned int size = allocation_size(cb, sizeof(SafepointBlob));
510 blob = new (size) SafepointBlob(cb, size, oop_maps, frame_size);
511 }
513 trace_new_stub(blob, "SafepointBlob");
515 return blob;
516 }
519 //----------------------------------------------------------------------------------------------------
520 // Verification and printing
522 void CodeBlob::verify() {
523 ShouldNotReachHere();
524 }
526 void CodeBlob::print_on(outputStream* st) const {
527 st->print_cr("[CodeBlob (" INTPTR_FORMAT ")]", this);
528 st->print_cr("Framesize: %d", _frame_size);
529 }
531 void CodeBlob::print_value_on(outputStream* st) const {
532 st->print_cr("[CodeBlob]");
533 }
535 void BufferBlob::verify() {
536 // unimplemented
537 }
539 void BufferBlob::print_on(outputStream* st) const {
540 CodeBlob::print_on(st);
541 print_value_on(st);
542 }
544 void BufferBlob::print_value_on(outputStream* st) const {
545 st->print_cr("BufferBlob (" INTPTR_FORMAT ") used for %s", this, name());
546 }
548 void RuntimeStub::verify() {
549 // unimplemented
550 }
552 void RuntimeStub::print_on(outputStream* st) const {
553 ttyLocker ttyl;
554 CodeBlob::print_on(st);
555 st->print("Runtime Stub (" INTPTR_FORMAT "): ", this);
556 st->print_cr(name());
557 Disassembler::decode((CodeBlob*)this, st);
558 }
560 void RuntimeStub::print_value_on(outputStream* st) const {
561 st->print("RuntimeStub (" INTPTR_FORMAT "): ", this); st->print(name());
562 }
564 void SingletonBlob::verify() {
565 // unimplemented
566 }
568 void SingletonBlob::print_on(outputStream* st) const {
569 ttyLocker ttyl;
570 CodeBlob::print_on(st);
571 st->print_cr(name());
572 Disassembler::decode((CodeBlob*)this, st);
573 }
575 void SingletonBlob::print_value_on(outputStream* st) const {
576 st->print_cr(name());
577 }
579 void DeoptimizationBlob::print_value_on(outputStream* st) const {
580 st->print_cr("Deoptimization (frame not available)");
581 }