com.oracle.svm.hosted.image

Class NativeBootImage

java.lang.Object

com.oracle.svm.hosted.image.AbstractBootImage

com.oracle.svm.hosted.image.NativeBootImage

Direct Known Subclasses:

NativeBootImageViaCC

public abstract class NativeBootImage
extends AbstractBootImage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	NativeBootImage.TextImpl

Nested classes/interfaces inherited from class com.oracle.svm.hosted.image.AbstractBootImage

AbstractBootImage.NativeImageKind

Field Summary

Fields inherited from class com.oracle.svm.hosted.image.AbstractBootImage

codeCache, entryPoints, heap, imageClassLoader, kind, metaAccess, nativeLibs, resultingImageSize, universe

Constructor Summary

Constructors

Constructor and Description
NativeBootImage(AbstractBootImage.NativeImageKind k, HostedUniverse universe, HostedMetaAccess metaAccess, NativeLibraries nativeLibs, NativeImageHeap heap, NativeImageCodeCache codeCache, List<HostedMethod> entryPoints, HostedMethod mainEntryPoint, ClassLoader imageClassLoader)

Method Summary

Modifier and Type	Method and Description
void	build(org.graalvm.compiler.debug.DebugContext debug) Create the image sections for code, constants, and the heap.
static String	getMethodDescriptor(Method m, boolean includeReturnType) Return the Java bytecode method descriptor for a java.lang.reflect.Method.
com.oracle.objectfile.ObjectFile	getOrCreateDebugObjectFile()
com.oracle.objectfile.ObjectFile.Section	getTextSection() Returns the ObjectFile.Section within the image, if any, whose vaddr defines the image's base vaddr.
static String	globalSymbolNameForMethod(Method m) Given a java.lang.reflect.Method, compute the symbol name of its entry point (if any) in the image.
static String	globalSymbolNameForMethod(jdk.vm.ci.meta.ResolvedJavaMethod sm) Given a ResolvedJavaMethod, compute what symbol name of its entry point (if any) in the image.
static String	localSymbolNameForMethod(Method m) Given a java.lang.reflect.Method, compute the symbol name of its start address (if any) in the image.
static String	localSymbolNameForMethod(jdk.vm.ci.meta.ResolvedJavaMethod sm) Given a ResolvedJavaMethod, compute what symbol name of its start address (if any) in the image.
abstract String[]	makeLaunchCommand(AbstractBootImage.NativeImageKind k, String imageName, Path binPath, Path workPath, Method method)
static String	mangleName(String methodName) Mangle the given method name according to our image's (default) mangling convention.
static String	methodFullNameAndDescriptor(Method m, boolean includeReturnType) Given a java.lang.reflect.Method, compute a "full name" including its classname and method descriptor.
protected void	write(Path outputFile)

Methods inherited from class com.oracle.svm.hosted.image.AbstractBootImage

create, getBootImageKind, getCodeCache, getHeap, getImageSize, getKind, getNativeLibs, requiresCustomDebugRelocation, write

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeBootImage

public NativeBootImage(AbstractBootImage.NativeImageKind k,
                       HostedUniverse universe,
                       HostedMetaAccess metaAccess,
                       NativeLibraries nativeLibs,
                       NativeImageHeap heap,
                       NativeImageCodeCache codeCache,
                       List<HostedMethod> entryPoints,
                       HostedMethod mainEntryPoint,
                       ClassLoader imageClassLoader)

Method Detail

getTextSection

public com.oracle.objectfile.ObjectFile.Section getTextSection()

Description copied from class: AbstractBootImage

Returns the ObjectFile.Section within the image, if any, whose vaddr defines the image's base vaddr.

Specified by:

getTextSection in class AbstractBootImage

makeLaunchCommand

public abstract String[] makeLaunchCommand(AbstractBootImage.NativeImageKind k,
                                           String imageName,
                                           Path binPath,
                                           Path workPath,
                                           Method method)

Specified by:

makeLaunchCommand in class AbstractBootImage

write

protected final void write(Path outputFile)

build

public void build(org.graalvm.compiler.debug.DebugContext debug)

Create the image sections for code, constants, and the heap.

Specified by:

build in class AbstractBootImage

methodFullNameAndDescriptor

public static String methodFullNameAndDescriptor(Method m,
                                                 boolean includeReturnType)

Given a java.lang.reflect.Method, compute a "full name" including its classname and method descriptor.

Parameters:

m - a method

includeReturnType - TODO

Returns:

the full name (including classname and descriptor) of m

localSymbolNameForMethod

public static String localSymbolNameForMethod(Method m)

Given a java.lang.reflect.Method, compute the symbol name of its start address (if any) in the image. The symbol name returned is the one that would be used for local references (e.g. for relocation), so is guaranteed to exist if the method is in the image. However, it is not necessarily visible for linking from other objects.

Parameters:

m - a java.lang.reflect.Method

Returns:

its symbol name as it would appear in the image (regardless of whether it actually does)

localSymbolNameForMethod

public static String localSymbolNameForMethod(jdk.vm.ci.meta.ResolvedJavaMethod sm)

Given a ResolvedJavaMethod, compute what symbol name of its start address (if any) in the image. The symbol name returned is the one that would be used for local references (e.g. for relocation), so is guaranteed to exist if the method is in the image. However, it is not necessarily visible for linking from other objects.

Parameters:

sm - a SubstrateMethod

Returns:

its symbol name as it would appear in the image (regardless of whether it actually does)

globalSymbolNameForMethod

public static String globalSymbolNameForMethod(Method m)

Given a java.lang.reflect.Method, compute the symbol name of its entry point (if any) in the image. The symbol name returned is one that would be used for external references (e.g. for linking) and for method lookup by signature. If multiple methods with the same signature are present in the image, the returned symbol name is not guaranteed to resolve to the method being passed.

Parameters:

m - a java.lang.reflect.Method

Returns:

its symbol name as it would appear in the image (regardless of whether it actually does)

globalSymbolNameForMethod

public static String globalSymbolNameForMethod(jdk.vm.ci.meta.ResolvedJavaMethod sm)

Given a ResolvedJavaMethod, compute what symbol name of its entry point (if any) in the image. The symbol name returned is one that would be used for external references (e.g. for linking) and for method lookup by signature. If multiple methods with the same signature are present in the image, the returned symbol name is not guaranteed to resolve to the method being passed.

Parameters:

sm - a SubstrateMethod

Returns:

its symbol name as it would appear in the image (regardless of whether it actually does)

getMethodDescriptor

public static String getMethodDescriptor(Method m,
                                         boolean includeReturnType)

Return the Java bytecode method descriptor for a java.lang.reflect.Method. (Perhaps surprisingly, this seems not to be exposed by java.lang.reflect, so we implement it here.)

Parameters:

m - a method

includeReturnType - whether the descriptor string should include the return type

Returns:

its descriptor (as defined by the Java class file format), describing its argument and, if includeReturnType is true, its return type. Does not include the name of the method, class or package.

mangleName

public static String mangleName(String methodName)

Mangle the given method name according to our image's (default) mangling convention. A rough requirement is that symbol names are valid symbol name tokens for the assembler. (This is necessary to use them in linker command lines, which we currently do in NativeImageGenerator.) These are of the form '[a-zA-Z\._\$][a-zA-Z0-9\$_]*'. We use the underscore sign as an escape character. It is always followed by four hex digits representing the escaped character in natural (big-endian) order. We do not allow the dollar sign, even though it is legal, because it has special meaning in some shells and disturbs command lines.

Parameters:

methodName - a string to mangle

Returns:

a mangled version of methodName

getOrCreateDebugObjectFile

public com.oracle.objectfile.ObjectFile getOrCreateDebugObjectFile()

Specified by:

getOrCreateDebugObjectFile in class AbstractBootImage