org.graalvm.compiler.asm.aarch64

Class AArch64Address

java.lang.Object

org.graalvm.compiler.asm.AbstractAddress

org.graalvm.compiler.asm.aarch64.AArch64Address

public final class AArch64Address
extends AbstractAddress

Represents an address in target machine memory, specified using one of the different addressing modes of the AArch64 ISA.

  - Base register only
  - Base register + immediate or register with shifted offset
  - Pre-indexed: base + immediate offset are written back to base register, value used in instruction is base + offset
  - Post-indexed: base + offset (immediate or register) are written back to base register, value used in instruction is base only
  - Literal: PC + 19-bit signed word aligned offset
 

Note not all addressing modes are supported for all instructions. For debugging purposes, the address also stores the expected size of the memory access it will be associated with in AArch64Address.bitMemoryTransferSize.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AArch64Address.AddressingMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_SIZE This means that AArch64Address.bitMemoryTransferSize is allowed to be any size.
static AArch64Address	PLACEHOLDER Placeholder for addresses that get patched later.

Method Summary

Modifier and Type	Method and Description
static AArch64Address	createAddress(int bitMemoryTransferSize, AArch64Address.AddressingMode addressingMode, Register base, Register offset, int immediate, boolean registerOffsetScaled, AArch64Assembler.ExtendType extendType) General address generation mechanism.
static AArch64Address	createBaseRegisterOnlyAddress(int bitMemoryTransferSize, Register base)
static AArch64Address	createExtendedRegisterOffsetAddress(int bitMemoryTransferSize, Register base, Register offset, boolean scaled, AArch64Assembler.ExtendType extendType)
static AArch64Address	createImmediateAddress(int bitMemoryTransferSize, AArch64Address.AddressingMode addressingMode, Register base, int immediate) Creates an address representing the requested immediate addressing mode.
static AArch64Address	createPairBaseRegisterOnlyAddress(int bitMemoryTransferSize, Register base)
static AArch64Address	createPCLiteralAddress(int bitMemoryTransferSize) AArch64Address specifying a PC-literal address of the form PC + imm21 Note that the imm21 offset is expected to be patched later.
static AArch64Address	createRegisterOffsetAddress(int bitMemoryTransferSize, Register base, Register offset, boolean scaled)
static AArch64Address	createStructureImmediatePostIndexAddress(AArch64ASIMDAssembler.ASIMDInstruction instruction, AArch64ASIMDAssembler.ASIMDSize size, AArch64ASIMDAssembler.ElementSize eSize, Register base, int immediate) AArch64Address specifying a structure memory access of the form "[Xn|SP], imm", where imm is a post-indexed value to add.
static AArch64Address	createStructureNoOffsetAddress(Register base) AArch64Address specifying a structure memory access of the form "[Xn|SP]".
static AArch64Address	createStructureRegisterPostIndexAddress(Register base, Register offset) AArch64Address specifying a structure memory access of the form "[Xn|SP], Xm", where Xm is a post-indexed value to add and cannot be either SP or ZR.
AArch64Address.AddressingMode	getAddressingMode()
Register	getBase()
int	getBitMemoryTransferSize()
AArch64Assembler.ExtendType	getExtendType()
int	getImmediate()
int	getImmediateRaw()
Register	getOffset()
static boolean	isImmediateScaled(AArch64Address.AddressingMode mode) Returns whether the immediate addressing mode being used scales the immediate operand.
static boolean	isOffsetAligned(int bitMemoryTransferSize, long offset) Checks whether the offset provided is aligned for a given memory operation size.
boolean	isRegisterOffsetScaled()
static boolean	isValidImmediateAddress(int bitMemoryTransferSize, AArch64Address.AddressingMode addressingMode, int immediate) Checks whether an immediate can be encoded within the provided immediate addressing mode.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ANY_SIZE

public static final int ANY_SIZE

This means that AArch64Address.bitMemoryTransferSize is allowed to be any size.

See Also:

Constant Field Values

PLACEHOLDER

public static final AArch64Address PLACEHOLDER

Placeholder for addresses that get patched later.

Method Detail

createAddress

public static AArch64Address createAddress(int bitMemoryTransferSize,
                                           AArch64Address.AddressingMode addressingMode,
                                           Register base,
                                           Register offset,
                                           int immediate,
                                           boolean registerOffsetScaled,
                                           AArch64Assembler.ExtendType extendType)

General address generation mechanism. Accepted values for all parameters depend on the addressingMode. Null is never accepted for a register, if an addressMode doesn't use a register the register has to be the zero-register. extendType has to be null for every addressingMode except EXTENDED_REGISTER_OFFSET.

isImmediateScaled

public static boolean isImmediateScaled(AArch64Address.AddressingMode mode)

Returns whether the immediate addressing mode being used scales the immediate operand.

isOffsetAligned

public static boolean isOffsetAligned(int bitMemoryTransferSize,
                                      long offset)

Checks whether the offset provided is aligned for a given memory operation size.

Parameters:

bitMemoryTransferSize - Memory operation size. This determines the alignment requirements.

offset - Value to be checked.

createImmediateAddress

public static AArch64Address createImmediateAddress(int bitMemoryTransferSize,
                                                    AArch64Address.AddressingMode addressingMode,
                                                    Register base,
                                                    int immediate)

Creates an address representing the requested immediate addressing mode. Note this method expects an unscaled immediate value and will fail if the provided immediate cannot be encoded within the requested addressing mode.

Parameters:

bitMemoryTransferSize - Memory operation size.

addressingMode - Immediate addressing mode to use.

base - Base register for memory operation. May not be null or the zero-register.

immediate - *Unscaled* immediate value to encode. All scaling needed is performed within this method

Returns:

Address encoding for the input operation.

isValidImmediateAddress

public static boolean isValidImmediateAddress(int bitMemoryTransferSize,
                                              AArch64Address.AddressingMode addressingMode,
                                              int immediate)

Checks whether an immediate can be encoded within the provided immediate addressing mode. This method expected an unscaled immediate value.

createBaseRegisterOnlyAddress

public static AArch64Address createBaseRegisterOnlyAddress(int bitMemoryTransferSize,
                                                           Register base)

Parameters:

bitMemoryTransferSize - Memory operation size.

base - May not be null or the zero register.

Returns:

an address specifying the address pointed to by base.

createRegisterOffsetAddress

public static AArch64Address createRegisterOffsetAddress(int bitMemoryTransferSize,
                                                         Register base,
                                                         Register offset,
                                                         boolean scaled)

Parameters:

bitMemoryTransferSize - Memory operation size.

base - may not be null or the zero-register.

offset - Register specifying some offset, optionally scaled by the byte_memory_transfer_size. May not be null or the stackpointer.

scaled - Specifies whether offset should be scaled by byte_memory_transfer_size or not.

Returns:

an address specifying a register offset address of the form base + offset [<< log2 (byte_memory_transfer_size)]

createExtendedRegisterOffsetAddress

public static AArch64Address createExtendedRegisterOffsetAddress(int bitMemoryTransferSize,
                                                                 Register base,
                                                                 Register offset,
                                                                 boolean scaled,
                                                                 AArch64Assembler.ExtendType extendType)

Parameters:

bitMemoryTransferSize - Memory operation size.

base - may not be null or the zero-register.

offset - Word register specifying some offset, optionally scaled by the byte_memory_transfer_size. May not be null or the stackpointer.

scaled - Specifies whether offset should be scaled by byte_memory_transfer_size or not.

extendType - Describes whether register is zero- or sign-extended. May not be null.

Returns:

an address specifying an extended register offset of the form base + extendType(offset) [<< log2(byte_memory_transfer_size)]

createPCLiteralAddress

public static AArch64Address createPCLiteralAddress(int bitMemoryTransferSize)

AArch64Address specifying a PC-literal address of the form PC + imm21 Note that the imm21 offset is expected to be patched later.

Parameters:

bitMemoryTransferSize - Memory operation size.

createPairBaseRegisterOnlyAddress

public static AArch64Address createPairBaseRegisterOnlyAddress(int bitMemoryTransferSize,
                                                               Register base)

Parameters:

bitMemoryTransferSize - Memory operation size.

base - May not be null or the zero register.

Returns:

an address specifying the address pointed to by base.

createStructureNoOffsetAddress

public static AArch64Address createStructureNoOffsetAddress(Register base)

AArch64Address specifying a structure memory access of the form "[Xn|SP]".

createStructureRegisterPostIndexAddress

public static AArch64Address createStructureRegisterPostIndexAddress(Register base,
                                                                     Register offset)

AArch64Address specifying a structure memory access of the form "[Xn|SP], Xm", where Xm is a post-indexed value to add and cannot be either SP or ZR.

createStructureImmediatePostIndexAddress

public static AArch64Address createStructureImmediatePostIndexAddress(AArch64ASIMDAssembler.ASIMDInstruction instruction,
                                                                      AArch64ASIMDAssembler.ASIMDSize size,
                                                                      AArch64ASIMDAssembler.ElementSize eSize,
                                                                      Register base,
                                                                      int immediate)

AArch64Address specifying a structure memory access of the form "[Xn|SP], imm", where imm is a post-indexed value to add. Note that the value of imm is dictated by the specific {instruction, size, eSize} combination. See #determineStructureImmediateValue(ASIMDInstruction, ASIMDSize, ElementSize) for what the expected value is.

getBitMemoryTransferSize

public int getBitMemoryTransferSize()

getBase

public Register getBase()

getOffset

public Register getOffset()

getImmediate

public int getImmediate()

Returns:

immediate in correct representation for the given addressing mode. For example in case of addressingMode ==IMMEDIATE_UNSCALED the value will be returned as the 9-bit signed representation.

getImmediateRaw

public int getImmediateRaw()

Returns:

Raw immediate as a 32-bit signed value.

isRegisterOffsetScaled

public boolean isRegisterOffsetScaled()

getExtendType

public AArch64Assembler.ExtendType getExtendType()

getAddressingMode

public AArch64Address.AddressingMode getAddressingMode()

toString

public String toString()

Overrides:

toString in class Object