Module openj9.dtfj

Package com.ibm.j9ddr.view.dtfj.image

Class J9DDRImage

java.lang.Object

com.ibm.j9ddr.view.dtfj.image.J9DDRImage

All Implemented Interfaces:

Image, ManagedImage

public class J9DDRImage
extends Object
implements ManagedImage

Image implementation that wraps a J9DDR ICore

Constructor Summary

Constructors

Constructor	Description
J9DDRImage(ICore coreFile)
J9DDRImage(URI source, ICore coreFile, ImageInputStream meta)

Method Summary

Modifier and Type	Method	Description
void	close()	Close this image and any associated resources.
Iterator<J9DDRImageAddressSpace>	getAddressSpaces()	Get the set of address spaces within the image - typically one but may be more on some systems such as Z/OS.
ICore	getCore()
long	getCreationTime()	Return the dump creation time.
long	getCreationTimeNanos()	Return the value of the system nanotime (high resolution timer) at dump creation time.
String	getHostName()	Get the host name of the system where the image was running.
ManagedImageSource	getImageSource()
long	getInstalledMemory()	Get the amount of physical memory (in bytes) installed in the system on which the image was running.
Iterator<?>	getIPAddresses()	The set of IP addresses (as InetAddresses) which the system running the image possessed.
int	getProcessorCount()	Get the number of CPUs running in the system on which the image was running.
String	getProcessorSubType()	Get the precise model of the CPU.
String	getProcessorType()	Get the family name for the processor on which the image was running.
Properties	getProperties()	Return OS properties (as obtained by the JVM, no support in the core readers)
URI	getSource()	A unique identifier for the source of this image
String	getSystemSubType()	Get the detailed name of the operating system.
String	getSystemType()	Get the family name for the operating system.
boolean	isClosed()
void	setImageSource(ManagedImageSource source)

Methods declared in class java.lang.Object

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

Methods declared in interface com.ibm.dtfj.image.Image

isTruncated

Constructor Details

J9DDRImage

public J9DDRImage(ICore coreFile)

J9DDRImage

public J9DDRImage(URI source,
 ICore coreFile,
 ImageInputStream meta)

Method Details

getCore

public ICore getCore()

getSource

public URI getSource()

Description copied from interface: Image

A unique identifier for the source of this image

Specified by:

getSource in interface Image

Returns:

URI for this image or null if this was not used when the image was created.

getAddressSpaces

public Iterator<J9DDRImageAddressSpace> getAddressSpaces()

Description copied from interface: Image

Get the set of address spaces within the image - typically one but may be more on some systems such as Z/OS.

Specified by:

getAddressSpaces in interface Image

Returns:

an Iterator which iterates over all of the address spaces described by this Image

See Also:

• ImageAddressSpace
• CorruptData

getCreationTime

public long getCreationTime()
                     throws DataUnavailable

Return the dump creation time. See JTC-JAT 92709, we now obtain this from a field in the J9RAS structure that is set by the JVM dump agent when the dump is triggered. If that is not available, we revert to obtaining the creation time via the core readers from a timestamp that the OS puts in the dump. This is supported in system dumps on Windows and zOS, but not Linux or AIX.

Specified by:

getCreationTime in interface Image

Returns:

long - dump creation time (milliseconds since 1970)

Throws:

DataUnavailable

getHostName

public String getHostName()
                   throws DataUnavailable,
CorruptDataException

Description copied from interface: Image

Get the host name of the system where the image was running.

Specified by:

getHostName in interface Image

Returns:

The host name of the system where the image was running. This string will be non-null and non-empty

Throws:

DataUnavailable - If the image did not provide this information (would happen if the system did not know its host name or if the image predated this feature).

CorruptDataException

getIPAddresses

public Iterator<?> getIPAddresses()
                           throws DataUnavailable

Description copied from interface: Image

The set of IP addresses (as InetAddresses) which the system running the image possessed.

Specified by:

getIPAddresses in interface Image

Returns:

An Iterator over the IP addresses (as InetAddresses) which the system running the image possessed. The iterator will be non-null (but can be empty if the host is known to have no IP addresses).

Throws:

DataUnavailable - If the image did not provide this information (would happen if the system failed to look them up or if the image pre-dated this feature).

See Also:

• InetAddress
• CorruptData

getInstalledMemory

public long getInstalledMemory()
                        throws DataUnavailable

Description copied from interface: Image

Get the amount of physical memory (in bytes) installed in the system on which the image was running.

Specified by:

getInstalledMemory in interface Image

Returns:

the amount of physical memory installed in the system on which the image was running. The return value is specified in bytes.

Throws:

DataUnavailable - if the information cannot be provided

getProcessorCount

public int getProcessorCount()
                      throws DataUnavailable

Description copied from interface: Image

Get the number of CPUs running in the system on which the image was running.

Specified by:

getProcessorCount in interface Image

Returns:

the number of CPUs running in the system on which the image was running

Throws:

DataUnavailable - if the information cannot be provided

getProcessorSubType

public String getProcessorSubType()
                           throws DataUnavailable,
CorruptDataException

Description copied from interface: Image

Get the precise model of the CPU.

Specified by:

getProcessorSubType in interface Image

Returns:

the precise model of the CPU (note that this can be an empty string but not null).
e.g. getProcessorType() will return x86 where getProcessorSubType() may return Pentium IV step 4

Note that this value is platform and implementation dependent.

Throws:

DataUnavailable

CorruptDataException

getProcessorType

public String getProcessorType()
                        throws DataUnavailable,
CorruptDataException

Description copied from interface: Image

Get the family name for the processor on which the image was running.

Specified by:

getProcessorType in interface Image

Returns:

the family name for the processor on which the image was running. This corresponds to the value you would find in the "os.arch" System property.

Throws:

DataUnavailable - if this data cannot be inferred from this core type

CorruptDataException - if expected data cannot be read from the core

getSystemSubType

public String getSystemSubType()
                        throws DataUnavailable,
CorruptDataException

Description copied from interface: Image

Get the detailed name of the operating system.

Specified by:

getSystemSubType in interface Image

Returns:

the detailed name of the operating system, or an empty string if this information is not available (null will never be returned). This should be the same value that would be returned for the "os.version" system property

Throws:

DataUnavailable

CorruptDataException

getSystemType

public String getSystemType()
                     throws DataUnavailable,
CorruptDataException

Description copied from interface: Image

Get the family name for the operating system.

Specified by:

getSystemType in interface Image

Returns:

the family name for the operating system. This should be the same value that would be returned for the "os.name" system property

Throws:

DataUnavailable - if this data cannot be inferred from this core type

CorruptDataException - if expected data cannot be read from the core

close

public void close()

Description copied from interface: Image

Close this image and any associated resources.

Some kinds of Image require the generation of temporary resources, for example temporary files created when reading core files and libraries from .zip archives. Ordinarily, these resources are deleted at JVM shutdown, but DTFJ applications may want to free them earlier. This method should only be called when the Image is no longer needed. After this method has been called, any objects associated with the image will be in an invalid state.

Specified by:

close in interface Image

getProperties

public Properties getProperties()

Return OS properties (as obtained by the JVM, no support in the core readers)

Specified by:

getProperties in interface Image

Returns:

Properties (may be empty)

getImageSource

public ManagedImageSource getImageSource()

Specified by:

getImageSource in interface ManagedImage

setImageSource

public void setImageSource(ManagedImageSource source)

Specified by:

setImageSource in interface ManagedImage

isClosed

public boolean isClosed()

getCreationTimeNanos

public long getCreationTimeNanos()
                          throws DataUnavailable,
CorruptDataException

Return the value of the system nanotime (high resolution timer) at dump creation time. See JTC-JAT 92709, we obtain this from a field in the J9RAS structure that is set by the JVM dump agent when the dump is triggered.

Specified by:

getCreationTimeNanos in interface Image

Returns:

long - system nanotime

Throws:

DataUnavailable - if the image creation time is not available

CorruptDataException - if the image creation time is corrupted