com.oracle.svm.core

Class SubstrateUtil

java.lang.Object

com.oracle.svm.core.SubstrateUtil

public class SubstrateUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SubstrateUtil.DiagnosticThunk The functional interface for a "thunk" that does not allocate.
static class	SubstrateUtil.DiagnosticThunkRegister
static class	SubstrateUtil.NativeImageLoadingShield
static interface	SubstrateUtil.Thunk The functional interface for a "thunk".

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	HOSTED Field that is true during native image generation, but false at run time.

Constructor Summary

Constructors

Constructor and Description
SubstrateUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	assertionsEnabled() Checks whether assertions are enabled in the VM.
static void	breakpoint(Object arg0)
static <T> T	cast(Object obj, Class<T> toType) The same as Class.cast(java.lang.Object).
static String	digest(String value)
static String	getArchitectureName()
static String[]	getArgs(int argc, org.graalvm.nativeimage.c.type.CCharPointerPointer argv) Convert C-style to Java-style command line arguments.
static FileDescriptor	getFileDescriptor(FileOutputStream out)
static String	getShellCommandString(List<String> cmd, boolean multiLine)
static boolean	isBuildingLibgraal()
static boolean	isInLibgraal()
static boolean	isPowerOf2(long value)
static boolean	isPrintDiagnosticsInProgress()
static String	mangleName(String methodName) Mangle the given method name according to our image's (default) mangling convention.
static void	printDiagnostics(Log log, org.graalvm.word.Pointer sp, org.graalvm.nativeimage.c.function.CodePointer ip) Prints extensive diagnostic information to the given Log.
static String	quoteShellArg(String arg) Reliably quote a string as a single shell command argument.
static String[]	split(String value, String separator) Similar to String.split(String) but with a fixed separator string instead of a regular expression.
static String[]	split(String value, String separator, int limit) Similar to String.split(String, int) but with a fixed separator string instead of a regular expression.
static org.graalvm.nativeimage.c.type.CCharPointer	strchr(org.graalvm.nativeimage.c.type.CCharPointer str, int c) Returns a pointer to the matched character or NULL if the character is not found.
static org.graalvm.word.UnsignedWord	strlen(org.graalvm.nativeimage.c.type.CCharPointer str) Returns the length of a C char* string.
static String	toHex(byte[] data)
static String	uniqueShortName(Member m) Returns a short, reasonably descriptive, but still unique name for the provided Method, Constructor, or Field.
static String	uniqueShortName(jdk.vm.ci.meta.ResolvedJavaMethod m) Returns a short, reasonably descriptive, but still unique name for the provided method.

Methods inherited from class java.lang.Object

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

Field Detail

HOSTED

public static final boolean HOSTED

Field that is true during native image generation, but false at run time.

Constructor Detail

SubstrateUtil

public SubstrateUtil()

Method Detail

getArchitectureName

public static String getArchitectureName()

isBuildingLibgraal

public static boolean isBuildingLibgraal()

Returns:

true if the standalone libgraal is being built instead of a normal SVM image.

isInLibgraal

public static boolean isInLibgraal()

Returns:

true if running in the standalone libgraal image.

quoteShellArg

public static String quoteShellArg(String arg)

Reliably quote a string as a single shell command argument.

getShellCommandString

public static String getShellCommandString(List<String> cmd,
                                           boolean multiLine)

getFileDescriptor

public static FileDescriptor getFileDescriptor(FileOutputStream out)

getArgs

public static String[] getArgs(int argc,
                               org.graalvm.nativeimage.c.type.CCharPointerPointer argv)

Convert C-style to Java-style command line arguments. The first C-style argument, which is always the executable file name, is ignored.

Parameters:

argc - the number of arguments in the argv array.

argv - a C char**.

Returns:

the command line argument strings in a Java string array.

strlen

public static org.graalvm.word.UnsignedWord strlen(org.graalvm.nativeimage.c.type.CCharPointer str)

Returns the length of a C char* string.

strchr

public static org.graalvm.nativeimage.c.type.CCharPointer strchr(org.graalvm.nativeimage.c.type.CCharPointer str,
                                                                 int c)

Returns a pointer to the matched character or NULL if the character is not found.

cast

public static <T> T cast(Object obj,
                         Class<T> toType)

The same as Class.cast(java.lang.Object). This method is available for use in places where either the Java compiler or static analysis tools would complain about a cast because the cast appears to violate the Java type system rules. The most prominent example are casts between a TargetClass and the original class, i.e., two classes that appear to be unrelated from the Java type system point of view, but are actually the same class.

assertionsEnabled

public static boolean assertionsEnabled()

Checks whether assertions are enabled in the VM.

Returns:

true if assertions are enabled.

breakpoint

public static void breakpoint(Object arg0)

isPowerOf2

public static boolean isPowerOf2(long value)

isPrintDiagnosticsInProgress

public static boolean isPrintDiagnosticsInProgress()

printDiagnostics

public static void printDiagnostics(Log log,
                                    org.graalvm.word.Pointer sp,
                                    org.graalvm.nativeimage.c.function.CodePointer ip)

Prints extensive diagnostic information to the given Log.

split

public static String[] split(String value,
                             String separator)

Similar to String.split(String) but with a fixed separator string instead of a regular expression. This avoids making regular expression code reachable.

split

public static String[] split(String value,
                             String separator,
                             int limit)

Similar to String.split(String, int) but with a fixed separator string instead of a regular expression. This avoids making regular expression code reachable.

toHex

public static String toHex(byte[] data)

digest

public static String digest(String value)

uniqueShortName

public static String uniqueShortName(jdk.vm.ci.meta.ResolvedJavaMethod m)

Returns a short, reasonably descriptive, but still unique name for the provided method. The name includes a digest of the fully qualified method name, which ensures uniqueness.

uniqueShortName

public static String uniqueShortName(Member m)

Returns a short, reasonably descriptive, but still unique name for the provided Method, Constructor, or Field. The name includes a digest of the fully qualified method name, which ensures uniqueness.

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