Package org.lwjgl.llvm

Class LLVMObject

java.lang.Object

org.lwjgl.llvm.LLVMObject

public class LLVMObject
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LLVMObject.Functions	Contains the function pointers loaded from LLVMCore.getLibrary().

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LLVMBinaryTypeArchive	LLVMBinaryType
static final int	LLVMBinaryTypeCOFF	LLVMBinaryType
static final int	LLVMBinaryTypeCOFFImportFile	LLVMBinaryType
static final int	LLVMBinaryTypeELF32B	LLVMBinaryType
static final int	LLVMBinaryTypeELF32L	LLVMBinaryType
static final int	LLVMBinaryTypeELF64B	LLVMBinaryType
static final int	LLVMBinaryTypeELF64L	LLVMBinaryType
static final int	LLVMBinaryTypeIR	LLVMBinaryType
static final int	LLVMBinaryTypeMachO32B	LLVMBinaryType
static final int	LLVMBinaryTypeMachO32L	LLVMBinaryType
static final int	LLVMBinaryTypeMachO64B	LLVMBinaryType
static final int	LLVMBinaryTypeMachO64L	LLVMBinaryType
static final int	LLVMBinaryTypeMachOUniversalBinary	LLVMBinaryType
static final int	LLVMBinaryTypeOffload	LLVMBinaryType
static final int	LLVMBinaryTypeWasm	LLVMBinaryType
static final int	LLVMBinaryTypeWinRes	LLVMBinaryType

Method Summary

Modifier and Type	Method	Description
static long	LLVMBinaryCopyMemoryBuffer(long BR)	Retrieves a copy of the memory buffer associated with this object file.
static int	LLVMBinaryGetType(long BR)	Retrieve the specific type of a binary.
static long	LLVMCreateBinary(long MemBuf, long Context, org.lwjgl.PointerBuffer ErrorMessage)	Create a binary file from the given memory buffer.
static long	LLVMCreateObjectFile(long MemBuf)	Deprecated: use CreateBinary instead.
static void	LLVMDisposeBinary(long BR)	Dispose of a binary file.
static void	LLVMDisposeObjectFile(long ObjectFile)	Deprecated: use DisposeBinary instead.
static void	LLVMDisposeRelocationIterator(long RI)
static void	LLVMDisposeSectionIterator(long SI)
static void	LLVMDisposeSymbolIterator(long SI)
static long	LLVMGetRelocationOffset(long RI)
static long	LLVMGetRelocations(long Section)
static long	LLVMGetRelocationSymbol(long RI)
static long	LLVMGetRelocationType(long RI)
static @Nullable String	LLVMGetRelocationTypeName(long RI)
static @Nullable String	LLVMGetRelocationValueString(long RI)
static long	LLVMGetSectionAddress(long SI)
static boolean	LLVMGetSectionContainsSymbol(long SI, long Sym)
static @Nullable String	LLVMGetSectionContents(long SI)
static @Nullable String	LLVMGetSectionName(long SI)
static long	LLVMGetSections(long ObjectFile)	Deprecated: Use ObjectFileCopySectionIterator instead.
static long	LLVMGetSectionSize(long SI)
static long	LLVMGetSymbolAddress(long SI)
static @Nullable String	LLVMGetSymbolName(long SI)
static long	LLVMGetSymbols(long ObjectFile)	Deprecated: Use ObjectFileCopySymbolIterator instead.
static long	LLVMGetSymbolSize(long SI)
static boolean	LLVMIsRelocationIteratorAtEnd(long Section, long RI)
static boolean	LLVMIsSectionIteratorAtEnd(long ObjectFile, long SI)	Deprecated: Use ObjectFileIsSectionIteratorAtEnd instead.
static boolean	LLVMIsSymbolIteratorAtEnd(long ObjectFile, long SI)	Deprecated: Use ObjectFileIsSymbolIteratorAtEnd instead.
static long	LLVMMachOUniversalBinaryCopyObjectForArch(long BR, CharSequence Arch, org.lwjgl.PointerBuffer ErrorMessage)	For a Mach-O universal binary file, retrieves the object file corresponding to the given architecture if it is present as a slice.
static long	LLVMMachOUniversalBinaryCopyObjectForArch(long BR, ByteBuffer Arch, org.lwjgl.PointerBuffer ErrorMessage)	For a Mach-O universal binary file, retrieves the object file corresponding to the given architecture if it is present as a slice.
static void	LLVMMoveToContainingSection(long Sect, long Sym)
static void	LLVMMoveToNextRelocation(long RI)
static void	LLVMMoveToNextSection(long SI)
static void	LLVMMoveToNextSymbol(long SI)
static long	LLVMObjectFileCopySectionIterator(long BR)	Retrieve a copy of the section iterator for this object file.
static long	LLVMObjectFileCopySymbolIterator(long BR)	Retrieve a copy of the symbol iterator for this object file.
static boolean	LLVMObjectFileIsSectionIteratorAtEnd(long BR, long SI)	Returns whether the given section iterator is at the end.
static boolean	LLVMObjectFileIsSymbolIteratorAtEnd(long BR, long SI)	Returns whether the given symbol iterator is at the end.
static long	nLLVMCreateBinary(long MemBuf, long Context, long ErrorMessage)	Unsafe version of: CreateBinary
static long	nLLVMGetRelocationTypeName(long RI)
static long	nLLVMGetRelocationValueString(long RI)
static long	nLLVMGetSectionContents(long SI)
static long	nLLVMGetSectionName(long SI)
static long	nLLVMGetSymbolName(long SI)
static long	nLLVMMachOUniversalBinaryCopyObjectForArch(long BR, long Arch, long ArchLen, long ErrorMessage)	Unsafe version of: MachOUniversalBinaryCopyObjectForArch

Methods inherited from class java.lang.Object

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

Field Details

LLVMBinaryTypeArchive

public static final int LLVMBinaryTypeArchive

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeMachOUniversalBinary

public static final int LLVMBinaryTypeMachOUniversalBinary

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeCOFFImportFile

public static final int LLVMBinaryTypeCOFFImportFile

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeIR

public static final int LLVMBinaryTypeIR

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeWinRes

public static final int LLVMBinaryTypeWinRes

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeCOFF

public static final int LLVMBinaryTypeCOFF

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeELF32L

public static final int LLVMBinaryTypeELF32L

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeELF32B

public static final int LLVMBinaryTypeELF32B

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeELF64L

public static final int LLVMBinaryTypeELF64L

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeELF64B

public static final int LLVMBinaryTypeELF64B

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeMachO32L

public static final int LLVMBinaryTypeMachO32L

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeMachO32B

public static final int LLVMBinaryTypeMachO32B

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeMachO64L

public static final int LLVMBinaryTypeMachO64L

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeMachO64B

public static final int LLVMBinaryTypeMachO64B

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeWasm

public static final int LLVMBinaryTypeWasm

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

LLVMBinaryTypeOffload

public static final int LLVMBinaryTypeOffload

LLVMBinaryType

Enum values:

• BinaryTypeArchive
• BinaryTypeMachOUniversalBinary
• BinaryTypeCOFFImportFile
• BinaryTypeIR
• BinaryTypeWinRes
• BinaryTypeCOFF
• BinaryTypeELF32L
• BinaryTypeELF32B
• BinaryTypeELF64L
• BinaryTypeELF64B
• BinaryTypeMachO32L
• BinaryTypeMachO32B
• BinaryTypeMachO64L
• BinaryTypeMachO64B
• BinaryTypeWasm
• BinaryTypeOffload

See Also:

• Constant Field Values

Method Details

nLLVMCreateBinary

public static long nLLVMCreateBinary(long MemBuf,
 long Context,
 long ErrorMessage)

Unsafe version of: CreateBinary

LLVMCreateBinary

public static long LLVMCreateBinary(long MemBuf,
 long Context,
 org.lwjgl.PointerBuffer ErrorMessage)

Create a binary file from the given memory buffer.

The exact type of the binary file will be inferred automatically, and the appropriate implementation selected. The context may be NULL except if the resulting file is an LLVM IR file.

The memory buffer is not consumed by this function. It is the responsibilty of the caller to free it with DisposeMemoryBuffer.

If NULL is returned, the ErrorMessage parameter is populated with the error's description. It is then the caller's responsibility to free this message by calling DisposeMessage.

LLVMDisposeBinary

public static void LLVMDisposeBinary(long BR)

Dispose of a binary file.

The binary file does not own its backing buffer. It is the responsibilty of the caller to free it with DisposeMemoryBuffer.

LLVMBinaryCopyMemoryBuffer

public static long LLVMBinaryCopyMemoryBuffer(long BR)

Retrieves a copy of the memory buffer associated with this object file.

The returned buffer is merely a shallow copy and does not own the actual backing buffer of the binary. Nevertheless, it is the responsibility of the caller to free it with DisposeMemoryBuffer.

LLVMBinaryGetType

public static int LLVMBinaryGetType(long BR)

Retrieve the specific type of a binary.

nLLVMMachOUniversalBinaryCopyObjectForArch

public static long nLLVMMachOUniversalBinaryCopyObjectForArch(long BR,
 long Arch,
 long ArchLen,
 long ErrorMessage)

Unsafe version of: MachOUniversalBinaryCopyObjectForArch

LLVMMachOUniversalBinaryCopyObjectForArch

public static long LLVMMachOUniversalBinaryCopyObjectForArch(long BR,
 ByteBuffer Arch,
 org.lwjgl.PointerBuffer ErrorMessage)

For a Mach-O universal binary file, retrieves the object file corresponding to the given architecture if it is present as a slice.

If NULL is returned, the ErrorMessage parameter is populated with the error's description. It is then the caller's responsibility to free this message by calling DisposeMessage.

It is the responsiblity of the caller to free the returned object file by calling DisposeBinary.

LLVMMachOUniversalBinaryCopyObjectForArch

public static long LLVMMachOUniversalBinaryCopyObjectForArch(long BR,
 CharSequence Arch,
 org.lwjgl.PointerBuffer ErrorMessage)

For a Mach-O universal binary file, retrieves the object file corresponding to the given architecture if it is present as a slice.

If NULL is returned, the ErrorMessage parameter is populated with the error's description. It is then the caller's responsibility to free this message by calling DisposeMessage.

It is the responsiblity of the caller to free the returned object file by calling DisposeBinary.

LLVMObjectFileCopySectionIterator

public static long LLVMObjectFileCopySectionIterator(long BR)

Retrieve a copy of the section iterator for this object file.

If there are no sections, the result is NULL.

The returned iterator is merely a shallow copy. Nevertheless, it is the responsibility of the caller to free it with DisposeSectionIterator.

LLVMObjectFileIsSectionIteratorAtEnd

public static boolean LLVMObjectFileIsSectionIteratorAtEnd(long BR,
 long SI)

Returns whether the given section iterator is at the end.

LLVMObjectFileCopySymbolIterator

public static long LLVMObjectFileCopySymbolIterator(long BR)

Retrieve a copy of the symbol iterator for this object file.

If there are no symbols, the result is NULL.

The returned iterator is merely a shallow copy. Nevertheless, it is the responsibility of the caller to free it with DisposeSymbolIterator.

LLVMObjectFileIsSymbolIteratorAtEnd

public static boolean LLVMObjectFileIsSymbolIteratorAtEnd(long BR,
 long SI)

Returns whether the given symbol iterator is at the end.

LLVMDisposeSectionIterator

public static void LLVMDisposeSectionIterator(long SI)

LLVMMoveToNextSection

public static void LLVMMoveToNextSection(long SI)

LLVMMoveToContainingSection

public static void LLVMMoveToContainingSection(long Sect,
 long Sym)

LLVMDisposeSymbolIterator

public static void LLVMDisposeSymbolIterator(long SI)

LLVMMoveToNextSymbol

public static void LLVMMoveToNextSymbol(long SI)

nLLVMGetSectionName

public static long nLLVMGetSectionName(long SI)

LLVMGetSectionName

public static @Nullable String LLVMGetSectionName(long SI)

LLVMGetSectionSize

public static long LLVMGetSectionSize(long SI)

nLLVMGetSectionContents

public static long nLLVMGetSectionContents(long SI)

LLVMGetSectionContents

public static @Nullable String LLVMGetSectionContents(long SI)

LLVMGetSectionAddress

public static long LLVMGetSectionAddress(long SI)

LLVMGetSectionContainsSymbol

public static boolean LLVMGetSectionContainsSymbol(long SI,
 long Sym)

LLVMGetRelocations

public static long LLVMGetRelocations(long Section)

LLVMDisposeRelocationIterator

public static void LLVMDisposeRelocationIterator(long RI)

LLVMIsRelocationIteratorAtEnd

public static boolean LLVMIsRelocationIteratorAtEnd(long Section,
 long RI)

LLVMMoveToNextRelocation

public static void LLVMMoveToNextRelocation(long RI)

nLLVMGetSymbolName

public static long nLLVMGetSymbolName(long SI)

LLVMGetSymbolName

public static @Nullable String LLVMGetSymbolName(long SI)

LLVMGetSymbolAddress

public static long LLVMGetSymbolAddress(long SI)

LLVMGetSymbolSize

public static long LLVMGetSymbolSize(long SI)

LLVMGetRelocationOffset

public static long LLVMGetRelocationOffset(long RI)

LLVMGetRelocationSymbol

public static long LLVMGetRelocationSymbol(long RI)

LLVMGetRelocationType

public static long LLVMGetRelocationType(long RI)

nLLVMGetRelocationTypeName

public static long nLLVMGetRelocationTypeName(long RI)

LLVMGetRelocationTypeName

public static @Nullable String LLVMGetRelocationTypeName(long RI)

nLLVMGetRelocationValueString

public static long nLLVMGetRelocationValueString(long RI)

LLVMGetRelocationValueString

public static @Nullable String LLVMGetRelocationValueString(long RI)

LLVMCreateObjectFile

public static long LLVMCreateObjectFile(long MemBuf)

Deprecated: use CreateBinary instead.

LLVMDisposeObjectFile

public static void LLVMDisposeObjectFile(long ObjectFile)

Deprecated: use DisposeBinary instead.

LLVMGetSections

public static long LLVMGetSections(long ObjectFile)

Deprecated: Use ObjectFileCopySectionIterator instead.

LLVMIsSectionIteratorAtEnd

public static boolean LLVMIsSectionIteratorAtEnd(long ObjectFile,
 long SI)

Deprecated: Use ObjectFileIsSectionIteratorAtEnd instead.

LLVMGetSymbols

public static long LLVMGetSymbols(long ObjectFile)

Deprecated: Use ObjectFileCopySymbolIterator instead.

LLVMIsSymbolIteratorAtEnd

public static boolean LLVMIsSymbolIteratorAtEnd(long ObjectFile,
 long SI)

Deprecated: Use ObjectFileIsSymbolIteratorAtEnd instead.