Class MiniDumpReader

java.lang.Object

com.ibm.j9ddr.corereaders.AbstractCoreReader

com.ibm.j9ddr.corereaders.minidump.MiniDumpReader

All Implemented Interfaces:

ICore, ICoreFileReader

public class MiniDumpReader
extends AbstractCoreReader
implements ICoreFileReader

Nested Class Summary

Nested classes/interfaces declared in interface ICoreFileReader

ICoreFileReader.DumpTestResult

Modifier and Type	Interface	Description
static enum	ICoreFileReader.DumpTestResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WINDOWS_BUILDNO_PROPERTY

Fields declared in class AbstractCoreReader

_fileReader, _memoryRanges, coreFile

Modifier and Type	Field	Description
protected ImageInputStream	_fileReader
protected Collection<? extends IMemorySource>	_memoryRanges
protected File	coreFile

Fields declared in interface ICore

CORE_CREATE_TIME_PROPERTY, PROCESSOR_COUNT_PROPERTY, PROCESSOR_SUBTYPE_PROPERTY, PROCESSOR_TYPE_PROPERTY, SYSTEM_SUBTYPE_PROPERTY, SYSTEM_TYPE_PROPERTY

Modifier and Type	Field	Description
static final String	CORE_CREATE_TIME_PROPERTY
static final String	PROCESSOR_COUNT_PROPERTY
static final String	PROCESSOR_SUBTYPE_PROPERTY
static final String	PROCESSOR_TYPE_PROPERTY
static final String	SYSTEM_SUBTYPE_PROPERTY
static final String	SYSTEM_TYPE_PROPERTY

Fields declared in interface ICoreFileReader

J9DDR_CORE_READERS_LOGGER_NAME

Modifier and Type	Field	Description
static final String	J9DDR_CORE_READERS_LOGGER_NAME	This is the name of the java.util.logging.Logger subsystem to which the core readers pass verbose messages.

Constructor Summary

Constructors

Constructor	Description
MiniDumpReader()

Method Summary

Modifier and Type	Method	Description
void	addModule(String moduleName)
List<IAddressSpace>	getAddressSpaces()
String	getDumpFormat()	This is the dump format expressed as a string e.g. elf or xcoff.
IModule	getExecutable()
List<IModule>	getModules()
int	getPid()
Platform	getPlatform()
protected short	getProcessorArchitecture()
Properties	getProperties()
List<IOSThread>	getThreads()
boolean	is64Bit()
ICore	processDump(File file)
ICore	processDump(String path)	Called when a core reader should process the dump.
ICore	processDump(ImageInputStream in)	Called when a core reader should process the dump.
protected void	setMemorySources(Collection<? extends IMemorySource> ranges)
void	setProcessID(int pid)
protected void	setProcessorArchitecture(short processorArchitecture, String procSubtype, int numberOfProcessors)
protected void	setWindowsType(byte type, int major, int minor, int buildNo)
ICoreFileReader.DumpTestResult	testDump(String path)	Tests the dump described by the path for compatibility with this CoreFileReader.
ICoreFileReader.DumpTestResult	testDump(ImageInputStream in)	Tests the dump represented by the input stream for compatibility with this CoreFileReader.
boolean	validDump(byte[] data, long filesize)

Methods declared in class AbstractCoreReader

checkOffset, close, format, format, readByte, readBytes, readFully, readFully, readInt, readInt, readLong, readLong, readShort, readString, seek, setReader

Modifier and Type	Method	Description
protected boolean	checkOffset(long location)
void	close()	Close the handle to the core file and release any resources
static String	format(int i)
static String	format(long l)
byte	readByte()
byte[]	readBytes(int len)
void	readFully(byte[] b)
void	readFully(byte[] buffer, int offset, int length)
int	readInt()
protected static int	readInt(byte[] data, int start)
long	readLong()
protected static long	readLong(byte[] data, int start)
short	readShort()
protected String	readString()
void	seek(long pos)
void	setReader(ImageInputStream reader)	This sets the reader to use to retrieve the underlying bytes to process.

Methods declared in class Object

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

Methods declared in interface ICore

isTruncated

Modifier and Type	Method	Description
default boolean	isTruncated()	Is this core file truncated (i.e. incomplete)?

Field Details

WINDOWS_BUILDNO_PROPERTY

public static final String WINDOWS_BUILDNO_PROPERTY

See Also:

• Constant Field Values

Constructor Details

MiniDumpReader

public MiniDumpReader()

Method Details

processDump

public ICore processDump(File file)
                  throws FileNotFoundException,
InvalidDumpFormatException,
IOException

Throws:

FileNotFoundException

InvalidDumpFormatException

IOException

processDump

public ICore processDump(ImageInputStream in)
                  throws FileNotFoundException,
InvalidDumpFormatException,
IOException

Description copied from interface: ICoreFileReader

Called when a core reader should process the dump. This allows lazy initialisation of the readers especially when they are not subsequently used.

Specified by:

processDump in interface ICoreFileReader

Throws:

FileNotFoundException

InvalidDumpFormatException

IOException

validDump

public boolean validDump(byte[] data,
 long filesize)

processDump

public ICore processDump(String path)
                  throws FileNotFoundException,
InvalidDumpFormatException,
IOException

Description copied from interface: ICoreFileReader

Called when a core reader should process the dump. This allows lazy initialisation of the readers especially when they are not subsequently used.

Specified by:

processDump in interface ICoreFileReader

Throws:

FileNotFoundException

InvalidDumpFormatException

IOException

testDump

public ICoreFileReader.DumpTestResult testDump(String path)
                                        throws IOException

Description copied from interface: ICoreFileReader

Tests the dump described by the path for compatibility with this CoreFileReader.

Specified by:

testDump in interface ICoreFileReader

Parameters:

path - Path to dump file.

Throws:

IOException - If there was an IO problem reading the file (disk full etc.). Note that FileNotFound should be handled with DumpTestResult.

testDump

public ICoreFileReader.DumpTestResult testDump(ImageInputStream in)
                                        throws IOException

Description copied from interface: ICoreFileReader

Tests the dump represented by the input stream for compatibility with this CoreFileReader.

Specified by:

testDump in interface ICoreFileReader

Throws:

IOException - If there was an IO problem reading the file (disk full etc.). Note that FileNotFound should be handled with DumpTestResult.

is64Bit

public boolean is64Bit()

setProcessorArchitecture

protected void setProcessorArchitecture(short processorArchitecture,
 String procSubtype,
 int numberOfProcessors)

setWindowsType

protected void setWindowsType(byte type,
 int major,
 int minor,
 int buildNo)

setProcessID

public void setProcessID(int pid)

addModule

public void addModule(String moduleName)

getProcessorArchitecture

protected short getProcessorArchitecture()

setMemorySources

protected void setMemorySources(Collection<? extends IMemorySource> ranges)

getDumpFormat

public String getDumpFormat()

Description copied from interface: ICore

This is the dump format expressed as a string e.g. elf or xcoff. It is recommended that this name is in lower case.

Specified by:

getDumpFormat in interface ICore

Returns:

getAddressSpaces

public List<IAddressSpace> getAddressSpaces()

Specified by:

getAddressSpaces in interface ICore

Returns:

Address spaces held in this core dump

getPlatform

public Platform getPlatform()

Specified by:

getPlatform in interface ICore

Returns:

Platform that created the dump

getExecutable

public IModule getExecutable()

getModules

public List<IModule> getModules()

getPid

public int getPid()

getThreads

public List<IOSThread> getThreads()

getProperties

public Properties getProperties()

Specified by:

getProperties in interface ICore

Returns:

Property set for this core