Module openj9.dtfj

Package com.ibm.dtfj.image.javacore

Class JCImageProcess

java.lang.Object

com.ibm.dtfj.image.javacore.JCImageProcess

All Implemented Interfaces:

ImageProcess

public class JCImageProcess
extends Object
implements ImageProcess

Constructor Summary

Constructors

Constructor	Description
JCImageProcess(JCImageAddressSpace imageAddressSpace)

Method Summary

Modifier and Type	Method	Description
void	addEnvironment(Object key, Object value)	NON-DTFJ Overwrites whatever was there if a key already exists.
void	addImageThread(JCImageThread thread)	NON-DTFJ
void	addLibrary(JCImageModule module)	NON-DTFJ
void	addRuntime(JavaRuntime javaRuntime)	NON-DTFJ
String	getCommandLine()	Fetch the command line for this process.
ImageThread	getCurrentThread()	Find the thread which triggered the creation of the image
Properties	getEnvironment()	Get the environment variables for this process.
ImageModule	getExecutable()	Get the module representing the executable within the image.
String	getID()	Get the system-wide identifier for the process.
JCImageAddressSpace	getImageAddressSpace()	NON-DTFJ
JCImageThread	getImageThread(ImagePointer id)	NON-DTFJ
Iterator<?>	getLibraries()	Get the set of shared libraries which are loaded in this process.
ImageModule	getLibrary(String name)	NON-DTFJ
int	getPointerSize()	Determine the pointer size used by this process.
Properties	getProperties()	Gets the OS specific properties for this process.
Iterator<?>	getRuntimes()	Get the set of the known ManagedRuntime environments in the image.
String	getSignalName()	Get signal name (if signal was available in javacore).
int	getSignalNumber()	Get signal number (if signal was available in javacore)
Iterator<?>	getThreads()	Get the set of image threads in the image.
void	setCommandLine(String commandLine)	Non-DTFJ.
void	setCurrentThreadID(long imageThreadID)	NON-DTFJ
void	setExecutable(ImageModule execMod)	NON-DTFJ
void	setID(String pid)	NON-DTFJ
void	setPointerSize(int pointerSize)
void	setSignal(int signal)	Non-DTFJ.

Methods declared in class java.lang.Object

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

Constructor Details

JCImageProcess

public JCImageProcess(JCImageAddressSpace imageAddressSpace)
               throws JCInvalidArgumentsException

Throws:

JCInvalidArgumentsException

Method Details

getCommandLine

public String getCommandLine()
                      throws DataUnavailable,
CorruptDataException

Description copied from interface: ImageProcess

Fetch the command line for this process. This may be the exact command line the user issued, or it may be a reconstructed command line based on argv[] and argc.

Specified by:

getCommandLine in interface ImageProcess

Returns:

the command line for the process

Throws:

DataUnavailable - if the information cannot be provided

CorruptDataException

getCurrentThread

public ImageThread getCurrentThread()
                             throws CorruptDataException

Description copied from interface: ImageProcess

Find the thread which triggered the creation of the image

Specified by:

getCurrentThread in interface ImageProcess

Returns:

the ImageThread which caused the image to be created, or null if the image was not created due to a specific thread

Throws:

CorruptDataException

See Also:

• ImageThread

addEnvironment

public void addEnvironment(Object key,
 Object value)

NON-DTFJ Overwrites whatever was there if a key already exists.

Parameters:

key -

value -

getEnvironment

public Properties getEnvironment()
                          throws DataUnavailable,
CorruptDataException

Description copied from interface: ImageProcess

Get the environment variables for this process.

Specified by:

getEnvironment in interface ImageProcess

Returns:

the environment variables for this process

Throws:

DataUnavailable - if the information cannot be provided

CorruptDataException

getExecutable

public ImageModule getExecutable()
                          throws DataUnavailable,
CorruptDataException

Description copied from interface: ImageProcess

Get the module representing the executable within the image.

Specified by:

getExecutable in interface ImageProcess

Returns:

the module representing the executable within the image (as opposed to modules representing libraries)

Throws:

DataUnavailable - if the information cannot be provided

CorruptDataException

See Also:

• ImageModule

getID

public String getID()
             throws DataUnavailable,
CorruptDataException

Description copied from interface: ImageProcess

Get the system-wide identifier for the process.

Specified by:

getID in interface ImageProcess

Returns:

a system-wide identifier for the process (e.g. a process id (pid) on Unix like systems)

Throws:

DataUnavailable - if the information cannot be provided

CorruptDataException

getLibraries

public Iterator<?> getLibraries()
                         throws DataUnavailable,
CorruptDataException

Description copied from interface: ImageProcess

Get the set of shared libraries which are loaded in this process.

Specified by:

getLibraries in interface ImageProcess

Returns:

an iterator to iterate over the shared libraries which are loaded in this process

Throws:

DataUnavailable - if the information cannot be provided

CorruptDataException

See Also:

• ImageModule
• CorruptData

addLibrary

public void addLibrary(JCImageModule module)

NON-DTFJ

Parameters:

module -

getLibrary

public ImageModule getLibrary(String name)

NON-DTFJ

Parameters:

name -

getPointerSize

public int getPointerSize()

Description copied from interface: ImageProcess

Determine the pointer size used by this process. Currently supported values are 31, 32 or 64. In the future, other pointer sizes may also be supported.

Specified by:

getPointerSize in interface ImageProcess

Returns:

the size of a pointer, in bits

setPointerSize

public void setPointerSize(int pointerSize)

Parameters:

pointerSize -

setSignal

public void setSignal(int signal)

Non-DTFJ. Sets signal number found in javacore

Parameters:

signal -

setCommandLine

public void setCommandLine(String commandLine)

Non-DTFJ. Sets command line found in javacore

getRuntimes

public Iterator<?> getRuntimes()

Description copied from interface: ImageProcess

Get the set of the known ManagedRuntime environments in the image.

Specified by:

getRuntimes in interface ImageProcess

Returns:

an iterator to iterate over all of the known ManagedRuntime environments in the image. In a typical image, there will be only one runtime, and it will be an instance of JavaRuntime. However any user of this API should be aware that there is a possibility that other runtimes may exist in the image

See Also:

• ManagedRuntime
• JavaRuntime
• CorruptData

addRuntime

public void addRuntime(JavaRuntime javaRuntime)

NON-DTFJ

Parameters:

javaRuntime -

getSignalName

public String getSignalName()
                     throws DataUnavailable,
CorruptDataException

Get signal name (if signal was available in javacore).

Specified by:

getSignalName in interface ImageProcess

Returns:

the name of the OS signal in this process which triggered the creation of this image, or null if the image was not created because of a signal in this process

Throws:

DataUnavailable - if the information cannot be provided

CorruptDataException

getSignalNumber

public int getSignalNumber()
                    throws DataUnavailable,
CorruptDataException

Get signal number (if signal was available in javacore)

Specified by:

getSignalNumber in interface ImageProcess

Returns:

the OS signal number in this process which triggered the creation of this image, or 0 if the image was not created because of a signal in this process

Throws:

DataUnavailable - if the information cannot be provided

CorruptDataException

getThreads

public Iterator<?> getThreads()

Description copied from interface: ImageProcess

Get the set of image threads in the image.

Specified by:

getThreads in interface ImageProcess

Returns:

an iterator to iterate over each ImageThread in the image There is not necessarily any relationship between JavaThreads and ImageThreads. A JVM implementation may use an n:m mapping of JavaThreads to ImageThreads, and not all ImageThreads are necessarily attached.

See Also:

• ImageThread
• CorruptData

addImageThread

public void addImageThread(JCImageThread thread)

NON-DTFJ

Parameters:

thread -

getImageThread

public JCImageThread getImageThread(ImagePointer id)

NON-DTFJ

Parameters:

id -

getImageAddressSpace

public JCImageAddressSpace getImageAddressSpace()

NON-DTFJ

setExecutable

public void setExecutable(ImageModule execMod)

NON-DTFJ

setID

public void setID(String pid)

NON-DTFJ

setCurrentThreadID

public void setCurrentThreadID(long imageThreadID)

NON-DTFJ

getProperties

public Properties getProperties()

Description copied from interface: ImageProcess

Gets the OS specific properties for this process.

Specified by:

getProperties in interface ImageProcess

Returns:

a set of OS specific properties