PhysicalRegisterSet (Jikes RVM API)

java.lang.Object
- org.jikesrvm.compilers.opt.ir.GenericPhysicalRegisterSet
- - org.jikesrvm.compilers.opt.ir.ppc.PhysicalRegisterSet

All Implemented Interfaces:

BitSetMapping
```
public final class PhysicalRegisterSet
extends GenericPhysicalRegisterSet
```
This class represents a set of Registers corresponding to the PowerPC register set.
Implementation Notes:
Due to some historical ugliness not yet cleaned up, the register allocator depend on properties cached in the next field of Register. The constructor sets the following properties:
- The volatile GPRs form a linked list, starting with FIRST_VOLATILE_GPR and ending with LAST_SCRATCH_GPR
- The volatile FPRs form a linked list, starting with FIRST_VOLATILE_FPR and ending with LAST_SCRATCH_FPR
- The non-volatile GPRs form a linked list, starting with FIRST_NONVOLATILE_GPR and ending with LAST_NONVOLATILE_GPR
- The non-volatile FPRs form a linked list, starting with FIRST_NONVOLATILE_FPR and ending with LAST_NONVOLATILE_FPR
- The condition registers from a linked list, starting with FIRST_CONDITION and ending with LAST_CONDITION-1, which opt reserves for yieldpoints.
The register allocator allocates registers according to the order in these lists. For volatile registers, it traverses the lists in order, starting with getFirstVolatile() and traversing with getNext(). For non-volatiles, it traverses the lists Backwards , starting with getLastNonvolatile() and using getPrev().
TODO; clean up all this and provide appropriate enumerators

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class PhysicalRegisterSet.PhysicalRegisterEnumeration
An enumerator for use by the physical register utilities.

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`PhysicalRegisterSet.PhysicalRegisterEnumeration` An enumerator for use by the physical register utilities.

Field Summary

Fields
Modifier and Type	Field and Description
`private static int[]`	`CR_NUMS` The condition registers that we allocate To avoid expensive save/restores when making a JNI transition Jikes RVM only uses the CR that the 64 bit PowerPC ELF ABI defines to be volatile.
`private Register[]`	`reg` This array holds a pool of objects representing physical registers
`private static String[]`	`registerName` register names for each class. used in printing the IR The indices for "FP" and "JTOC" should always match the final static values of int FP and int JTOC defined below.
`(package private) static int`	`TEMP`
`private static int`	`TSR_REG`
`private BitSet`	`volatileSet` The set of volatile registers; cached for efficiency

Constructor Summary

Constructors
Constructor and Description

PhysicalRegisterSet()
Constructor: set up a pool of physical registers.

Constructors
Constructor and Description
`PhysicalRegisterSet()` Constructor: set up a pool of physical registers.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Enumeration<Register>`	`enumerateAll()`
`Enumeration<Register>`	`enumerateFPRParameters(int n)` Enumerates the first n FPR parameters.
`Enumeration<Register>`	`enumerateGPRParameters(int n)` Enumerate the first n GPR parameters.
`Enumeration<Register>`	`enumerateGPRs()`
`Enumeration<Register>`	`enumerateNonvolatileConditionRegisters()` Enumerates the non-volatile physical condition registers.
`Enumeration<Register>`	`enumerateNonvolatileFPRs()`
`Enumeration<Register>`	`enumerateNonvolatileGPRs()`
`Enumeration<Register>`	`enumerateNonvolatileGPRsBackwards()`
`Enumeration<Register>`	`enumerateNonvolatiles(int regClass)` Enumerate the nonvolatile physical registers of a given class.
`Enumeration<Register>`	`enumerateNonvolatilesBackwards(int regClass)`
`Enumeration<Register>`	`enumerateVolatileConditionRegisters()` Enumerates the volatile physical condition registers.
`Enumeration<Register>`	`enumerateVolatileFPRs()` Enumerates all the volatile FPRs in this set.
`Enumeration<Register>`	`enumerateVolatileGPRs()`
`Enumeration<Register>`	`enumerateVolatiles()`
`Enumeration<Register>`	`enumerateVolatiles(int regClass)` Enumerate the volatile physical registers of a given class.
`Register`	`get(int n)`
`Register`	`getConditionRegister(int n)`
`Register`	`getCR()`
`Register`	`getCTR()`
`Register`	`getFirstConditionRegister()`
`Register`	`getFirstNonvolatileFPR()`
`Register`	`getFirstNonvolatileGPR()`
`Register`	`getFirstReturnGPR()`
`Register`	`getFirstScratchFPR()`
`Register`	`getFirstScratchGPR()`
`Register`	`getFirstVolatile(int regClass)`
`Register`	`getFirstVolatileConditionRegister()`
`Register`	`getFirstVolatileFPR()`
`Register`	`getFirstVolatileGPR()`
`Register`	`getFP()`
`Register`	`getFPR(int n)`
`int`	`getFPRParamIndex(Register r)`
`Register`	`getGPR(int n)`
`Register`	`getGPR(MachineRegister n)`
`int`	`getGPRParamIndex(Register r)`
`Register`	`getJTOC()`
`Register`	`getLastNonvolatile(int regClass)`
`Register`	`getLastNonvolatileFPR()`
`Register`	`getLastNonvolatileGPR()`
`Register`	`getLastScratchFPR()`
`Register`	`getLastScratchGPR()`
`Register`	`getLR()`
`static String`	`getName(int number)`
`static int`	`getNumberOfNonvolatileFPRs()`
`static int`	`getNumberOfNonvolatileGPRs()`
`int`	`getNumberOfPhysicalRegisters()`
`static int`	`getPhysicalRegisterType(Register r)` Given a symbolic register, return a cdoe that gives the physical register type to hold the value of the symbolic register.
`Register`	`getSecondHalf(Register r)`
`static int`	`getSize()`
`static int`	`getSpillAlignment(int type)` Gets the required spill alignment for a register with a particular type
`static int`	`getSpillSize(int type)` Gets the spill size for a register with a particular type
`byte`	`getSPR(Register r)` Given a physical register (XER, LR, or CTR), return the integer that denotes the PowerPC Special Purpose Register (SPR) in the PPC instruction set.
`Register`	`getTemp()`
`Register`	`getTL()`
`Register`	`getTR()`
`Register`	`getTSR()`
`Register`	`getTU()`
`BitSet`	`getVolatiles()`
`Register`	`getXER()`
`boolean`	`isAllocatable(Register r)` Is a certain physical register allocatable?

Methods inherited from class org.jikesrvm.compilers.opt.ir.GenericPhysicalRegisterSet
asIA32, asPPC, enumerateNonvolatileFPRsBackwards, getMappedIndex, getMappedObject, getMappingSize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - reg
```
private final Register[] reg
```
    This array holds a pool of objects representing physical registers
  - volatileSet
```
private final BitSet volatileSet
```
    The set of volatile registers; cached for efficiency
  - CR_NUMS
```
private static final int[] CR_NUMS
```
    The condition registers that we allocate To avoid expensive save/restores when making a JNI transition Jikes RVM only uses the CR that the 64 bit PowerPC ELF ABI defines to be volatile. We reserve one of the volatiles, CR7 for use only in yieldpoints. This ensures that a yieldpoint won't bash an allocated CR.
  - TSR_REG
```
private static final int TSR_REG
```
    See Also:
    
    Constant Field Values
  - registerName
```
private static final String[] registerName
```
    register names for each class. used in printing the IR The indices for "FP" and "JTOC" should always match the final static values of int FP and int JTOC defined below.
  - TEMP
```
static final int TEMP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PhysicalRegisterSet
```
public PhysicalRegisterSet()
```
    Constructor: set up a pool of physical registers.
- Method Detail
  - getSize
```
public static int getSize()
```
    Returns:
    
    the total number of physical registers.
  - getNumberOfPhysicalRegisters
```
public int getNumberOfPhysicalRegisters()
```
    Specified by:
    
    getNumberOfPhysicalRegisters in class GenericPhysicalRegisterSet
    
    Returns:
    
    the total number of physical registers.
  - getNumberOfNonvolatileGPRs
```
public static int getNumberOfNonvolatileGPRs()
```
    Returns:
    
    the total number of nonvolatile GPRs.
  - getNumberOfNonvolatileFPRs
```
public static int getNumberOfNonvolatileFPRs()
```
    Returns:
    
    the total number of nonvolatile FPRs.
  - isAllocatable
```
public boolean isAllocatable(Register r)
```
    Is a certain physical register allocatable?
    
    Specified by:
    
    isAllocatable in class GenericPhysicalRegisterSet
    
    Parameters:
    
    r - the register in question
    
    Returns:
    
    whether the register is subject to allocation
  - getXER
```
public Register getXER()
```
    Returns:
    
    the XER register.
  - getLR
```
public Register getLR()
```
    Returns:
    
    the LR register;.
  - getCTR
```
public Register getCTR()
```
    Returns:
    
    the CTR register
  - getTU
```
public Register getTU()
```
    Returns:
    
    the TU register
  - getTL
```
public Register getTL()
```
    Returns:
    
    the TL register
  - getCR
```
public Register getCR()
```
    Returns:
    
    the CR register
  - getJTOC
```
public Register getJTOC()
```
    Returns:
    
    the JTOC register
  - getFP
```
public Register getFP()
```
    Specified by:
    
    getFP in class GenericPhysicalRegisterSet
    
    Returns:
    
    the FP register
  - getTR
```
public Register getTR()
```
    Specified by:
    
    getTR in class GenericPhysicalRegisterSet
    
    Returns:
    
    the thread register
  - getTSR
```
public Register getTSR()
```
    Returns:
    
    the thread-switch register
  - getGPR
```
public Register getGPR(int n)
```
    Specified by:
    
    getGPR in class GenericPhysicalRegisterSet
  - getGPR
```
public Register getGPR(MachineRegister n)
```
    Specified by:
    
    getGPR in class GenericPhysicalRegisterSet
    
    Parameters:
    
    n - a register
    
    Returns:
    
    the nth physical GPR
  - getFirstScratchGPR
```
public Register getFirstScratchGPR()
```
    Returns:
    
    the first scratch GPR
  - getLastScratchGPR
```
public Register getLastScratchGPR()
```
    Returns:
    
    the last scratch GPR
  - getFirstVolatileGPR
```
public Register getFirstVolatileGPR()
```
    Returns:
    
    the first volatile GPR
  - getFirstNonvolatileGPR
```
public Register getFirstNonvolatileGPR()
```
    Returns:
    
    the first nonvolatile GPR
  - getLastNonvolatileGPR
```
public Register getLastNonvolatileGPR()
```
    Returns:
    
    the last nonvolatile GPR
  - getFirstReturnGPR
```
public Register getFirstReturnGPR()
```
    Specified by:
    
    getFirstReturnGPR in class GenericPhysicalRegisterSet
    
    Returns:
    
    the first GPR return
  - getFPR
```
public Register getFPR(int n)
```
    Specified by:
    
    getFPR in class GenericPhysicalRegisterSet
  - getFirstScratchFPR
```
public Register getFirstScratchFPR()
```
    Returns:
    
    the first scratch FPR
  - getFirstVolatileFPR
```
public Register getFirstVolatileFPR()
```
    Returns:
    
    the first volatile FPR
  - getLastScratchFPR
```
public Register getLastScratchFPR()
```
    Returns:
    
    the last scratch FPR
  - getFirstNonvolatileFPR
```
public Register getFirstNonvolatileFPR()
```
    Returns:
    
    the first nonvolatile FPR
  - getLastNonvolatileFPR
```
public Register getLastNonvolatileFPR()
```
    Returns:
    
    the last nonvolatile FPR
  - getConditionRegister
```
public Register getConditionRegister(int n)
```
    Parameters:
    
    n - number of the condition register
    
    Returns:
    
    the nth physical condition register
  - getFirstConditionRegister
```
public Register getFirstConditionRegister()
```
    Returns:
    
    the first condition
  - getFirstVolatileConditionRegister
```
public Register getFirstVolatileConditionRegister()
```
    Returns:
    
    the first volatile CR
  - get
```
public Register get(int n)
```
    Specified by:
    
    get in class GenericPhysicalRegisterSet
    
    Parameters:
    
    n - register number
    
    Returns:
    
    the nth physical register in the pool.
  - getFirstVolatile
```
public Register getFirstVolatile(int regClass)
```
    Parameters:
    
    regClass - one of INT_REG, DOUBLE_REG, CONDITION_REG, or SPECIAL_REG
    
    Returns:
    
    the first volatile physical register of a given class
  - getLastNonvolatile
```
public Register getLastNonvolatile(int regClass)
```
    Parameters:
    
    regClass - one of INT_REG, DOUBLE_REG, CONDITION_REG, or SPECIAL_REG
    
    Returns:
    
    the first nonvolatile physical register of a given class
  - getPhysicalRegisterType
```
public static int getPhysicalRegisterType(Register r)
```
    Given a symbolic register, return a cdoe that gives the physical register type to hold the value of the symbolic register.
    
    Parameters:
    
    r - a symbolic register
    
    Returns:
    
    one of INT_REG, DOUBLE_REG, or CONDITION_REG
  - getSPR
```
public byte getSPR(Register r)
```
    Given a physical register (XER, LR, or CTR), return the integer that denotes the PowerPC Special Purpose Register (SPR) in the PPC instruction set. See p.129 of PPC ISA book
    
    Parameters:
    
    r - a physical register (XER, LR or CTR)
    
    Returns:
    
    the integer that denotes the PowerPC Special Purpose Register (SPR) in the PPC instruction set.
  - getTemp
```
public Register getTemp()
```
    Returns:
    
    R0, a temporary register
  - getName
```
public static String getName(int number)
```
    Parameters:
    
    number - a register number
    
    Returns:
    
    the register name for a register with a particular number in the pool
  - getSpillSize
```
public static int getSpillSize(int type)
```
    Gets the spill size for a register with a particular type
    
    Parameters:
    
    type - one of INT_REG, DOUBLE_REG, CONDITION_REG, SPECIAL_REG
    
    Returns:
    
    the spill size in bytes
  - getSpillAlignment
```
public static int getSpillAlignment(int type)
```
    Gets the required spill alignment for a register with a particular type
    
    Parameters:
    
    type - one of INT_REG, DOUBLE_REG, CONDITION_REG, SPECIAL_REG
    
    Returns:
    
    the alignment in bytes
  - enumerateAll
```
public Enumeration<Register> enumerateAll()
```
    Specified by:
    
    enumerateAll in class GenericPhysicalRegisterSet
  - enumerateGPRs
```
public Enumeration<Register> enumerateGPRs()
```
    Specified by:
    
    enumerateGPRs in class GenericPhysicalRegisterSet
  - enumerateVolatileGPRs
```
public Enumeration<Register> enumerateVolatileGPRs()
```
    Specified by:
    
    enumerateVolatileGPRs in class GenericPhysicalRegisterSet
  - enumerateGPRParameters
```
public Enumeration<Register> enumerateGPRParameters(int n)
```
    Enumerate the first n GPR parameters.
    
    Parameters:
    
    n - count of GPR parameters to enumerate
    
    Returns:
    
    enumeration of the first n GPR parameters
  - enumerateNonvolatileGPRs
```
public Enumeration<Register> enumerateNonvolatileGPRs()
```
    Specified by:
    
    enumerateNonvolatileGPRs in class GenericPhysicalRegisterSet
  - enumerateNonvolatileGPRsBackwards
```
public Enumeration<Register> enumerateNonvolatileGPRsBackwards()
```
    Overrides:
    
    enumerateNonvolatileGPRsBackwards in class GenericPhysicalRegisterSet
  - enumerateVolatileFPRs
```
public Enumeration<Register> enumerateVolatileFPRs()
```
    Enumerates all the volatile FPRs in this set. NOTE: This assumes the scratch FPRs are numbered immediately before the volatile FPRs.
    
    Specified by:
    
    enumerateVolatileFPRs in class GenericPhysicalRegisterSet
    
    Returns:
    
    an enumeration containing all volatile FPRs in this set
  - enumerateFPRParameters
```
public Enumeration<Register> enumerateFPRParameters(int n)
```
    Enumerates the first n FPR parameters.
    
    Parameters:
    
    n - count of FPR parameters
    
    Returns:
    
    an enumeration containing the firs n FPRs
  - enumerateNonvolatileFPRs
```
public Enumeration<Register> enumerateNonvolatileFPRs()
```
    Specified by:
    
    enumerateNonvolatileFPRs in class GenericPhysicalRegisterSet
  - enumerateVolatileConditionRegisters
```
public Enumeration<Register> enumerateVolatileConditionRegisters()
```
    Enumerates the volatile physical condition registers. Note that the TSR is non-volatile.
    
    Returns:
    
    an enumeration of the volatile condition registers
  - enumerateNonvolatileConditionRegisters
```
public Enumeration<Register> enumerateNonvolatileConditionRegisters()
```
    Enumerates the non-volatile physical condition registers. Note that only the TSR is non-volatile.
    
    Returns:
    
    an enumeration containing only TSR
  - enumerateVolatiles
```
public Enumeration<Register> enumerateVolatiles(int regClass)
```
    Enumerate the volatile physical registers of a given class.
    
    Specified by:
    
    enumerateVolatiles in class GenericPhysicalRegisterSet
    
    Parameters:
    
    regClass - one of INT_REG, DOUBLE_REG, CONDITION_REG
    
    Returns:
    
    enumeration containing the physical registers of the desired class
  - enumerateVolatiles
```
public Enumeration<Register> enumerateVolatiles()
```
    Specified by:
    
    enumerateVolatiles in class GenericPhysicalRegisterSet
  - getVolatiles
```
public BitSet getVolatiles()
```
    Returns:
    
    a set of all the volatile registers.
  - enumerateNonvolatiles
```
public Enumeration<Register> enumerateNonvolatiles(int regClass)
```
    Enumerate the nonvolatile physical registers of a given class.
    
    Parameters:
    
    regClass - one of INT_REG, DOUBLE_REG, CONDITION_REG
    
    Returns:
    
    the non-volatile physical registers of the given class
  - enumerateNonvolatilesBackwards
```
public Enumeration<Register> enumerateNonvolatilesBackwards(int regClass)
```
    Specified by:
    
    enumerateNonvolatilesBackwards in class GenericPhysicalRegisterSet
  - getGPRParamIndex
```
public int getGPRParamIndex(Register r)
```
    Parameters:
    
    r - a physical register
    
    Returns:
    
    If the passed in physical register r is used as a GPR parameter register, return the index into the GPR parameters for r. Otherwise, return -1;
  - getFPRParamIndex
```
public int getFPRParamIndex(Register r)
```
    Parameters:
    
    r - a physical register
    
    Returns:
    
    If the passed in physical register r is used as an FPR parameter register, return the index into the FPR parameters for r. Otherwise, return -1;
  - getSecondHalf
```
public Register getSecondHalf(Register r)
```
    Parameters:
    
    r - a register
    
    Returns:
    
    If r is used as the first half of a (long) register pair, return the second half of the pair.

Class PhysicalRegisterSet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.jikesrvm.compilers.opt.ir.GenericPhysicalRegisterSet

Methods inherited from class java.lang.Object

Field Detail

reg

volatileSet

CR_NUMS

TSR_REG

registerName

TEMP

Constructor Detail

PhysicalRegisterSet

Method Detail

getSize

getNumberOfPhysicalRegisters

getNumberOfNonvolatileGPRs

getNumberOfNonvolatileFPRs

isAllocatable

getXER

getLR

getCTR

getTU

getTL

getCR

getJTOC

getFP

getTR

getTSR

getGPR

getGPR

getFirstScratchGPR

getLastScratchGPR

getFirstVolatileGPR

getFirstNonvolatileGPR

getLastNonvolatileGPR

getFirstReturnGPR

getFPR

getFirstScratchFPR

getFirstVolatileFPR

getLastScratchFPR

getFirstNonvolatileFPR

getLastNonvolatileFPR

getConditionRegister

getFirstConditionRegister

getFirstVolatileConditionRegister

get

getFirstVolatile

getLastNonvolatile

getPhysicalRegisterType

getSPR

getTemp

getName

getSpillSize

getSpillAlignment

enumerateAll

enumerateGPRs

enumerateVolatileGPRs

enumerateGPRParameters

enumerateNonvolatileGPRs

enumerateNonvolatileGPRsBackwards

enumerateVolatileFPRs

enumerateFPRParameters

enumerateNonvolatileFPRs

enumerateVolatileConditionRegisters

enumerateNonvolatileConditionRegisters

enumerateVolatiles

enumerateVolatiles

getVolatiles

enumerateNonvolatiles

enumerateNonvolatilesBackwards

getGPRParamIndex

getFPRParamIndex

getSecondHalf