PhysicalRegisterSet (Jikes RVM API)

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

All Implemented Interfaces:

BitSetMapping
```
public final class PhysicalRegisterSet
extends GenericPhysicalRegisterSet
```
This class represents a set of Registers corresponding to the IA32 register set.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`private BitSet`	`fpSet` Cache the set of floating-point registers for efficiency
`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
`private BitSet`	`volatileSet` Cache the set of volatile registers for efficiency

Constructor Summary

Constructors
Constructor and Description

PhysicalRegisterSet()

Constructors
Constructor and Description
`PhysicalRegisterSet()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Enumeration<Register>`	`enumerateAll()`
`Enumeration<Register>`	`enumerateFPRs()`
`Enumeration<Register>`	`enumerateGPRs()`
`PhysicalRegisterSet.PhysicalRegisterEnumeration`	`enumerateNonvolatileFPRs()`
`PhysicalRegisterSet.PhysicalRegisterEnumeration`	`enumerateNonvolatileGPRs()`
`Enumeration<Register>`	`enumerateNonvolatileGPRsBackwards()`
`Enumeration<Register>`	`enumerateNonvolatiles(int regClass)`
`Enumeration<Register>`	`enumerateNonvolatilesBackwards(int regClass)`
`PhysicalRegisterSet.PhysicalRegisterEnumeration`	`enumerateVolatileFPRs()`
`PhysicalRegisterSet.PhysicalRegisterEnumeration`	`enumerateVolatileGPRs()`
`Enumeration<Register>`	`enumerateVolatiles()`
`Enumeration<Register>`	`enumerateVolatiles(int regClass)`
`Register`	`get(int n)`
`Register`	`getAF()`
`Register`	`getC0()`
`Register`	`getC1()`
`Register`	`getC2()`
`Register`	`getC3()`
`Register`	`getCF()`
`Register`	`getEAX()`
`Register`	`getEBP()`
`Register`	`getEBX()`
`Register`	`getECX()`
`Register`	`getEDI()`
`Register`	`getEDX()`
`Register`	`getESI()`
`Register`	`getESP()`
`Register`	`getFirstReturnGPR()`
`Register`	`getFP()`
`Register`	`getFPR(int n)`
`Register`	`getFPR(RegisterConstants.FloatingPointMachineRegister n)`
`static int`	`getFPRIndex(Register r)`
`Register`	`getFPRParam(int n)`
`BitSet`	`getFPRs()`
`Register`	`getGPR(int n)`
`Register`	`getGPR(MachineRegister n)`
`static int`	`getGPRIndex(Register r)`
`Register`	`getGPRParam(int n)`
`static String`	`getName(int number)` Gets the register name for a register with a particular number in the pool.
`Register`	`getNativeFPRParam(int n)`
`Register`	`getNativeGPRParam(int n)`
`static int`	`getNumberOfFPRParams()`
`static int`	`getNumberOfGPRParams()`
`static int`	`getNumberOfNativeFPRParams()`
`static int`	`getNumberOfNativeGPRParams()`
`static int`	`getNumberOfNonvolatileGPRs()`
`int`	`getNumberOfPhysicalRegisters()`
`Register`	`getOF()`
`Register`	`getPF()`
`static int`	`getPhysicalRegisterType(Register r)` Given a symbolic register, return a code that gives the physical register type to hold the value of the symbolic register.
`Register`	`getReturnFPR()`
`Register`	`getReturnGPR(int n)`
`Register`	`getSecondReturnGPR()`
`Register`	`getSF()`
`static int`	`getSize()`
`static int`	`getSpillAlignment(int type)`
`static int`	`getSpillSize(int type)`
`Register`	`getST0()`
`Register`	`getST1()`
`Register`	`getTR()`
`BitSet`	`getVolatiles()`
`Register`	`getZF()`
`boolean`	`isAllocatable(Register r)`

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
```
    Cache the set of volatile registers for efficiency
  - fpSet
```
private final BitSet fpSet
```
    Cache the set of floating-point registers for efficiency
  - registerName
```
private static final String[] registerName
```
    Register names for each class. used in printing the IR
- Constructor Detail
  - PhysicalRegisterSet
```
public PhysicalRegisterSet()
```
- 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.
  - getNumberOfGPRParams
```
public static int getNumberOfGPRParams()
```
    Returns:
    
    the total number of GPRs that may hold parameters.
  - getNativeGPRParam
```
public Register getNativeGPRParam(int n)
```
    Parameters:
    
    n - register index
    
    Returns:
    
    the (zero-based indexed) nth native GPR that may hold a parameter.
  - getNumberOfFPRParams
```
public static int getNumberOfFPRParams()
```
    Returns:
    
    the total number of FPRs that may hold parameters.
  - getNumberOfNativeGPRParams
```
public static int getNumberOfNativeGPRParams()
```
    Returns:
    
    the total number of native GPRs that may hold parameters.
  - getNumberOfNativeFPRParams
```
public static int getNumberOfNativeFPRParams()
```
    Returns:
    
    the total number of native FPRs that may hold parameters.
  - getGPRParam
```
public Register getGPRParam(int n)
```
    Parameters:
    
    n - register index
    
    Returns:
    
    the (zero-based indexed) nth GPR that may hold a parameter.
  - getFPRParam
```
public Register getFPRParam(int n)
```
    Parameters:
    
    n - register index
    
    Returns:
    
    the (zero-based indexed) nth FPR that may hold a parameter.
  - getNativeFPRParam
```
public Register getNativeFPRParam(int n)
```
    Parameters:
    
    n - register index
    
    Returns:
    
    the (zero-based indexed) nth native FPR that may hold a parameter.
  - getReturnGPR
```
public Register getReturnGPR(int n)
```
    Parameters:
    
    n - register index
    
    Returns:
    
    the (zero-based indexed) nth GPR that may hold a return value.
  - isAllocatable
```
public boolean isAllocatable(Register r)
```
    Specified by:
    
    isAllocatable in class GenericPhysicalRegisterSet
    
    Parameters:
    
    r - the register to check
    
    Returns:
    
    true if and only if a particular register is subject to allocation
  - getTR
```
public Register getTR()
```
    Specified by:
    
    getTR in class GenericPhysicalRegisterSet
    
    Returns:
    
    the processor register
  - getFP
```
public Register getFP()
```
    Specified by:
    
    getFP in class GenericPhysicalRegisterSet
    
    Returns:
    
    the frame pointer register
  - getEAX
```
public Register getEAX()
```
    Returns:
    
    the EAX register
  - getECX
```
public Register getECX()
```
    Returns:
    
    the ECX register
  - getEDX
```
public Register getEDX()
```
    Returns:
    
    the EDX register
  - getEBX
```
public Register getEBX()
```
    Returns:
    
    the EBX register
  - getESP
```
public Register getESP()
```
    Returns:
    
    the ESP register
  - getEBP
```
public Register getEBP()
```
    Returns:
    
    the EBP register
  - getESI
```
public Register getESI()
```
    Returns:
    
    the ESI register
  - getEDI
```
public Register getEDI()
```
    Returns:
    
    the EDI register
  - getAF
```
public Register getAF()
```
    Returns:
    
    a register representing the AF bit of the EFLAGS register.
  - getCF
```
public Register getCF()
```
    Returns:
    
    a register representing the CF bit of the EFLAGS register.
  - getOF
```
public Register getOF()
```
    Returns:
    
    a register representing the OF bit of the EFLAGS register.
  - getPF
```
public Register getPF()
```
    Returns:
    
    a register representing the PF bit of the EFLAGS register.
  - getSF
```
public Register getSF()
```
    Returns:
    
    a register representing the SF bit of the EFLAGS register.
  - getZF
```
public Register getZF()
```
    Returns:
    
    a register representing the ZF bit of the EFLAGS register.
  - getC0
```
public Register getC0()
```
    Returns:
    
    a register representing the C0 floating-point status bit
  - getC1
```
public Register getC1()
```
    Returns:
    
    a register representing the C1 floating-point status bit
  - getC2
```
public Register getC2()
```
    Returns:
    
    a register representing the C2 floating-point status bit
  - getC3
```
public Register getC3()
```
    Returns:
    
    a register representing the C3 floating-point status bit
  - getGPR
```
public Register getGPR(MachineRegister n)
```
    Specified by:
    
    getGPR in class GenericPhysicalRegisterSet
    
    Parameters:
    
    n - a register
    
    Returns:
    
    the physical GPR corresponding to n
  - getGPR
```
public Register getGPR(int n)
```
    Specified by:
    
    getGPR in class GenericPhysicalRegisterSet
  - getGPRIndex
```
public static int getGPRIndex(Register r)
```
    Parameters:
    
    r - a physical GPR
    
    Returns:
    
    the index into the GPR set corresponding to a given register. PRECONDITION: r is a physical GPR
  - getFirstReturnGPR
```
public Register getFirstReturnGPR()
```
    Specified by:
    
    getFirstReturnGPR in class GenericPhysicalRegisterSet
    
    Returns:
    
    the first GPR register used to hold a return value
  - getSecondReturnGPR
```
public Register getSecondReturnGPR()
```
    Returns:
    
    the second GPR register used to hold a return value
  - getST0
```
public Register getST0()
```
    Returns:
    
    the FPR register used to hold a return value
  - getST1
```
public Register getST1()
```
    Returns:
    
    the special ST1 x87 register
  - getReturnFPR
```
public Register getReturnFPR()
```
    Returns:
    
    the FPR register used to hold a return value
  - getFPR
```
public Register getFPR(RegisterConstants.FloatingPointMachineRegister n)
```
  - getFPR
```
public Register getFPR(int n)
```
    Specified by:
    
    getFPR in class GenericPhysicalRegisterSet
  - getFPRIndex
```
public static int getFPRIndex(Register r)
```
    Parameters:
    
    r - a physical FPR
    
    Returns:
    
    the index into the FPR set corresponding to a given register. PRECONDITION: r is a physical FPR
  - get
```
public Register get(int n)
```
    Specified by:
    
    get in class GenericPhysicalRegisterSet
    
    Parameters:
    
    n - register number
    
    Returns:
    
    the nth physical register in the pool.
  - getPhysicalRegisterType
```
public static int getPhysicalRegisterType(Register r)
```
    Given a symbolic register, return a code 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
  - getName
```
public static String getName(int number)
```
    Gets the register name for a register with a particular number in the pool.
    
    Parameters:
    
    number - register number
    
    Returns:
    
    register name
  - getSpillSize
```
public static int getSpillSize(int type)
```
    Parameters:
    
    type - one of INT_REG, DOUBLE_REG, SPECIAL_REG
    
    Returns:
    
    the spill size for a register with the given type
  - getSpillAlignment
```
public static int getSpillAlignment(int type)
```
    Parameters:
    
    type - one of INT_REG, DOUBLE_REG, SPECIAL_REG
    
    Returns:
    
    the required spill alignment for a register with the given type
  - enumerateAll
```
public Enumeration<Register> enumerateAll()
```
    Specified by:
    
    enumerateAll in class GenericPhysicalRegisterSet
  - enumerateGPRs
```
public Enumeration<Register> enumerateGPRs()
```
    Specified by:
    
    enumerateGPRs in class GenericPhysicalRegisterSet
  - enumerateFPRs
```
public Enumeration<Register> enumerateFPRs()
```
  - enumerateVolatileGPRs
```
public PhysicalRegisterSet.PhysicalRegisterEnumeration enumerateVolatileGPRs()
```
    Specified by:
    
    enumerateVolatileGPRs in class GenericPhysicalRegisterSet
  - enumerateNonvolatileGPRs
```
public PhysicalRegisterSet.PhysicalRegisterEnumeration enumerateNonvolatileGPRs()
```
    Specified by:
    
    enumerateNonvolatileGPRs in class GenericPhysicalRegisterSet
  - enumerateNonvolatileGPRsBackwards
```
public Enumeration<Register> enumerateNonvolatileGPRsBackwards()
```
    Overrides:
    
    enumerateNonvolatileGPRsBackwards in class GenericPhysicalRegisterSet
  - enumerateVolatileFPRs
```
public PhysicalRegisterSet.PhysicalRegisterEnumeration enumerateVolatileFPRs()
```
    Specified by:
    
    enumerateVolatileFPRs in class GenericPhysicalRegisterSet
  - enumerateNonvolatileFPRs
```
public PhysicalRegisterSet.PhysicalRegisterEnumeration enumerateNonvolatileFPRs()
```
    Specified by:
    
    enumerateNonvolatileFPRs in class GenericPhysicalRegisterSet
  - enumerateVolatiles
```
public Enumeration<Register> enumerateVolatiles(int regClass)
```
    Specified by:
    
    enumerateVolatiles in class GenericPhysicalRegisterSet
  - enumerateVolatiles
```
public Enumeration<Register> enumerateVolatiles()
```
    Specified by:
    
    enumerateVolatiles in class GenericPhysicalRegisterSet
  - getVolatiles
```
public BitSet getVolatiles()
```
    Returns:
    
    the set of volatile physical registers
  - getFPRs
```
public BitSet getFPRs()
```
    Returns:
    
    the set of FPR physical registers
  - enumerateNonvolatiles
```
public Enumeration<Register> enumerateNonvolatiles(int regClass)
```
  - enumerateNonvolatilesBackwards
```
public Enumeration<Register> enumerateNonvolatilesBackwards(int regClass)
```
    Specified by:
    
    enumerateNonvolatilesBackwards in class GenericPhysicalRegisterSet

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

fpSet

registerName

Constructor Detail

PhysicalRegisterSet

Method Detail

getSize

getNumberOfPhysicalRegisters

getNumberOfNonvolatileGPRs

getNumberOfGPRParams

getNativeGPRParam

getNumberOfFPRParams

getNumberOfNativeGPRParams

getNumberOfNativeFPRParams

getGPRParam

getFPRParam

getNativeFPRParam

getReturnGPR

isAllocatable

getTR

getFP

getEAX

getECX

getEDX

getEBX

getESP

getEBP

getESI

getEDI

getAF

getCF

getOF

getPF

getSF

getZF

getC0

getC1

getC2

getC3

getGPR

getGPR

getGPRIndex

getFirstReturnGPR

getSecondReturnGPR

getST0

getST1

getReturnFPR

getFPR

getFPR

getFPRIndex

get

getPhysicalRegisterType

getName

getSpillSize

getSpillAlignment

enumerateAll

enumerateGPRs

enumerateFPRs

enumerateVolatileGPRs

enumerateNonvolatileGPRs

enumerateNonvolatileGPRsBackwards

enumerateVolatileFPRs

enumerateNonvolatileFPRs

enumerateVolatiles

enumerateVolatiles

getVolatiles

getFPRs

enumerateNonvolatiles

enumerateNonvolatilesBackwards