Module openj9.dtfj

Package com.ibm.dtfj.javacore.builder.javacore

Class ImageProcessBuilder

java.lang.Object

com.ibm.dtfj.javacore.builder.javacore.AbstractBuilderComponent

com.ibm.dtfj.javacore.builder.javacore.ImageProcessBuilder

All Implemented Interfaces:

IImageProcessBuilder

public class ImageProcessBuilder
extends AbstractBuilderComponent
implements IImageProcessBuilder

Constructor Summary

Constructors

Constructor	Description
ImageProcessBuilder(JCImageAddressSpace imageAddressSpace, String id)

Method Summary

Modifier and Type	Method	Description
void	addEnvironmentVariable(String name, String value)	Add environment variables
ImageStackFrame	addImageStackFrame(long nativeThreadID, String name, long baseAddress, long procAddress)	Adds a stack frame to an image thread
ImageSection	addImageStackSection(ImageThread thread, ImageSection section)	Add a stack section to an existing image thread
ImageThread	addImageThread(long nativeThreadID, long systemThreadID, Properties properties)	Adds a com.ibm.dtfj.image.ImageThread to the Image process being built.
ImageModule	addLibrary(String name)	Will add an com.ibm.dtfj.image.ImageModule for the specified library name.
void	addProperty(ImageModule library, String name, String value)	Adds/updates a property for the library
ImageSymbol	addRoutine(ImageModule library, String name, long address)	Add a routine to a module
IJavaRuntimeBuilder	generateJavaRuntimeBuilder(String id)	Generates a new java runtime factory.
IJavaRuntimeBuilder	getCurrentJavaRuntimeBuilder()	At least one java runtime factory must be associated with an image process factory.
IJavaRuntimeBuilder	getJavaRuntimeBuilder(String builderID)
void	setCommandLine(String cmdLine)	Set command line
void	setCurrentThreadID(long imageThreadID)	Sets the current thread
void	setExecutable(ImageModule execMod)	Sets the module as the process executable
void	setID(String pid)	Sets the id of the process
void	setPointerSize(int size)	Valid values: 64, 32, or 31 (s390) bits.
void	setRegisters(Map regs)	Set registers if available in javacore.
void	setSignal(int signal)	Set signal

Methods declared in class com.ibm.dtfj.javacore.builder.javacore.AbstractBuilderComponent

getBuilderContainer, getID

Methods declared in class java.lang.Object

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

Constructor Details

ImageProcessBuilder

public ImageProcessBuilder(JCImageAddressSpace imageAddressSpace,
 String id)
                    throws JCInvalidArgumentsException

Throws:

JCInvalidArgumentsException

Method Details

getCurrentJavaRuntimeBuilder

public IJavaRuntimeBuilder getCurrentJavaRuntimeBuilder()

Description copied from interface: IImageProcessBuilder

At least one java runtime factory must be associated with an image process factory. In multiple runtime environments, the last java runtime generated for this image process may be considered the current java runtime factory.

Specified by:

getCurrentJavaRuntimeBuilder in interface IImageProcessBuilder

Returns:

current java runtime factory. Must never be null.

getJavaRuntimeBuilder

public IJavaRuntimeBuilder getJavaRuntimeBuilder(String builderID)

Specified by:

getJavaRuntimeBuilder in interface IImageProcessBuilder

Parameters:

builderID - unique id that looks up a java runtime factory

Returns:

found java runtime factory, or null.

generateJavaRuntimeBuilder

public IJavaRuntimeBuilder generateJavaRuntimeBuilder(String id)
                                               throws BuilderFailureException

Description copied from interface: IImageProcessBuilder

Generates a new java runtime factory. If generation fails, an exception is thrown. If the java runtime factory already exists, it returns the latter.

Specified by:

generateJavaRuntimeBuilder in interface IImageProcessBuilder

Parameters:

id -

Returns:

generated java runtime factory.

Throws:

BuilderFailureException - if java runtime factory is not created.

addLibrary

public ImageModule addLibrary(String name)

Description copied from interface: IImageProcessBuilder

Will add an com.ibm.dtfj.image.ImageModule for the specified library name. If the image module already exists, it will return the latter. A null library name returns a null ImageModule.

Specified by:

addLibrary in interface IImageProcessBuilder

Parameters:

name - shared library to be added to the com.ibm.dtfj.image.ImageProcess being built by this image process factory.

Returns:

added/found ImageModule, or null if not added (if the library name isnull)

setPointerSize

public void setPointerSize(int size)

Description copied from interface: IImageProcessBuilder

Valid values: 64, 32, or 31 (s390) bits.

Specified by:

setPointerSize in interface IImageProcessBuilder

Parameters:

size -

addImageThread

public ImageThread addImageThread(long nativeThreadID,
 long systemThreadID,
 Properties properties)
                           throws BuilderFailureException

Description copied from interface: IImageProcessBuilder

Adds a com.ibm.dtfj.image.ImageThread to the Image process being built. If the arguments are invalid and a valid ImageThread cannot be constructed, error occurs.

If the thread already exists, it will populate any missing data into the image thread, and return the latter.

If the thread does not exist, it will create a new ImageThread and register it with the image process being built.

Specified by:

addImageThread in interface IImageProcessBuilder

Parameters:

nativeThreadID -

systemThreadID -

properties -

Properties - with String key and String value

Returns:

generated ImageThread. Must not be null. If a valid image thread cannot be created or found, throw exception.

Throws:

BuilderFailureException - if valid image thread was not created or found/updated.

setSignal

public void setSignal(int signal)

Set signal

Specified by:

setSignal in interface IImageProcessBuilder

Parameters:

signal - number

setCommandLine

public void setCommandLine(String cmdLine)

Set command line

Specified by:

setCommandLine in interface IImageProcessBuilder

Parameters:

command - line string

addImageStackSection

public ImageSection addImageStackSection(ImageThread thread,
 ImageSection section)

Add a stack section to an existing image thread

Specified by:

addImageStackSection in interface IImageProcessBuilder

Parameters:

thread - The native thread

section - The section we want to add

Returns:

setRegisters

public void setRegisters(Map regs)

Set registers if available in javacore.

Specified by:

setRegisters in interface IImageProcessBuilder

Parameters:

regs - Map of registers

addEnvironmentVariable

public void addEnvironmentVariable(String name,
 String value)

Add environment variables

Specified by:

addEnvironmentVariable in interface IImageProcessBuilder

Parameters:

name -

value -

addRoutine

public ImageSymbol addRoutine(ImageModule library,
 String name,
 long address)

Description copied from interface: IImageProcessBuilder

Add a routine to a module

Specified by:

addRoutine in interface IImageProcessBuilder

Parameters:

library -

name -

address -

Returns:

addImageStackFrame

public ImageStackFrame addImageStackFrame(long nativeThreadID,
 String name,
 long baseAddress,
 long procAddress)

Description copied from interface: IImageProcessBuilder

Adds a stack frame to an image thread

Specified by:

addImageStackFrame in interface IImageProcessBuilder

Parameters:

nativeThreadID -

name - of routine

Returns:

setExecutable

public void setExecutable(ImageModule execMod)

Description copied from interface: IImageProcessBuilder

Sets the module as the process executable

Specified by:

setExecutable in interface IImageProcessBuilder

Parameters:

execMod -

setID

public void setID(String pid)

Description copied from interface: IImageProcessBuilder

Sets the id of the process

Specified by:

setID in interface IImageProcessBuilder

Parameters:

pid - String

setCurrentThreadID

public void setCurrentThreadID(long imageThreadID)

Description copied from interface: IImageProcessBuilder

Sets the current thread

Specified by:

setCurrentThreadID in interface IImageProcessBuilder

Parameters:

imageThreadID -

addProperty

public void addProperty(ImageModule library,
 String name,
 String value)

Description copied from interface: IImageProcessBuilder

Adds/updates a property for the library

Specified by:

addProperty in interface IImageProcessBuilder

Parameters:

library - the module

name - the property name

value - the property value