Module openj9.dtfjview

Package com.ibm.jvm.dtfjview.heapdump.portable

Class PortableHeapDumpFormatter

java.lang.Object

com.ibm.jvm.dtfjview.heapdump.HeapDumpFormatter

com.ibm.jvm.dtfjview.heapdump.portable.PortableHeapDumpFormatter

public class PortableHeapDumpFormatter
extends HeapDumpFormatter

A formatter for Portable heap dumps (PHDs). Format documented here: http://w3.hursley.ibm.com/~dgriff/newphd.html

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL_OBJECTS_HASHED_FLAG
static final byte	CLASS_RECORD_TAG
static final byte	END_OF_DUMP_TAG
static final byte	END_OF_HEADER_TAG
static final byte	FULL_VERSION_TAG
static final byte	HASHCODE_RANDOM_TAG
static final int	IS_64_BIT_HEADER_FLAG
static final int	IS_J9_HEADER_FLAG
static final byte	LONG_OBJECT_RECORD_TAG
static final byte	LONG_PRIMITIVE_ARRAY_RECORD_TAG
static final String	MAGIC_STRING
static final byte	MEDIUM_OBJECT_RECORD_TAG
static final byte	OBJECT_ARRAY_RECORD_TAG
static final int	PHD_VERSION_NUMBER
static final byte	PRIMITIVE_ARRAY_RECORD_TAG
static final byte	SHORT_OBJECT_RECORD_TAG
static final byte	START_OF_DUMP_TAG
static final byte	START_OF_HEADER_TAG

Fields declared in class com.ibm.jvm.dtfjview.heapdump.HeapDumpFormatter

_is64Bit, _version

Constructor Summary

Constructors

Constructor	Description
PortableHeapDumpFormatter(DataOutputStream output, String version, boolean is64Bit, boolean is32BitHash)

Method Summary

Modifier and Type	Method	Description
void	addClass(long address, String name, long superClassAddress, int size, long instanceSize, int hashCode, ReferenceIterator references)	Adds a class to the heapdump.
void	addObject(long address, long classAddress, String className, int size, int hashCode, ReferenceIterator references)	Adds an object to the heapdump.
void	addObjectArray(long address, long arrayClassAddress, String arrayClassName, long elementClassAddress, String elementClassName, long size, int numberOfElements, int hashCode, ReferenceIterator references)	Adds an object array to the heapdump.
void	addPrimitiveArray(long address, long arrayClassAddress, int type, long size, int hashCode, int numberOfElements)	Adds a primitive array object to the heapdump Type code is: 0 - bool, 1 - char, 2 - float, 3 - double, 4 - byte, 5 - short, 6 - int, 7 - long
void	close()	Closes the heapdump

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAGIC_STRING

public static final String MAGIC_STRING

See Also:

• Constant Field Values

PHD_VERSION_NUMBER

public static final int PHD_VERSION_NUMBER

See Also:

• Constant Field Values

START_OF_HEADER_TAG

public static final byte START_OF_HEADER_TAG

See Also:

• Constant Field Values

END_OF_HEADER_TAG

public static final byte END_OF_HEADER_TAG

See Also:

• Constant Field Values

START_OF_DUMP_TAG

public static final byte START_OF_DUMP_TAG

See Also:

• Constant Field Values

END_OF_DUMP_TAG

public static final byte END_OF_DUMP_TAG

See Also:

• Constant Field Values

HASHCODE_RANDOM_TAG

public static final byte HASHCODE_RANDOM_TAG

See Also:

• Constant Field Values

FULL_VERSION_TAG

public static final byte FULL_VERSION_TAG

See Also:

• Constant Field Values

IS_64_BIT_HEADER_FLAG

public static final int IS_64_BIT_HEADER_FLAG

See Also:

• Constant Field Values

ALL_OBJECTS_HASHED_FLAG

public static final int ALL_OBJECTS_HASHED_FLAG

See Also:

• Constant Field Values

IS_J9_HEADER_FLAG

public static final int IS_J9_HEADER_FLAG

See Also:

• Constant Field Values

CLASS_RECORD_TAG

public static final byte CLASS_RECORD_TAG

See Also:

• Constant Field Values

SHORT_OBJECT_RECORD_TAG

public static final byte SHORT_OBJECT_RECORD_TAG

See Also:

• Constant Field Values

MEDIUM_OBJECT_RECORD_TAG

public static final byte MEDIUM_OBJECT_RECORD_TAG

See Also:

• Constant Field Values

LONG_OBJECT_RECORD_TAG

public static final byte LONG_OBJECT_RECORD_TAG

See Also:

• Constant Field Values

OBJECT_ARRAY_RECORD_TAG

public static final byte OBJECT_ARRAY_RECORD_TAG

See Also:

• Constant Field Values

PRIMITIVE_ARRAY_RECORD_TAG

public static final byte PRIMITIVE_ARRAY_RECORD_TAG

See Also:

• Constant Field Values

LONG_PRIMITIVE_ARRAY_RECORD_TAG

public static final byte LONG_PRIMITIVE_ARRAY_RECORD_TAG

See Also:

• Constant Field Values

Constructor Details

PortableHeapDumpFormatter

public PortableHeapDumpFormatter(DataOutputStream output,
 String version,
 boolean is64Bit,
 boolean is32BitHash)
                          throws IOException

Throws:

IOException

Method Details

addClass

public void addClass(long address,
 String name,
 long superClassAddress,
 int size,
 long instanceSize,
 int hashCode,
 ReferenceIterator references)
              throws IOException

Description copied from class: HeapDumpFormatter

Adds a class to the heapdump.

Specified by:

addClass in class HeapDumpFormatter

Parameters:

address - Address of class

name - Name of class

superClassAddress - Address of superclass

size - Size of class, bytes

instanceSize - Size of objects of this class

hashCode - Hashcode

references - Iterator of Long addresses (some of which may be null)

Throws:

IOException

addObject

public void addObject(long address,
 long classAddress,
 String className,
 int size,
 int hashCode,
 ReferenceIterator references)
               throws IOException

Description copied from class: HeapDumpFormatter

Adds an object to the heapdump.

Specified by:

addObject in class HeapDumpFormatter

Parameters:

address - Address of object

classAddress - Address of class of object

className - Name of class of object

size - Size of object, bytes

hashCode - Hashcode of object

references - Iterator of Long addresses (some of which may be null)

Throws:

IOException

addObjectArray

public void addObjectArray(long address,
 long arrayClassAddress,
 String arrayClassName,
 long elementClassAddress,
 String elementClassName,
 long size,
 int numberOfElements,
 int hashCode,
 ReferenceIterator references)
                    throws IOException

Description copied from class: HeapDumpFormatter

Adds an object array to the heapdump.

Specified by:

addObjectArray in class HeapDumpFormatter

Parameters:

address - Address of object

arrayClassAddress - Address of class of array object

arrayClassName - Name of class of array object

elementClassAddress - Address of class of elements

elementClassName - Name of class of elements

size - Size of object, bytes Since version 6 PHD, instance size is in the PHD and can be larger than max signed int so pass as a long

numberOfElements - number of elements in the array

hashCode - Hashcode of object

references - Iterator of Long addresses (some of which may be null)

Throws:

IOException

addPrimitiveArray

public void addPrimitiveArray(long address,
 long arrayClassAddress,
 int type,
 long size,
 int hashCode,
 int numberOfElements)
                       throws IOException,
IllegalArgumentException

Description copied from class: HeapDumpFormatter

Adds a primitive array object to the heapdump Type code is: 0 - bool, 1 - char, 2 - float, 3 - double, 4 - byte, 5 - short, 6 - int, 7 - long

Specified by:

addPrimitiveArray in class HeapDumpFormatter

Parameters:

address - Address of object

arrayClassAddress - Address of primitive array class

type - Type code - see above

size - Size of object, bytes. Since version 6 PHD, instance size is in the PHD and can be larger than max signed int so pass as a long

hashCode - Hashcode of object

numberOfElements - Number of elements in the array

Throws:

IOException

IllegalArgumentException - if invalid type is supplied

close

public void close()
           throws IOException

Description copied from class: HeapDumpFormatter

Closes the heapdump

Specified by:

close in class HeapDumpFormatter

Throws:

IOException