Mercurial > jdk8-mips64-public > hotspot / file revision
src/share/vm/services/heapDumper.cpp@ebd6745380b9
src/share/vm/services/heapDumper.cpp
Fri, 04 Mar 2016 16:40:30 +0100
- author
- aeriksso
- date
- Fri, 04 Mar 2016 16:40:30 +0100
- changeset 8317
- ebd6745380b9
- parent 6680
- 78bbf4d43a14
- child 8420
- b5c3e9670fa0
- permissions
- -rw-r--r--
8129419: heapDumper.cpp: assert(length_in_bytes > 0) failed: nothing to copy
Reviewed-by: dsamersoff, dcubed
1 /*
2 * Copyright (c) 2005, 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 */
25 #include "precompiled.hpp"
26 #include "classfile/symbolTable.hpp"
27 #include "classfile/systemDictionary.hpp"
28 #include "classfile/vmSymbols.hpp"
29 #include "gc_implementation/shared/vmGCOperations.hpp"
30 #include "memory/gcLocker.inline.hpp"
31 #include "memory/genCollectedHeap.hpp"
32 #include "memory/universe.hpp"
33 #include "oops/objArrayKlass.hpp"
34 #include "runtime/javaCalls.hpp"
35 #include "runtime/jniHandles.hpp"
36 #include "runtime/reflectionUtils.hpp"
37 #include "runtime/vframe.hpp"
38 #include "runtime/vmThread.hpp"
39 #include "runtime/vm_operations.hpp"
40 #include "services/heapDumper.hpp"
41 #include "services/threadService.hpp"
42 #include "utilities/ostream.hpp"
43 #include "utilities/macros.hpp"
44 #if INCLUDE_ALL_GCS
45 #include "gc_implementation/parallelScavenge/parallelScavengeHeap.hpp"
46 #endif // INCLUDE_ALL_GCS
48 /*
49 * HPROF binary format - description copied from:
50 * src/share/demo/jvmti/hprof/hprof_io.c
51 *
52 *
53 * header "JAVA PROFILE 1.0.1" or "JAVA PROFILE 1.0.2"
54 * (0-terminated)
55 *
56 * u4 size of identifiers. Identifiers are used to represent
57 * UTF8 strings, objects, stack traces, etc. They usually
58 * have the same size as host pointers. For example, on
59 * Solaris and Win32, the size is 4.
60 * u4 high word
61 * u4 low word number of milliseconds since 0:00 GMT, 1/1/70
62 * [record]* a sequence of records.
63 *
64 *
65 * Record format:
66 *
67 * u1 a TAG denoting the type of the record
68 * u4 number of *microseconds* since the time stamp in the
69 * header. (wraps around in a little more than an hour)
70 * u4 number of bytes *remaining* in the record. Note that
71 * this number excludes the tag and the length field itself.
72 * [u1]* BODY of the record (a sequence of bytes)
73 *
74 *
75 * The following TAGs are supported:
76 *
77 * TAG BODY notes
78 *----------------------------------------------------------
79 * HPROF_UTF8 a UTF8-encoded name
80 *
81 * id name ID
82 * [u1]* UTF8 characters (no trailing zero)
83 *
84 * HPROF_LOAD_CLASS a newly loaded class
85 *
86 * u4 class serial number (> 0)
87 * id class object ID
88 * u4 stack trace serial number
89 * id class name ID
90 *
91 * HPROF_UNLOAD_CLASS an unloading class
92 *
93 * u4 class serial_number
94 *
95 * HPROF_FRAME a Java stack frame
96 *
97 * id stack frame ID
98 * id method name ID
99 * id method signature ID
100 * id source file name ID
101 * u4 class serial number
102 * i4 line number. >0: normal
103 * -1: unknown
104 * -2: compiled method
105 * -3: native method
106 *
107 * HPROF_TRACE a Java stack trace
108 *
109 * u4 stack trace serial number
110 * u4 thread serial number
111 * u4 number of frames
112 * [id]* stack frame IDs
113 *
114 *
115 * HPROF_ALLOC_SITES a set of heap allocation sites, obtained after GC
116 *
117 * u2 flags 0x0001: incremental vs. complete
118 * 0x0002: sorted by allocation vs. live
119 * 0x0004: whether to force a GC
120 * u4 cutoff ratio
121 * u4 total live bytes
122 * u4 total live instances
123 * u8 total bytes allocated
124 * u8 total instances allocated
125 * u4 number of sites that follow
126 * [u1 is_array: 0: normal object
127 * 2: object array
128 * 4: boolean array
129 * 5: char array
130 * 6: float array
131 * 7: double array
132 * 8: byte array
133 * 9: short array
134 * 10: int array
135 * 11: long array
136 * u4 class serial number (may be zero during startup)
137 * u4 stack trace serial number
138 * u4 number of bytes alive
139 * u4 number of instances alive
140 * u4 number of bytes allocated
141 * u4]* number of instance allocated
142 *
143 * HPROF_START_THREAD a newly started thread.
144 *
145 * u4 thread serial number (> 0)
146 * id thread object ID
147 * u4 stack trace serial number
148 * id thread name ID
149 * id thread group name ID
150 * id thread group parent name ID
151 *
152 * HPROF_END_THREAD a terminating thread.
153 *
154 * u4 thread serial number
155 *
156 * HPROF_HEAP_SUMMARY heap summary
157 *
158 * u4 total live bytes
159 * u4 total live instances
160 * u8 total bytes allocated
161 * u8 total instances allocated
162 *
163 * HPROF_HEAP_DUMP denote a heap dump
164 *
165 * [heap dump sub-records]*
166 *
167 * There are four kinds of heap dump sub-records:
168 *
169 * u1 sub-record type
170 *
171 * HPROF_GC_ROOT_UNKNOWN unknown root
172 *
173 * id object ID
174 *
175 * HPROF_GC_ROOT_THREAD_OBJ thread object
176 *
177 * id thread object ID (may be 0 for a
178 * thread newly attached through JNI)
179 * u4 thread sequence number
180 * u4 stack trace sequence number
181 *
182 * HPROF_GC_ROOT_JNI_GLOBAL JNI global ref root
183 *
184 * id object ID
185 * id JNI global ref ID
186 *
187 * HPROF_GC_ROOT_JNI_LOCAL JNI local ref
188 *
189 * id object ID
190 * u4 thread serial number
191 * u4 frame # in stack trace (-1 for empty)
192 *
193 * HPROF_GC_ROOT_JAVA_FRAME Java stack frame
194 *
195 * id object ID
196 * u4 thread serial number
197 * u4 frame # in stack trace (-1 for empty)
198 *
199 * HPROF_GC_ROOT_NATIVE_STACK Native stack
200 *
201 * id object ID
202 * u4 thread serial number
203 *
204 * HPROF_GC_ROOT_STICKY_CLASS System class
205 *
206 * id object ID
207 *
208 * HPROF_GC_ROOT_THREAD_BLOCK Reference from thread block
209 *
210 * id object ID
211 * u4 thread serial number
212 *
213 * HPROF_GC_ROOT_MONITOR_USED Busy monitor
214 *
215 * id object ID
216 *
217 * HPROF_GC_CLASS_DUMP dump of a class object
218 *
219 * id class object ID
220 * u4 stack trace serial number
221 * id super class object ID
222 * id class loader object ID
223 * id signers object ID
224 * id protection domain object ID
225 * id reserved
226 * id reserved
227 *
228 * u4 instance size (in bytes)
229 *
230 * u2 size of constant pool
231 * [u2, constant pool index,
232 * ty, type
233 * 2: object
234 * 4: boolean
235 * 5: char
236 * 6: float
237 * 7: double
238 * 8: byte
239 * 9: short
240 * 10: int
241 * 11: long
242 * vl]* and value
243 *
244 * u2 number of static fields
245 * [id, static field name,
246 * ty, type,
247 * vl]* and value
248 *
249 * u2 number of inst. fields (not inc. super)
250 * [id, instance field name,
251 * ty]* type
252 *
253 * HPROF_GC_INSTANCE_DUMP dump of a normal object
254 *
255 * id object ID
256 * u4 stack trace serial number
257 * id class object ID
258 * u4 number of bytes that follow
259 * [vl]* instance field values (class, followed
260 * by super, super's super ...)
261 *
262 * HPROF_GC_OBJ_ARRAY_DUMP dump of an object array
263 *
264 * id array object ID
265 * u4 stack trace serial number
266 * u4 number of elements
267 * id array class ID
268 * [id]* elements
269 *
270 * HPROF_GC_PRIM_ARRAY_DUMP dump of a primitive array
271 *
272 * id array object ID
273 * u4 stack trace serial number
274 * u4 number of elements
275 * u1 element type
276 * 4: boolean array
277 * 5: char array
278 * 6: float array
279 * 7: double array
280 * 8: byte array
281 * 9: short array
282 * 10: int array
283 * 11: long array
284 * [u1]* elements
285 *
286 * HPROF_CPU_SAMPLES a set of sample traces of running threads
287 *
288 * u4 total number of samples
289 * u4 # of traces
290 * [u4 # of samples
291 * u4]* stack trace serial number
292 *
293 * HPROF_CONTROL_SETTINGS the settings of on/off switches
294 *
295 * u4 0x00000001: alloc traces on/off
296 * 0x00000002: cpu sampling on/off
297 * u2 stack trace depth
298 *
299 *
300 * When the header is "JAVA PROFILE 1.0.2" a heap dump can optionally
301 * be generated as a sequence of heap dump segments. This sequence is
302 * terminated by an end record. The additional tags allowed by format
303 * "JAVA PROFILE 1.0.2" are:
304 *
305 * HPROF_HEAP_DUMP_SEGMENT denote a heap dump segment
306 *
307 * [heap dump sub-records]*
308 * The same sub-record types allowed by HPROF_HEAP_DUMP
309 *
310 * HPROF_HEAP_DUMP_END denotes the end of a heap dump
311 *
312 */
315 // HPROF tags
317 typedef enum {
318 // top-level records
319 HPROF_UTF8 = 0x01,
320 HPROF_LOAD_CLASS = 0x02,
321 HPROF_UNLOAD_CLASS = 0x03,
322 HPROF_FRAME = 0x04,
323 HPROF_TRACE = 0x05,
324 HPROF_ALLOC_SITES = 0x06,
325 HPROF_HEAP_SUMMARY = 0x07,
326 HPROF_START_THREAD = 0x0A,
327 HPROF_END_THREAD = 0x0B,
328 HPROF_HEAP_DUMP = 0x0C,
329 HPROF_CPU_SAMPLES = 0x0D,
330 HPROF_CONTROL_SETTINGS = 0x0E,
332 // 1.0.2 record types
333 HPROF_HEAP_DUMP_SEGMENT = 0x1C,
334 HPROF_HEAP_DUMP_END = 0x2C,
336 // field types
337 HPROF_ARRAY_OBJECT = 0x01,
338 HPROF_NORMAL_OBJECT = 0x02,
339 HPROF_BOOLEAN = 0x04,
340 HPROF_CHAR = 0x05,
341 HPROF_FLOAT = 0x06,
342 HPROF_DOUBLE = 0x07,
343 HPROF_BYTE = 0x08,
344 HPROF_SHORT = 0x09,
345 HPROF_INT = 0x0A,
346 HPROF_LONG = 0x0B,
348 // data-dump sub-records
349 HPROF_GC_ROOT_UNKNOWN = 0xFF,
350 HPROF_GC_ROOT_JNI_GLOBAL = 0x01,
351 HPROF_GC_ROOT_JNI_LOCAL = 0x02,
352 HPROF_GC_ROOT_JAVA_FRAME = 0x03,
353 HPROF_GC_ROOT_NATIVE_STACK = 0x04,
354 HPROF_GC_ROOT_STICKY_CLASS = 0x05,
355 HPROF_GC_ROOT_THREAD_BLOCK = 0x06,
356 HPROF_GC_ROOT_MONITOR_USED = 0x07,
357 HPROF_GC_ROOT_THREAD_OBJ = 0x08,
358 HPROF_GC_CLASS_DUMP = 0x20,
359 HPROF_GC_INSTANCE_DUMP = 0x21,
360 HPROF_GC_OBJ_ARRAY_DUMP = 0x22,
361 HPROF_GC_PRIM_ARRAY_DUMP = 0x23
362 } hprofTag;
364 // Default stack trace ID (used for dummy HPROF_TRACE record)
365 enum {
366 STACK_TRACE_ID = 1,
367 INITIAL_CLASS_COUNT = 200
368 };
370 // Supports I/O operations on a dump file
372 class DumpWriter : public StackObj {
373 private:
374 enum {
375 io_buffer_size = 8*M
376 };
378 int _fd; // file descriptor (-1 if dump file not open)
379 julong _bytes_written; // number of byte written to dump file
381 char* _buffer; // internal buffer
382 size_t _size;
383 size_t _pos;
385 char* _error; // error message when I/O fails
387 void set_file_descriptor(int fd) { _fd = fd; }
388 int file_descriptor() const { return _fd; }
390 char* buffer() const { return _buffer; }
391 size_t buffer_size() const { return _size; }
392 size_t position() const { return _pos; }
393 void set_position(size_t pos) { _pos = pos; }
395 void set_error(const char* error) { _error = (char*)os::strdup(error); }
397 // all I/O go through this function
398 void write_internal(void* s, size_t len);
400 public:
401 DumpWriter(const char* path);
402 ~DumpWriter();
404 void close();
405 bool is_open() const { return file_descriptor() >= 0; }
406 void flush();
408 // total number of bytes written to the disk
409 julong bytes_written() const { return _bytes_written; }
411 // adjust the number of bytes written to disk (used to keep the count
412 // of the number of bytes written in case of rewrites)
413 void adjust_bytes_written(jlong n) { _bytes_written += n; }
415 // number of (buffered) bytes as yet unwritten to the dump file
416 size_t bytes_unwritten() const { return position(); }
418 char* error() const { return _error; }
420 jlong current_offset();
421 void seek_to_offset(jlong pos);
423 // writer functions
424 void write_raw(void* s, size_t len);
425 void write_u1(u1 x) { write_raw((void*)&x, 1); }
426 void write_u2(u2 x);
427 void write_u4(u4 x);
428 void write_u8(u8 x);
429 void write_objectID(oop o);
430 void write_symbolID(Symbol* o);
431 void write_classID(Klass* k);
432 void write_id(u4 x);
433 };
435 DumpWriter::DumpWriter(const char* path) {
436 // try to allocate an I/O buffer of io_buffer_size. If there isn't
437 // sufficient memory then reduce size until we can allocate something.
438 _size = io_buffer_size;
439 do {
440 _buffer = (char*)os::malloc(_size, mtInternal);
441 if (_buffer == NULL) {
442 _size = _size >> 1;
443 }
444 } while (_buffer == NULL && _size > 0);
445 assert((_size > 0 && _buffer != NULL) || (_size == 0 && _buffer == NULL), "sanity check");
446 _pos = 0;
447 _error = NULL;
448 _bytes_written = 0L;
449 _fd = os::create_binary_file(path, false); // don't replace existing file
451 // if the open failed we record the error
452 if (_fd < 0) {
453 _error = (char*)os::strdup(strerror(errno));
454 }
455 }
457 DumpWriter::~DumpWriter() {
458 // flush and close dump file
459 if (is_open()) {
460 close();
461 }
462 if (_buffer != NULL) os::free(_buffer);
463 if (_error != NULL) os::free(_error);
464 }
466 // closes dump file (if open)
467 void DumpWriter::close() {
468 // flush and close dump file
469 if (is_open()) {
470 flush();
471 os::close(file_descriptor());
472 set_file_descriptor(-1);
473 }
474 }
476 // write directly to the file
477 void DumpWriter::write_internal(void* s, size_t len) {
478 if (is_open()) {
479 const char* pos = (char*)s;
480 ssize_t n = 0;
481 while (len > 0) {
482 uint tmp = (uint)MIN2(len, (size_t)UINT_MAX);
483 n = os::write(file_descriptor(), pos, tmp);
485 if (n < 0) {
486 // EINTR cannot happen here, os::write will take care of that
487 set_error(strerror(errno));
488 os::close(file_descriptor());
489 set_file_descriptor(-1);
490 return;
491 }
493 _bytes_written += n;
494 pos += n;
495 len -= n;
496 }
497 }
498 }
500 // write raw bytes
501 void DumpWriter::write_raw(void* s, size_t len) {
502 if (is_open()) {
503 // flush buffer to make room
504 if ((position() + len) >= buffer_size()) {
505 flush();
506 }
508 // buffer not available or too big to buffer it
509 if ((buffer() == NULL) || (len >= buffer_size())) {
510 write_internal(s, len);
511 } else {
512 // Should optimize this for u1/u2/u4/u8 sizes.
513 memcpy(buffer() + position(), s, len);
514 set_position(position() + len);
515 }
516 }
517 }
519 // flush any buffered bytes to the file
520 void DumpWriter::flush() {
521 if (is_open() && position() > 0) {
522 write_internal(buffer(), position());
523 set_position(0);
524 }
525 }
527 jlong DumpWriter::current_offset() {
528 if (is_open()) {
529 // the offset is the file offset plus whatever we have buffered
530 jlong offset = os::current_file_offset(file_descriptor());
531 assert(offset >= 0, "lseek failed");
532 return offset + position();
533 } else {
534 return (jlong)-1;
535 }
536 }
538 void DumpWriter::seek_to_offset(jlong off) {
539 assert(off >= 0, "bad offset");
541 // need to flush before seeking
542 flush();
544 // may be closed due to I/O error
545 if (is_open()) {
546 jlong n = os::seek_to_file_offset(file_descriptor(), off);
547 assert(n >= 0, "lseek failed");
548 }
549 }
551 void DumpWriter::write_u2(u2 x) {
552 u2 v;
553 Bytes::put_Java_u2((address)&v, x);
554 write_raw((void*)&v, 2);
555 }
557 void DumpWriter::write_u4(u4 x) {
558 u4 v;
559 Bytes::put_Java_u4((address)&v, x);
560 write_raw((void*)&v, 4);
561 }
563 void DumpWriter::write_u8(u8 x) {
564 u8 v;
565 Bytes::put_Java_u8((address)&v, x);
566 write_raw((void*)&v, 8);
567 }
569 void DumpWriter::write_objectID(oop o) {
570 address a = (address)o;
571 #ifdef _LP64
572 write_u8((u8)a);
573 #else
574 write_u4((u4)a);
575 #endif
576 }
578 void DumpWriter::write_symbolID(Symbol* s) {
579 address a = (address)((uintptr_t)s);
580 #ifdef _LP64
581 write_u8((u8)a);
582 #else
583 write_u4((u4)a);
584 #endif
585 }
587 void DumpWriter::write_id(u4 x) {
588 #ifdef _LP64
589 write_u8((u8) x);
590 #else
591 write_u4(x);
592 #endif
593 }
595 // We use java mirror as the class ID
596 void DumpWriter::write_classID(Klass* k) {
597 write_objectID(k->java_mirror());
598 }
602 // Support class with a collection of functions used when dumping the heap
604 class DumperSupport : AllStatic {
605 public:
607 // write a header of the given type
608 static void write_header(DumpWriter* writer, hprofTag tag, u4 len);
610 // returns hprof tag for the given type signature
611 static hprofTag sig2tag(Symbol* sig);
612 // returns hprof tag for the given basic type
613 static hprofTag type2tag(BasicType type);
615 // returns the size of the instance of the given class
616 static u4 instance_size(Klass* k);
618 // dump a jfloat
619 static void dump_float(DumpWriter* writer, jfloat f);
620 // dump a jdouble
621 static void dump_double(DumpWriter* writer, jdouble d);
622 // dumps the raw value of the given field
623 static void dump_field_value(DumpWriter* writer, char type, address addr);
624 // dumps static fields of the given class
625 static void dump_static_fields(DumpWriter* writer, Klass* k);
626 // dump the raw values of the instance fields of the given object
627 static void dump_instance_fields(DumpWriter* writer, oop o);
628 // dumps the definition of the instance fields for a given class
629 static void dump_instance_field_descriptors(DumpWriter* writer, Klass* k);
630 // creates HPROF_GC_INSTANCE_DUMP record for the given object
631 static void dump_instance(DumpWriter* writer, oop o);
632 // creates HPROF_GC_CLASS_DUMP record for the given class and each of its
633 // array classes
634 static void dump_class_and_array_classes(DumpWriter* writer, Klass* k);
635 // creates HPROF_GC_CLASS_DUMP record for a given primitive array
636 // class (and each multi-dimensional array class too)
637 static void dump_basic_type_array_class(DumpWriter* writer, Klass* k);
639 // creates HPROF_GC_OBJ_ARRAY_DUMP record for the given object array
640 static void dump_object_array(DumpWriter* writer, objArrayOop array);
641 // creates HPROF_GC_PRIM_ARRAY_DUMP record for the given type array
642 static void dump_prim_array(DumpWriter* writer, typeArrayOop array);
643 // create HPROF_FRAME record for the given method and bci
644 static void dump_stack_frame(DumpWriter* writer, int frame_serial_num, int class_serial_num, Method* m, int bci);
645 };
647 // write a header of the given type
648 void DumperSupport:: write_header(DumpWriter* writer, hprofTag tag, u4 len) {
649 writer->write_u1((u1)tag);
650 writer->write_u4(0); // current ticks
651 writer->write_u4(len);
652 }
654 // returns hprof tag for the given type signature
655 hprofTag DumperSupport::sig2tag(Symbol* sig) {
656 switch (sig->byte_at(0)) {
657 case JVM_SIGNATURE_CLASS : return HPROF_NORMAL_OBJECT;
658 case JVM_SIGNATURE_ARRAY : return HPROF_NORMAL_OBJECT;
659 case JVM_SIGNATURE_BYTE : return HPROF_BYTE;
660 case JVM_SIGNATURE_CHAR : return HPROF_CHAR;
661 case JVM_SIGNATURE_FLOAT : return HPROF_FLOAT;
662 case JVM_SIGNATURE_DOUBLE : return HPROF_DOUBLE;
663 case JVM_SIGNATURE_INT : return HPROF_INT;
664 case JVM_SIGNATURE_LONG : return HPROF_LONG;
665 case JVM_SIGNATURE_SHORT : return HPROF_SHORT;
666 case JVM_SIGNATURE_BOOLEAN : return HPROF_BOOLEAN;
667 default : ShouldNotReachHere(); /* to shut up compiler */ return HPROF_BYTE;
668 }
669 }
671 hprofTag DumperSupport::type2tag(BasicType type) {
672 switch (type) {
673 case T_BYTE : return HPROF_BYTE;
674 case T_CHAR : return HPROF_CHAR;
675 case T_FLOAT : return HPROF_FLOAT;
676 case T_DOUBLE : return HPROF_DOUBLE;
677 case T_INT : return HPROF_INT;
678 case T_LONG : return HPROF_LONG;
679 case T_SHORT : return HPROF_SHORT;
680 case T_BOOLEAN : return HPROF_BOOLEAN;
681 default : ShouldNotReachHere(); /* to shut up compiler */ return HPROF_BYTE;
682 }
683 }
685 // dump a jfloat
686 void DumperSupport::dump_float(DumpWriter* writer, jfloat f) {
687 if (g_isnan(f)) {
688 writer->write_u4(0x7fc00000); // collapsing NaNs
689 } else {
690 union {
691 int i;
692 float f;
693 } u;
694 u.f = (float)f;
695 writer->write_u4((u4)u.i);
696 }
697 }
699 // dump a jdouble
700 void DumperSupport::dump_double(DumpWriter* writer, jdouble d) {
701 union {
702 jlong l;
703 double d;
704 } u;
705 if (g_isnan(d)) { // collapsing NaNs
706 u.l = (jlong)(0x7ff80000);
707 u.l = (u.l << 32);
708 } else {
709 u.d = (double)d;
710 }
711 writer->write_u8((u8)u.l);
712 }
714 // dumps the raw value of the given field
715 void DumperSupport::dump_field_value(DumpWriter* writer, char type, address addr) {
716 switch (type) {
717 case JVM_SIGNATURE_CLASS :
718 case JVM_SIGNATURE_ARRAY : {
719 oop o;
720 if (UseCompressedOops) {
721 o = oopDesc::load_decode_heap_oop((narrowOop*)addr);
722 } else {
723 o = oopDesc::load_decode_heap_oop((oop*)addr);
724 }
726 // reflection and sun.misc.Unsafe classes may have a reference to a
727 // Klass* so filter it out.
728 assert(o->is_oop_or_null(), "should always be an oop");
729 writer->write_objectID(o);
730 break;
731 }
732 case JVM_SIGNATURE_BYTE : {
733 jbyte* b = (jbyte*)addr;
734 writer->write_u1((u1)*b);
735 break;
736 }
737 case JVM_SIGNATURE_CHAR : {
738 jchar* c = (jchar*)addr;
739 writer->write_u2((u2)*c);
740 break;
741 }
742 case JVM_SIGNATURE_SHORT : {
743 jshort* s = (jshort*)addr;
744 writer->write_u2((u2)*s);
745 break;
746 }
747 case JVM_SIGNATURE_FLOAT : {
748 jfloat* f = (jfloat*)addr;
749 dump_float(writer, *f);
750 break;
751 }
752 case JVM_SIGNATURE_DOUBLE : {
753 jdouble* f = (jdouble*)addr;
754 dump_double(writer, *f);
755 break;
756 }
757 case JVM_SIGNATURE_INT : {
758 jint* i = (jint*)addr;
759 writer->write_u4((u4)*i);
760 break;
761 }
762 case JVM_SIGNATURE_LONG : {
763 jlong* l = (jlong*)addr;
764 writer->write_u8((u8)*l);
765 break;
766 }
767 case JVM_SIGNATURE_BOOLEAN : {
768 jboolean* b = (jboolean*)addr;
769 writer->write_u1((u1)*b);
770 break;
771 }
772 default : ShouldNotReachHere();
773 }
774 }
776 // returns the size of the instance of the given class
777 u4 DumperSupport::instance_size(Klass* k) {
778 HandleMark hm;
779 instanceKlassHandle ikh = instanceKlassHandle(Thread::current(), k);
781 u4 size = 0;
783 for (FieldStream fld(ikh, false, false); !fld.eos(); fld.next()) {
784 if (!fld.access_flags().is_static()) {
785 Symbol* sig = fld.signature();
786 switch (sig->byte_at(0)) {
787 case JVM_SIGNATURE_CLASS :
788 case JVM_SIGNATURE_ARRAY : size += oopSize; break;
790 case JVM_SIGNATURE_BYTE :
791 case JVM_SIGNATURE_BOOLEAN : size += 1; break;
793 case JVM_SIGNATURE_CHAR :
794 case JVM_SIGNATURE_SHORT : size += 2; break;
796 case JVM_SIGNATURE_INT :
797 case JVM_SIGNATURE_FLOAT : size += 4; break;
799 case JVM_SIGNATURE_LONG :
800 case JVM_SIGNATURE_DOUBLE : size += 8; break;
802 default : ShouldNotReachHere();
803 }
804 }
805 }
806 return size;
807 }
809 // dumps static fields of the given class
810 void DumperSupport::dump_static_fields(DumpWriter* writer, Klass* k) {
811 HandleMark hm;
812 instanceKlassHandle ikh = instanceKlassHandle(Thread::current(), k);
814 // pass 1 - count the static fields
815 u2 field_count = 0;
816 for (FieldStream fldc(ikh, true, true); !fldc.eos(); fldc.next()) {
817 if (fldc.access_flags().is_static()) field_count++;
818 }
820 writer->write_u2(field_count);
822 // pass 2 - dump the field descriptors and raw values
823 for (FieldStream fld(ikh, true, true); !fld.eos(); fld.next()) {
824 if (fld.access_flags().is_static()) {
825 Symbol* sig = fld.signature();
827 writer->write_symbolID(fld.name()); // name
828 writer->write_u1(sig2tag(sig)); // type
830 // value
831 int offset = fld.offset();
832 address addr = (address)ikh->java_mirror() + offset;
834 dump_field_value(writer, sig->byte_at(0), addr);
835 }
836 }
837 }
839 // dump the raw values of the instance fields of the given object
840 void DumperSupport::dump_instance_fields(DumpWriter* writer, oop o) {
841 HandleMark hm;
842 instanceKlassHandle ikh = instanceKlassHandle(Thread::current(), o->klass());
844 for (FieldStream fld(ikh, false, false); !fld.eos(); fld.next()) {
845 if (!fld.access_flags().is_static()) {
846 Symbol* sig = fld.signature();
847 address addr = (address)o + fld.offset();
849 dump_field_value(writer, sig->byte_at(0), addr);
850 }
851 }
852 }
854 // dumps the definition of the instance fields for a given class
855 void DumperSupport::dump_instance_field_descriptors(DumpWriter* writer, Klass* k) {
856 HandleMark hm;
857 instanceKlassHandle ikh = instanceKlassHandle(Thread::current(), k);
859 // pass 1 - count the instance fields
860 u2 field_count = 0;
861 for (FieldStream fldc(ikh, true, true); !fldc.eos(); fldc.next()) {
862 if (!fldc.access_flags().is_static()) field_count++;
863 }
865 writer->write_u2(field_count);
867 // pass 2 - dump the field descriptors
868 for (FieldStream fld(ikh, true, true); !fld.eos(); fld.next()) {
869 if (!fld.access_flags().is_static()) {
870 Symbol* sig = fld.signature();
872 writer->write_symbolID(fld.name()); // name
873 writer->write_u1(sig2tag(sig)); // type
874 }
875 }
876 }
878 // creates HPROF_GC_INSTANCE_DUMP record for the given object
879 void DumperSupport::dump_instance(DumpWriter* writer, oop o) {
880 Klass* k = o->klass();
882 writer->write_u1(HPROF_GC_INSTANCE_DUMP);
883 writer->write_objectID(o);
884 writer->write_u4(STACK_TRACE_ID);
886 // class ID
887 writer->write_classID(k);
889 // number of bytes that follow
890 writer->write_u4(instance_size(k) );
892 // field values
893 dump_instance_fields(writer, o);
894 }
896 // creates HPROF_GC_CLASS_DUMP record for the given class and each of
897 // its array classes
898 void DumperSupport::dump_class_and_array_classes(DumpWriter* writer, Klass* k) {
899 Klass* klass = k;
900 assert(klass->oop_is_instance(), "not an InstanceKlass");
901 InstanceKlass* ik = (InstanceKlass*)klass;
903 writer->write_u1(HPROF_GC_CLASS_DUMP);
905 // class ID
906 writer->write_classID(ik);
907 writer->write_u4(STACK_TRACE_ID);
909 // super class ID
910 Klass* java_super = ik->java_super();
911 if (java_super == NULL) {
912 writer->write_objectID(oop(NULL));
913 } else {
914 writer->write_classID(java_super);
915 }
917 writer->write_objectID(ik->class_loader());
918 writer->write_objectID(ik->signers());
919 writer->write_objectID(ik->protection_domain());
921 // reserved
922 writer->write_objectID(oop(NULL));
923 writer->write_objectID(oop(NULL));
925 // instance size
926 writer->write_u4(DumperSupport::instance_size(k));
928 // size of constant pool - ignored by HAT 1.1
929 writer->write_u2(0);
931 // number of static fields
932 dump_static_fields(writer, k);
934 // description of instance fields
935 dump_instance_field_descriptors(writer, k);
937 // array classes
938 k = klass->array_klass_or_null();
939 while (k != NULL) {
940 Klass* klass = k;
941 assert(klass->oop_is_objArray(), "not an ObjArrayKlass");
943 writer->write_u1(HPROF_GC_CLASS_DUMP);
944 writer->write_classID(klass);
945 writer->write_u4(STACK_TRACE_ID);
947 // super class of array classes is java.lang.Object
948 java_super = klass->java_super();
949 assert(java_super != NULL, "checking");
950 writer->write_classID(java_super);
952 writer->write_objectID(ik->class_loader());
953 writer->write_objectID(ik->signers());
954 writer->write_objectID(ik->protection_domain());
956 writer->write_objectID(oop(NULL)); // reserved
957 writer->write_objectID(oop(NULL));
958 writer->write_u4(0); // instance size
959 writer->write_u2(0); // constant pool
960 writer->write_u2(0); // static fields
961 writer->write_u2(0); // instance fields
963 // get the array class for the next rank
964 k = klass->array_klass_or_null();
965 }
966 }
968 // creates HPROF_GC_CLASS_DUMP record for a given primitive array
969 // class (and each multi-dimensional array class too)
970 void DumperSupport::dump_basic_type_array_class(DumpWriter* writer, Klass* k) {
971 // array classes
972 while (k != NULL) {
973 Klass* klass = k;
975 writer->write_u1(HPROF_GC_CLASS_DUMP);
976 writer->write_classID(klass);
977 writer->write_u4(STACK_TRACE_ID);
979 // super class of array classes is java.lang.Object
980 Klass* java_super = klass->java_super();
981 assert(java_super != NULL, "checking");
982 writer->write_classID(java_super);
984 writer->write_objectID(oop(NULL)); // loader
985 writer->write_objectID(oop(NULL)); // signers
986 writer->write_objectID(oop(NULL)); // protection domain
988 writer->write_objectID(oop(NULL)); // reserved
989 writer->write_objectID(oop(NULL));
990 writer->write_u4(0); // instance size
991 writer->write_u2(0); // constant pool
992 writer->write_u2(0); // static fields
993 writer->write_u2(0); // instance fields
995 // get the array class for the next rank
996 k = klass->array_klass_or_null();
997 }
998 }
1000 // creates HPROF_GC_OBJ_ARRAY_DUMP record for the given object array
1001 void DumperSupport::dump_object_array(DumpWriter* writer, objArrayOop array) {
1003 writer->write_u1(HPROF_GC_OBJ_ARRAY_DUMP);
1004 writer->write_objectID(array);
1005 writer->write_u4(STACK_TRACE_ID);
1006 writer->write_u4((u4)array->length());
1008 // array class ID
1009 writer->write_classID(array->klass());
1011 // [id]* elements
1012 for (int index=0; index<array->length(); index++) {
1013 oop o = array->obj_at(index);
1014 writer->write_objectID(o);
1015 }
1016 }
1018 #define WRITE_ARRAY(Array, Type, Size) \
1019 for (int i=0; i<Array->length(); i++) { writer->write_##Size((Size)array->Type##_at(i)); }
1022 // creates HPROF_GC_PRIM_ARRAY_DUMP record for the given type array
1023 void DumperSupport::dump_prim_array(DumpWriter* writer, typeArrayOop array) {
1024 BasicType type = TypeArrayKlass::cast(array->klass())->element_type();
1026 writer->write_u1(HPROF_GC_PRIM_ARRAY_DUMP);
1027 writer->write_objectID(array);
1028 writer->write_u4(STACK_TRACE_ID);
1029 writer->write_u4((u4)array->length());
1030 writer->write_u1(type2tag(type));
1032 // nothing to copy
1033 if (array->length() == 0) {
1034 return;
1035 }
1037 // If the byte ordering is big endian then we can copy most types directly
1038 u4 length_in_bytes = (u4)array->length() * type2aelembytes(type);
1040 switch (type) {
1041 case T_INT : {
1042 if (Bytes::is_Java_byte_ordering_different()) {
1043 WRITE_ARRAY(array, int, u4);
1044 } else {
1045 writer->write_raw((void*)(array->int_at_addr(0)), length_in_bytes);
1046 }
1047 break;
1048 }
1049 case T_BYTE : {
1050 writer->write_raw((void*)(array->byte_at_addr(0)), length_in_bytes);
1051 break;
1052 }
1053 case T_CHAR : {
1054 if (Bytes::is_Java_byte_ordering_different()) {
1055 WRITE_ARRAY(array, char, u2);
1056 } else {
1057 writer->write_raw((void*)(array->char_at_addr(0)), length_in_bytes);
1058 }
1059 break;
1060 }
1061 case T_SHORT : {
1062 if (Bytes::is_Java_byte_ordering_different()) {
1063 WRITE_ARRAY(array, short, u2);
1064 } else {
1065 writer->write_raw((void*)(array->short_at_addr(0)), length_in_bytes);
1066 }
1067 break;
1068 }
1069 case T_BOOLEAN : {
1070 if (Bytes::is_Java_byte_ordering_different()) {
1071 WRITE_ARRAY(array, bool, u1);
1072 } else {
1073 writer->write_raw((void*)(array->bool_at_addr(0)), length_in_bytes);
1074 }
1075 break;
1076 }
1077 case T_LONG : {
1078 if (Bytes::is_Java_byte_ordering_different()) {
1079 WRITE_ARRAY(array, long, u8);
1080 } else {
1081 writer->write_raw((void*)(array->long_at_addr(0)), length_in_bytes);
1082 }
1083 break;
1084 }
1086 // handle float/doubles in a special value to ensure than NaNs are
1087 // written correctly. TO DO: Check if we can avoid this on processors that
1088 // use IEEE 754.
1090 case T_FLOAT : {
1091 for (int i=0; i<array->length(); i++) {
1092 dump_float( writer, array->float_at(i) );
1093 }
1094 break;
1095 }
1096 case T_DOUBLE : {
1097 for (int i=0; i<array->length(); i++) {
1098 dump_double( writer, array->double_at(i) );
1099 }
1100 break;
1101 }
1102 default : ShouldNotReachHere();
1103 }
1104 }
1106 // create a HPROF_FRAME record of the given Method* and bci
1107 void DumperSupport::dump_stack_frame(DumpWriter* writer,
1108 int frame_serial_num,
1109 int class_serial_num,
1110 Method* m,
1111 int bci) {
1112 int line_number;
1113 if (m->is_native()) {
1114 line_number = -3; // native frame
1115 } else {
1116 line_number = m->line_number_from_bci(bci);
1117 }
1119 write_header(writer, HPROF_FRAME, 4*oopSize + 2*sizeof(u4));
1120 writer->write_id(frame_serial_num); // frame serial number
1121 writer->write_symbolID(m->name()); // method's name
1122 writer->write_symbolID(m->signature()); // method's signature
1124 assert(m->method_holder()->oop_is_instance(), "not InstanceKlass");
1125 writer->write_symbolID(m->method_holder()->source_file_name()); // source file name
1126 writer->write_u4(class_serial_num); // class serial number
1127 writer->write_u4((u4) line_number); // line number
1128 }
1131 // Support class used to generate HPROF_UTF8 records from the entries in the
1132 // SymbolTable.
1134 class SymbolTableDumper : public SymbolClosure {
1135 private:
1136 DumpWriter* _writer;
1137 DumpWriter* writer() const { return _writer; }
1138 public:
1139 SymbolTableDumper(DumpWriter* writer) { _writer = writer; }
1140 void do_symbol(Symbol** p);
1141 };
1143 void SymbolTableDumper::do_symbol(Symbol** p) {
1144 ResourceMark rm;
1145 Symbol* sym = load_symbol(p);
1146 int len = sym->utf8_length();
1147 if (len > 0) {
1148 char* s = sym->as_utf8();
1149 DumperSupport::write_header(writer(), HPROF_UTF8, oopSize + len);
1150 writer()->write_symbolID(sym);
1151 writer()->write_raw(s, len);
1152 }
1153 }
1155 // Support class used to generate HPROF_GC_ROOT_JNI_LOCAL records
1157 class JNILocalsDumper : public OopClosure {
1158 private:
1159 DumpWriter* _writer;
1160 u4 _thread_serial_num;
1161 int _frame_num;
1162 DumpWriter* writer() const { return _writer; }
1163 public:
1164 JNILocalsDumper(DumpWriter* writer, u4 thread_serial_num) {
1165 _writer = writer;
1166 _thread_serial_num = thread_serial_num;
1167 _frame_num = -1; // default - empty stack
1168 }
1169 void set_frame_number(int n) { _frame_num = n; }
1170 void do_oop(oop* obj_p);
1171 void do_oop(narrowOop* obj_p) { ShouldNotReachHere(); }
1172 };
1175 void JNILocalsDumper::do_oop(oop* obj_p) {
1176 // ignore null or deleted handles
1177 oop o = *obj_p;
1178 if (o != NULL && o != JNIHandles::deleted_handle()) {
1179 writer()->write_u1(HPROF_GC_ROOT_JNI_LOCAL);
1180 writer()->write_objectID(o);
1181 writer()->write_u4(_thread_serial_num);
1182 writer()->write_u4((u4)_frame_num);
1183 }
1184 }
1187 // Support class used to generate HPROF_GC_ROOT_JNI_GLOBAL records
1189 class JNIGlobalsDumper : public OopClosure {
1190 private:
1191 DumpWriter* _writer;
1192 DumpWriter* writer() const { return _writer; }
1194 public:
1195 JNIGlobalsDumper(DumpWriter* writer) {
1196 _writer = writer;
1197 }
1198 void do_oop(oop* obj_p);
1199 void do_oop(narrowOop* obj_p) { ShouldNotReachHere(); }
1200 };
1202 void JNIGlobalsDumper::do_oop(oop* obj_p) {
1203 oop o = *obj_p;
1205 // ignore these
1206 if (o == NULL || o == JNIHandles::deleted_handle()) return;
1208 // we ignore global ref to symbols and other internal objects
1209 if (o->is_instance() || o->is_objArray() || o->is_typeArray()) {
1210 writer()->write_u1(HPROF_GC_ROOT_JNI_GLOBAL);
1211 writer()->write_objectID(o);
1212 writer()->write_objectID((oopDesc*)obj_p); // global ref ID
1213 }
1214 };
1217 // Support class used to generate HPROF_GC_ROOT_MONITOR_USED records
1219 class MonitorUsedDumper : public OopClosure {
1220 private:
1221 DumpWriter* _writer;
1222 DumpWriter* writer() const { return _writer; }
1223 public:
1224 MonitorUsedDumper(DumpWriter* writer) {
1225 _writer = writer;
1226 }
1227 void do_oop(oop* obj_p) {
1228 writer()->write_u1(HPROF_GC_ROOT_MONITOR_USED);
1229 writer()->write_objectID(*obj_p);
1230 }
1231 void do_oop(narrowOop* obj_p) { ShouldNotReachHere(); }
1232 };
1235 // Support class used to generate HPROF_GC_ROOT_STICKY_CLASS records
1237 class StickyClassDumper : public KlassClosure {
1238 private:
1239 DumpWriter* _writer;
1240 DumpWriter* writer() const { return _writer; }
1241 public:
1242 StickyClassDumper(DumpWriter* writer) {
1243 _writer = writer;
1244 }
1245 void do_klass(Klass* k) {
1246 if (k->oop_is_instance()) {
1247 InstanceKlass* ik = InstanceKlass::cast(k);
1248 writer()->write_u1(HPROF_GC_ROOT_STICKY_CLASS);
1249 writer()->write_classID(ik);
1250 }
1251 }
1252 };
1255 class VM_HeapDumper;
1257 // Support class using when iterating over the heap.
1259 class HeapObjectDumper : public ObjectClosure {
1260 private:
1261 VM_HeapDumper* _dumper;
1262 DumpWriter* _writer;
1264 VM_HeapDumper* dumper() { return _dumper; }
1265 DumpWriter* writer() { return _writer; }
1267 // used to indicate that a record has been writen
1268 void mark_end_of_record();
1270 public:
1271 HeapObjectDumper(VM_HeapDumper* dumper, DumpWriter* writer) {
1272 _dumper = dumper;
1273 _writer = writer;
1274 }
1276 // called for each object in the heap
1277 void do_object(oop o);
1278 };
1280 void HeapObjectDumper::do_object(oop o) {
1281 // hide the sentinel for deleted handles
1282 if (o == JNIHandles::deleted_handle()) return;
1284 // skip classes as these emitted as HPROF_GC_CLASS_DUMP records
1285 if (o->klass() == SystemDictionary::Class_klass()) {
1286 if (!java_lang_Class::is_primitive(o)) {
1287 return;
1288 }
1289 }
1291 if (o->is_instance()) {
1292 // create a HPROF_GC_INSTANCE record for each object
1293 DumperSupport::dump_instance(writer(), o);
1294 mark_end_of_record();
1295 } else if (o->is_objArray()) {
1296 // create a HPROF_GC_OBJ_ARRAY_DUMP record for each object array
1297 DumperSupport::dump_object_array(writer(), objArrayOop(o));
1298 mark_end_of_record();
1299 } else if (o->is_typeArray()) {
1300 // create a HPROF_GC_PRIM_ARRAY_DUMP record for each type array
1301 DumperSupport::dump_prim_array(writer(), typeArrayOop(o));
1302 mark_end_of_record();
1303 }
1304 }
1306 // The VM operation that performs the heap dump
1307 class VM_HeapDumper : public VM_GC_Operation {
1308 private:
1309 static VM_HeapDumper* _global_dumper;
1310 static DumpWriter* _global_writer;
1311 DumpWriter* _local_writer;
1312 JavaThread* _oome_thread;
1313 Method* _oome_constructor;
1314 bool _gc_before_heap_dump;
1315 bool _is_segmented_dump;
1316 jlong _dump_start;
1317 GrowableArray<Klass*>* _klass_map;
1318 ThreadStackTrace** _stack_traces;
1319 int _num_threads;
1321 // accessors and setters
1322 static VM_HeapDumper* dumper() { assert(_global_dumper != NULL, "Error"); return _global_dumper; }
1323 static DumpWriter* writer() { assert(_global_writer != NULL, "Error"); return _global_writer; }
1324 void set_global_dumper() {
1325 assert(_global_dumper == NULL, "Error");
1326 _global_dumper = this;
1327 }
1328 void set_global_writer() {
1329 assert(_global_writer == NULL, "Error");
1330 _global_writer = _local_writer;
1331 }
1332 void clear_global_dumper() { _global_dumper = NULL; }
1333 void clear_global_writer() { _global_writer = NULL; }
1335 bool is_segmented_dump() const { return _is_segmented_dump; }
1336 void set_segmented_dump() { _is_segmented_dump = true; }
1337 jlong dump_start() const { return _dump_start; }
1338 void set_dump_start(jlong pos);
1340 bool skip_operation() const;
1342 // writes a HPROF_LOAD_CLASS record
1343 static void do_load_class(Klass* k);
1345 // writes a HPROF_GC_CLASS_DUMP record for the given class
1346 // (and each array class too)
1347 static void do_class_dump(Klass* k);
1349 // writes a HPROF_GC_CLASS_DUMP records for a given basic type
1350 // array (and each multi-dimensional array too)
1351 static void do_basic_type_array_class_dump(Klass* k);
1353 // HPROF_GC_ROOT_THREAD_OBJ records
1354 int do_thread(JavaThread* thread, u4 thread_serial_num);
1355 void do_threads();
1357 void add_class_serial_number(Klass* k, int serial_num) {
1358 _klass_map->at_put_grow(serial_num, k);
1359 }
1361 // HPROF_TRACE and HPROF_FRAME records
1362 void dump_stack_traces();
1364 // writes a HPROF_HEAP_DUMP or HPROF_HEAP_DUMP_SEGMENT record
1365 void write_dump_header();
1367 // fixes up the length of the current dump record
1368 void write_current_dump_record_length();
1370 // fixes up the current dump record )and writes HPROF_HEAP_DUMP_END
1371 // record in the case of a segmented heap dump)
1372 void end_of_dump();
1374 public:
1375 VM_HeapDumper(DumpWriter* writer, bool gc_before_heap_dump, bool oome) :
1376 VM_GC_Operation(0 /* total collections, dummy, ignored */,
1377 GCCause::_heap_dump /* GC Cause */,
1378 0 /* total full collections, dummy, ignored */,
1379 gc_before_heap_dump) {
1380 _local_writer = writer;
1381 _gc_before_heap_dump = gc_before_heap_dump;
1382 _is_segmented_dump = false;
1383 _dump_start = (jlong)-1;
1384 _klass_map = new (ResourceObj::C_HEAP, mtInternal) GrowableArray<Klass*>(INITIAL_CLASS_COUNT, true);
1385 _stack_traces = NULL;
1386 _num_threads = 0;
1387 if (oome) {
1388 assert(!Thread::current()->is_VM_thread(), "Dump from OutOfMemoryError cannot be called by the VMThread");
1389 // get OutOfMemoryError zero-parameter constructor
1390 InstanceKlass* oome_ik = InstanceKlass::cast(SystemDictionary::OutOfMemoryError_klass());
1391 _oome_constructor = oome_ik->find_method(vmSymbols::object_initializer_name(),
1392 vmSymbols::void_method_signature());
1393 // get thread throwing OOME when generating the heap dump at OOME
1394 _oome_thread = JavaThread::current();
1395 } else {
1396 _oome_thread = NULL;
1397 _oome_constructor = NULL;
1398 }
1399 }
1400 ~VM_HeapDumper() {
1401 if (_stack_traces != NULL) {
1402 for (int i=0; i < _num_threads; i++) {
1403 delete _stack_traces[i];
1404 }
1405 FREE_C_HEAP_ARRAY(ThreadStackTrace*, _stack_traces, mtInternal);
1406 }
1407 delete _klass_map;
1408 }
1410 VMOp_Type type() const { return VMOp_HeapDumper; }
1411 // used to mark sub-record boundary
1412 void check_segment_length();
1413 void doit();
1414 };
1416 VM_HeapDumper* VM_HeapDumper::_global_dumper = NULL;
1417 DumpWriter* VM_HeapDumper::_global_writer = NULL;
1419 bool VM_HeapDumper::skip_operation() const {
1420 return false;
1421 }
1423 // sets the dump starting position
1424 void VM_HeapDumper::set_dump_start(jlong pos) {
1425 _dump_start = pos;
1426 }
1428 // writes a HPROF_HEAP_DUMP or HPROF_HEAP_DUMP_SEGMENT record
1429 void VM_HeapDumper::write_dump_header() {
1430 if (writer()->is_open()) {
1431 if (is_segmented_dump()) {
1432 writer()->write_u1(HPROF_HEAP_DUMP_SEGMENT);
1433 } else {
1434 writer()->write_u1(HPROF_HEAP_DUMP);
1435 }
1436 writer()->write_u4(0); // current ticks
1438 // record the starting position for the dump (its length will be fixed up later)
1439 set_dump_start(writer()->current_offset());
1440 writer()->write_u4(0);
1441 }
1442 }
1444 // fixes up the length of the current dump record
1445 void VM_HeapDumper::write_current_dump_record_length() {
1446 if (writer()->is_open()) {
1447 assert(dump_start() >= 0, "no dump start recorded");
1449 // calculate the size of the dump record
1450 julong dump_end = writer()->current_offset();
1451 julong dump_len = (dump_end - dump_start() - 4);
1453 // record length must fit in a u4
1454 if (dump_len > max_juint) {
1455 warning("record is too large");
1456 }
1458 // seek to the dump start and fix-up the length
1459 writer()->seek_to_offset(dump_start());
1460 writer()->write_u4((u4)dump_len);
1462 // adjust the total size written to keep the bytes written correct.
1463 writer()->adjust_bytes_written(-((jlong) sizeof(u4)));
1465 // seek to dump end so we can continue
1466 writer()->seek_to_offset(dump_end);
1468 // no current dump record
1469 set_dump_start((jlong)-1);
1470 }
1471 }
1473 // used on a sub-record boundary to check if we need to start a
1474 // new segment.
1475 void VM_HeapDumper::check_segment_length() {
1476 if (writer()->is_open()) {
1477 if (is_segmented_dump()) {
1478 // don't use current_offset that would be too expensive on a per record basis
1479 julong dump_end = writer()->bytes_written() + writer()->bytes_unwritten();
1480 assert(dump_end == (julong)writer()->current_offset(), "checking");
1481 julong dump_len = (dump_end - dump_start() - 4);
1482 assert(dump_len <= max_juint, "bad dump length");
1484 if (dump_len > HeapDumpSegmentSize) {
1485 write_current_dump_record_length();
1486 write_dump_header();
1487 }
1488 }
1489 }
1490 }
1492 // fixes up the current dump record )and writes HPROF_HEAP_DUMP_END
1493 // record in the case of a segmented heap dump)
1494 void VM_HeapDumper::end_of_dump() {
1495 if (writer()->is_open()) {
1496 write_current_dump_record_length();
1498 // for segmented dump we write the end record
1499 if (is_segmented_dump()) {
1500 writer()->write_u1(HPROF_HEAP_DUMP_END);
1501 writer()->write_u4(0);
1502 writer()->write_u4(0);
1503 }
1504 }
1505 }
1507 // marks sub-record boundary
1508 void HeapObjectDumper::mark_end_of_record() {
1509 dumper()->check_segment_length();
1510 }
1512 // writes a HPROF_LOAD_CLASS record for the class (and each of its
1513 // array classes)
1514 void VM_HeapDumper::do_load_class(Klass* k) {
1515 static u4 class_serial_num = 0;
1517 // len of HPROF_LOAD_CLASS record
1518 u4 remaining = 2*oopSize + 2*sizeof(u4);
1520 // write a HPROF_LOAD_CLASS for the class and each array class
1521 do {
1522 DumperSupport::write_header(writer(), HPROF_LOAD_CLASS, remaining);
1524 // class serial number is just a number
1525 writer()->write_u4(++class_serial_num);
1527 // class ID
1528 Klass* klass = k;
1529 writer()->write_classID(klass);
1531 // add the Klass* and class serial number pair
1532 dumper()->add_class_serial_number(klass, class_serial_num);
1534 writer()->write_u4(STACK_TRACE_ID);
1536 // class name ID
1537 Symbol* name = klass->name();
1538 writer()->write_symbolID(name);
1540 // write a LOAD_CLASS record for the array type (if it exists)
1541 k = klass->array_klass_or_null();
1542 } while (k != NULL);
1543 }
1545 // writes a HPROF_GC_CLASS_DUMP record for the given class
1546 void VM_HeapDumper::do_class_dump(Klass* k) {
1547 if (k->oop_is_instance()) {
1548 DumperSupport::dump_class_and_array_classes(writer(), k);
1549 }
1550 }
1552 // writes a HPROF_GC_CLASS_DUMP records for a given basic type
1553 // array (and each multi-dimensional array too)
1554 void VM_HeapDumper::do_basic_type_array_class_dump(Klass* k) {
1555 DumperSupport::dump_basic_type_array_class(writer(), k);
1556 }
1558 // Walk the stack of the given thread.
1559 // Dumps a HPROF_GC_ROOT_JAVA_FRAME record for each local
1560 // Dumps a HPROF_GC_ROOT_JNI_LOCAL record for each JNI local
1561 //
1562 // It returns the number of Java frames in this thread stack
1563 int VM_HeapDumper::do_thread(JavaThread* java_thread, u4 thread_serial_num) {
1564 JNILocalsDumper blk(writer(), thread_serial_num);
1566 oop threadObj = java_thread->threadObj();
1567 assert(threadObj != NULL, "sanity check");
1569 int stack_depth = 0;
1570 if (java_thread->has_last_Java_frame()) {
1572 // vframes are resource allocated
1573 Thread* current_thread = Thread::current();
1574 ResourceMark rm(current_thread);
1575 HandleMark hm(current_thread);
1577 RegisterMap reg_map(java_thread);
1578 frame f = java_thread->last_frame();
1579 vframe* vf = vframe::new_vframe(&f, ®_map, java_thread);
1580 frame* last_entry_frame = NULL;
1581 int extra_frames = 0;
1583 if (java_thread == _oome_thread && _oome_constructor != NULL) {
1584 extra_frames++;
1585 }
1586 while (vf != NULL) {
1587 blk.set_frame_number(stack_depth);
1588 if (vf->is_java_frame()) {
1590 // java frame (interpreted, compiled, ...)
1591 javaVFrame *jvf = javaVFrame::cast(vf);
1592 if (!(jvf->method()->is_native())) {
1593 StackValueCollection* locals = jvf->locals();
1594 for (int slot=0; slot<locals->size(); slot++) {
1595 if (locals->at(slot)->type() == T_OBJECT) {
1596 oop o = locals->obj_at(slot)();
1598 if (o != NULL) {
1599 writer()->write_u1(HPROF_GC_ROOT_JAVA_FRAME);
1600 writer()->write_objectID(o);
1601 writer()->write_u4(thread_serial_num);
1602 writer()->write_u4((u4) (stack_depth + extra_frames));
1603 }
1604 }
1605 }
1606 } else {
1607 // native frame
1608 if (stack_depth == 0) {
1609 // JNI locals for the top frame.
1610 java_thread->active_handles()->oops_do(&blk);
1611 } else {
1612 if (last_entry_frame != NULL) {
1613 // JNI locals for the entry frame
1614 assert(last_entry_frame->is_entry_frame(), "checking");
1615 last_entry_frame->entry_frame_call_wrapper()->handles()->oops_do(&blk);
1616 }
1617 }
1618 }
1619 // increment only for Java frames
1620 stack_depth++;
1621 last_entry_frame = NULL;
1623 } else {
1624 // externalVFrame - if it's an entry frame then report any JNI locals
1625 // as roots when we find the corresponding native javaVFrame
1626 frame* fr = vf->frame_pointer();
1627 assert(fr != NULL, "sanity check");
1628 if (fr->is_entry_frame()) {
1629 last_entry_frame = fr;
1630 }
1631 }
1632 vf = vf->sender();
1633 }
1634 } else {
1635 // no last java frame but there may be JNI locals
1636 java_thread->active_handles()->oops_do(&blk);
1637 }
1638 return stack_depth;
1639 }
1642 // write a HPROF_GC_ROOT_THREAD_OBJ record for each java thread. Then walk
1643 // the stack so that locals and JNI locals are dumped.
1644 void VM_HeapDumper::do_threads() {
1645 for (int i=0; i < _num_threads; i++) {
1646 JavaThread* thread = _stack_traces[i]->thread();
1647 oop threadObj = thread->threadObj();
1648 u4 thread_serial_num = i+1;
1649 u4 stack_serial_num = thread_serial_num + STACK_TRACE_ID;
1650 writer()->write_u1(HPROF_GC_ROOT_THREAD_OBJ);
1651 writer()->write_objectID(threadObj);
1652 writer()->write_u4(thread_serial_num); // thread number
1653 writer()->write_u4(stack_serial_num); // stack trace serial number
1654 int num_frames = do_thread(thread, thread_serial_num);
1655 assert(num_frames == _stack_traces[i]->get_stack_depth(),
1656 "total number of Java frames not matched");
1657 }
1658 }
1661 // The VM operation that dumps the heap. The dump consists of the following
1662 // records:
1663 //
1664 // HPROF_HEADER
1665 // [HPROF_UTF8]*
1666 // [HPROF_LOAD_CLASS]*
1667 // [[HPROF_FRAME]*|HPROF_TRACE]*
1668 // [HPROF_GC_CLASS_DUMP]*
1669 // HPROF_HEAP_DUMP
1670 //
1671 // The HPROF_TRACE records represent the stack traces where the heap dump
1672 // is generated and a "dummy trace" record which does not include
1673 // any frames. The dummy trace record is used to be referenced as the
1674 // unknown object alloc site.
1675 //
1676 // The HPROF_HEAP_DUMP record has a length following by sub-records. To allow
1677 // the heap dump be generated in a single pass we remember the position of
1678 // the dump length and fix it up after all sub-records have been written.
1679 // To generate the sub-records we iterate over the heap, writing
1680 // HPROF_GC_INSTANCE_DUMP, HPROF_GC_OBJ_ARRAY_DUMP, and HPROF_GC_PRIM_ARRAY_DUMP
1681 // records as we go. Once that is done we write records for some of the GC
1682 // roots.
1684 void VM_HeapDumper::doit() {
1686 HandleMark hm;
1687 CollectedHeap* ch = Universe::heap();
1689 ch->ensure_parsability(false); // must happen, even if collection does
1690 // not happen (e.g. due to GC_locker)
1692 if (_gc_before_heap_dump) {
1693 if (GC_locker::is_active()) {
1694 warning("GC locker is held; pre-heapdump GC was skipped");
1695 } else {
1696 ch->collect_as_vm_thread(GCCause::_heap_dump);
1697 }
1698 }
1700 // At this point we should be the only dumper active, so
1701 // the following should be safe.
1702 set_global_dumper();
1703 set_global_writer();
1705 // Write the file header - use 1.0.2 for large heaps, otherwise 1.0.1
1706 size_t used = ch->used();
1707 const char* header;
1708 if (used > (size_t)SegmentedHeapDumpThreshold) {
1709 set_segmented_dump();
1710 header = "JAVA PROFILE 1.0.2";
1711 } else {
1712 header = "JAVA PROFILE 1.0.1";
1713 }
1715 // header is few bytes long - no chance to overflow int
1716 writer()->write_raw((void*)header, (int)strlen(header));
1717 writer()->write_u1(0); // terminator
1718 writer()->write_u4(oopSize);
1719 writer()->write_u8(os::javaTimeMillis());
1721 // HPROF_UTF8 records
1722 SymbolTableDumper sym_dumper(writer());
1723 SymbolTable::symbols_do(&sym_dumper);
1725 // write HPROF_LOAD_CLASS records
1726 ClassLoaderDataGraph::classes_do(&do_load_class);
1727 Universe::basic_type_classes_do(&do_load_class);
1729 // write HPROF_FRAME and HPROF_TRACE records
1730 // this must be called after _klass_map is built when iterating the classes above.
1731 dump_stack_traces();
1733 // write HPROF_HEAP_DUMP or HPROF_HEAP_DUMP_SEGMENT
1734 write_dump_header();
1736 // Writes HPROF_GC_CLASS_DUMP records
1737 ClassLoaderDataGraph::classes_do(&do_class_dump);
1738 Universe::basic_type_classes_do(&do_basic_type_array_class_dump);
1739 check_segment_length();
1741 // writes HPROF_GC_INSTANCE_DUMP records.
1742 // After each sub-record is written check_segment_length will be invoked. When
1743 // generated a segmented heap dump this allows us to check if the current
1744 // segment exceeds a threshold and if so, then a new segment is started.
1745 // The HPROF_GC_CLASS_DUMP and HPROF_GC_INSTANCE_DUMP are the vast bulk
1746 // of the heap dump.
1747 HeapObjectDumper obj_dumper(this, writer());
1748 Universe::heap()->safe_object_iterate(&obj_dumper);
1750 // HPROF_GC_ROOT_THREAD_OBJ + frames + jni locals
1751 do_threads();
1752 check_segment_length();
1754 // HPROF_GC_ROOT_MONITOR_USED
1755 MonitorUsedDumper mon_dumper(writer());
1756 ObjectSynchronizer::oops_do(&mon_dumper);
1757 check_segment_length();
1759 // HPROF_GC_ROOT_JNI_GLOBAL
1760 JNIGlobalsDumper jni_dumper(writer());
1761 JNIHandles::oops_do(&jni_dumper);
1762 check_segment_length();
1764 // HPROF_GC_ROOT_STICKY_CLASS
1765 StickyClassDumper class_dumper(writer());
1766 SystemDictionary::always_strong_classes_do(&class_dumper);
1768 // fixes up the length of the dump record. In the case of a segmented
1769 // heap then the HPROF_HEAP_DUMP_END record is also written.
1770 end_of_dump();
1772 // Now we clear the global variables, so that a future dumper might run.
1773 clear_global_dumper();
1774 clear_global_writer();
1775 }
1777 void VM_HeapDumper::dump_stack_traces() {
1778 // write a HPROF_TRACE record without any frames to be referenced as object alloc sites
1779 DumperSupport::write_header(writer(), HPROF_TRACE, 3*sizeof(u4));
1780 writer()->write_u4((u4) STACK_TRACE_ID);
1781 writer()->write_u4(0); // thread number
1782 writer()->write_u4(0); // frame count
1784 _stack_traces = NEW_C_HEAP_ARRAY(ThreadStackTrace*, Threads::number_of_threads(), mtInternal);
1785 int frame_serial_num = 0;
1786 for (JavaThread* thread = Threads::first(); thread != NULL ; thread = thread->next()) {
1787 oop threadObj = thread->threadObj();
1788 if (threadObj != NULL && !thread->is_exiting() && !thread->is_hidden_from_external_view()) {
1789 // dump thread stack trace
1790 ThreadStackTrace* stack_trace = new ThreadStackTrace(thread, false);
1791 stack_trace->dump_stack_at_safepoint(-1);
1792 _stack_traces[_num_threads++] = stack_trace;
1794 // write HPROF_FRAME records for this thread's stack trace
1795 int depth = stack_trace->get_stack_depth();
1796 int thread_frame_start = frame_serial_num;
1797 int extra_frames = 0;
1798 // write fake frame that makes it look like the thread, which caused OOME,
1799 // is in the OutOfMemoryError zero-parameter constructor
1800 if (thread == _oome_thread && _oome_constructor != NULL) {
1801 int oome_serial_num = _klass_map->find(_oome_constructor->method_holder());
1802 // the class serial number starts from 1
1803 assert(oome_serial_num > 0, "OutOfMemoryError class not found");
1804 DumperSupport::dump_stack_frame(writer(), ++frame_serial_num, oome_serial_num,
1805 _oome_constructor, 0);
1806 extra_frames++;
1807 }
1808 for (int j=0; j < depth; j++) {
1809 StackFrameInfo* frame = stack_trace->stack_frame_at(j);
1810 Method* m = frame->method();
1811 int class_serial_num = _klass_map->find(m->method_holder());
1812 // the class serial number starts from 1
1813 assert(class_serial_num > 0, "class not found");
1814 DumperSupport::dump_stack_frame(writer(), ++frame_serial_num, class_serial_num, m, frame->bci());
1815 }
1816 depth += extra_frames;
1818 // write HPROF_TRACE record for one thread
1819 DumperSupport::write_header(writer(), HPROF_TRACE, 3*sizeof(u4) + depth*oopSize);
1820 int stack_serial_num = _num_threads + STACK_TRACE_ID;
1821 writer()->write_u4(stack_serial_num); // stack trace serial number
1822 writer()->write_u4((u4) _num_threads); // thread serial number
1823 writer()->write_u4(depth); // frame count
1824 for (int j=1; j <= depth; j++) {
1825 writer()->write_id(thread_frame_start + j);
1826 }
1827 }
1828 }
1829 }
1831 // dump the heap to given path.
1832 PRAGMA_FORMAT_NONLITERAL_IGNORED_EXTERNAL
1833 int HeapDumper::dump(const char* path) {
1834 assert(path != NULL && strlen(path) > 0, "path missing");
1836 // print message in interactive case
1837 if (print_to_tty()) {
1838 tty->print_cr("Dumping heap to %s ...", path);
1839 timer()->start();
1840 }
1842 // create the dump writer. If the file can be opened then bail
1843 DumpWriter writer(path);
1844 if (!writer.is_open()) {
1845 set_error(writer.error());
1846 if (print_to_tty()) {
1847 tty->print_cr("Unable to create %s: %s", path,
1848 (error() != NULL) ? error() : "reason unknown");
1849 }
1850 return -1;
1851 }
1853 // generate the dump
1854 VM_HeapDumper dumper(&writer, _gc_before_heap_dump, _oome);
1855 if (Thread::current()->is_VM_thread()) {
1856 assert(SafepointSynchronize::is_at_safepoint(), "Expected to be called at a safepoint");
1857 dumper.doit();
1858 } else {
1859 VMThread::execute(&dumper);
1860 }
1862 // close dump file and record any error that the writer may have encountered
1863 writer.close();
1864 set_error(writer.error());
1866 // print message in interactive case
1867 if (print_to_tty()) {
1868 timer()->stop();
1869 if (error() == NULL) {
1870 tty->print_cr("Heap dump file created [" JULONG_FORMAT " bytes in %3.3f secs]",
1871 writer.bytes_written(), timer()->seconds());
1872 } else {
1873 tty->print_cr("Dump file is incomplete: %s", writer.error());
1874 }
1875 }
1877 return (writer.error() == NULL) ? 0 : -1;
1878 }
1880 // stop timer (if still active), and free any error string we might be holding
1881 HeapDumper::~HeapDumper() {
1882 if (timer()->is_active()) {
1883 timer()->stop();
1884 }
1885 set_error(NULL);
1886 }
1889 // returns the error string (resource allocated), or NULL
1890 char* HeapDumper::error_as_C_string() const {
1891 if (error() != NULL) {
1892 char* str = NEW_RESOURCE_ARRAY(char, strlen(error())+1);
1893 strcpy(str, error());
1894 return str;
1895 } else {
1896 return NULL;
1897 }
1898 }
1900 // set the error string
1901 void HeapDumper::set_error(char* error) {
1902 if (_error != NULL) {
1903 os::free(_error);
1904 }
1905 if (error == NULL) {
1906 _error = NULL;
1907 } else {
1908 _error = os::strdup(error);
1909 assert(_error != NULL, "allocation failure");
1910 }
1911 }
1913 // Called by out-of-memory error reporting by a single Java thread
1914 // outside of a JVM safepoint
1915 void HeapDumper::dump_heap_from_oome() {
1916 HeapDumper::dump_heap(true);
1917 }
1919 // Called by error reporting by a single Java thread outside of a JVM safepoint,
1920 // or by heap dumping by the VM thread during a (GC) safepoint. Thus, these various
1921 // callers are strictly serialized and guaranteed not to interfere below. For more
1922 // general use, however, this method will need modification to prevent
1923 // inteference when updating the static variables base_path and dump_file_seq below.
1924 void HeapDumper::dump_heap() {
1925 HeapDumper::dump_heap(false);
1926 }
1928 void HeapDumper::dump_heap(bool oome) {
1929 static char base_path[JVM_MAXPATHLEN] = {'\0'};
1930 static uint dump_file_seq = 0;
1931 char* my_path;
1932 const int max_digit_chars = 20;
1934 const char* dump_file_name = "java_pid";
1935 const char* dump_file_ext = ".hprof";
1937 // The dump file defaults to java_pid<pid>.hprof in the current working
1938 // directory. HeapDumpPath=<file> can be used to specify an alternative
1939 // dump file name or a directory where dump file is created.
1940 if (dump_file_seq == 0) { // first time in, we initialize base_path
1941 // Calculate potentially longest base path and check if we have enough
1942 // allocated statically.
1943 const size_t total_length =
1944 (HeapDumpPath == NULL ? 0 : strlen(HeapDumpPath)) +
1945 strlen(os::file_separator()) + max_digit_chars +
1946 strlen(dump_file_name) + strlen(dump_file_ext) + 1;
1947 if (total_length > sizeof(base_path)) {
1948 warning("Cannot create heap dump file. HeapDumpPath is too long.");
1949 return;
1950 }
1952 bool use_default_filename = true;
1953 if (HeapDumpPath == NULL || HeapDumpPath[0] == '\0') {
1954 // HeapDumpPath=<file> not specified
1955 } else {
1956 strncpy(base_path, HeapDumpPath, sizeof(base_path));
1957 // check if the path is a directory (must exist)
1958 DIR* dir = os::opendir(base_path);
1959 if (dir == NULL) {
1960 use_default_filename = false;
1961 } else {
1962 // HeapDumpPath specified a directory. We append a file separator
1963 // (if needed).
1964 os::closedir(dir);
1965 size_t fs_len = strlen(os::file_separator());
1966 if (strlen(base_path) >= fs_len) {
1967 char* end = base_path;
1968 end += (strlen(base_path) - fs_len);
1969 if (strcmp(end, os::file_separator()) != 0) {
1970 strcat(base_path, os::file_separator());
1971 }
1972 }
1973 }
1974 }
1975 // If HeapDumpPath wasn't a file name then we append the default name
1976 if (use_default_filename) {
1977 const size_t dlen = strlen(base_path); // if heap dump dir specified
1978 jio_snprintf(&base_path[dlen], sizeof(base_path)-dlen, "%s%d%s",
1979 dump_file_name, os::current_process_id(), dump_file_ext);
1980 }
1981 const size_t len = strlen(base_path) + 1;
1982 my_path = (char*)os::malloc(len, mtInternal);
1983 if (my_path == NULL) {
1984 warning("Cannot create heap dump file. Out of system memory.");
1985 return;
1986 }
1987 strncpy(my_path, base_path, len);
1988 } else {
1989 // Append a sequence number id for dumps following the first
1990 const size_t len = strlen(base_path) + max_digit_chars + 2; // for '.' and \0
1991 my_path = (char*)os::malloc(len, mtInternal);
1992 if (my_path == NULL) {
1993 warning("Cannot create heap dump file. Out of system memory.");
1994 return;
1995 }
1996 jio_snprintf(my_path, len, "%s.%d", base_path, dump_file_seq);
1997 }
1998 dump_file_seq++; // increment seq number for next time we dump
2000 HeapDumper dumper(false /* no GC before heap dump */,
2001 true /* send to tty */,
2002 oome /* pass along out-of-memory-error flag */);
2003 dumper.dump(my_path);
2004 os::free(my_path);
2005 }
