ControllerMemory (Jikes RVM API)

java.lang.Object
- org.jikesrvm.adaptive.controller.ControllerMemory

```
public final class ControllerMemory
extends Object
```
This class records decisions taken by the controller. It will remember controller plans, which contain compilation plans and other goodies, and allows searching for previous decisions

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`awoken` Number of times controller is awoken
`private static int`	`didNothing` Number of times controller is awoken and did nothing.
`private static int`	`numBase`
`private static int`	`numMethodsConsidered`
`private static int`	`numMethodsScheduledForRecomp`
`private static int`	`numOpt0`
`private static int`	`numOpt1`
`private static int`	`numOpt2`
`private static int`	`numOpt3`
`private static int`	`numOpt4`
`private static ImmutableEntryHashMapRVM<RVMMethod,LinkedList<ControllerPlan>>`	`table` This is a hashtable of controller plans indexed by RVMMethod.

Constructor Summary

Constructors
Constructor and Description

ControllerMemory()

Constructors
Constructor and Description
`ControllerMemory()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) static String`	`asString()`
`(package private) static boolean`	`bitIsSet(int bitPattern, int optLevel)` Checks if the bit position defined by the 2nd parm is set in the first parm
`(package private) static boolean`	`completedPlanWithOptLevel(RVMMethod method, int optLevel)` Return `true` if there is a completed plan with the given opt level for the given method
`static ControllerPlan`	`findLatestPlan(RVMMethod method)` Looks for the last controller plan for the passed method
`static ControllerPlan`	`findMatchingPlan(CompiledMethod cmpMethod)` Find the plan for the compiled method that is passed
`private static LinkedList<ControllerPlan>`	`findPlan(RVMMethod method)` Looks for a controller plan for the passed method
`static int`	`getNumAwoken()`
`static int`	`getNumBase()`
`static int`	`getNumDidNothing()`
`static int`	`getNumMethodsConsidered()`
`static int`	`getNumMethodsScheduledForRecomp()`
`static int`	`getNumOpt0()`
`static int`	`getNumOpt1()`
`static int`	`getNumOpt2()`
`static int`	`getNumOpt3()`
`(package private) static int`	`getNumOpt4()`
`(package private) static void`	`incrementNumAwoken()`
`static void`	`incrementNumBase()`
`(package private) static void`	`incrementNumDidNothing()`
`(package private) static void`	`incrementNumMethodsConsidered()`
`(package private) static void`	`incrementNumMethodsScheduledForRecomp()`
`(package private) static void`	`incrementNumOpt0()`
`(package private) static void`	`incrementNumOpt1()`
`(package private) static void`	`incrementNumOpt2()`
`(package private) static void`	`incrementNumOpt3()`
`(package private) static void`	`incrementNumOpt4()`
`(package private) static void`	`insert(ControllerPlan plan)` Inserts a controller plan keyed on the underlying method
`(package private) static boolean`	`planWithStatus(RVMMethod method, byte status)` Return `true` if there is a plan with the given status for the given method
`static void`	`printFinalMethodStats(PrintStream log)` This method summarizes the recompilation actions taken for all methods in this object and produces a report to the passed PrintStream.
`static boolean`	`requestedOSR(int cmid)`
`(package private) static int`	`setBitPattern(int bitPattern, int optLevel)` Sets the optLevel bit in the passed bitPattern and return the result
`(package private) static boolean`	`shouldConsiderForInitialRecompilation(RVMMethod method)` Determine if the passed method should be considered as a candidate for _initial_ AOS recompilation.

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

- Field Detail
  - table
```
private static final ImmutableEntryHashMapRVM<RVMMethod,LinkedList<ControllerPlan>> table
```
    This is a hashtable of controller plans indexed by RVMMethod. Each method can have a list of such plans associated with.
  - didNothing
```
private static int didNothing
```
    Number of times controller is awoken and did nothing.
  - awoken
```
private static int awoken
```
    Number of times controller is awoken
  - numMethodsConsidered
```
private static int numMethodsConsidered
```
  - numMethodsScheduledForRecomp
```
private static int numMethodsScheduledForRecomp
```
  - numBase
```
private static int numBase
```
  - numOpt0
```
private static int numOpt0
```
  - numOpt1
```
private static int numOpt1
```
  - numOpt2
```
private static int numOpt2
```
  - numOpt3
```
private static int numOpt3
```
  - numOpt4
```
private static int numOpt4
```
- Constructor Detail
  - ControllerMemory
```
public ControllerMemory()
```
- Method Detail
  - getNumAwoken
```
public static int getNumAwoken()
```
  - getNumDidNothing
```
public static int getNumDidNothing()
```
  - getNumMethodsConsidered
```
public static int getNumMethodsConsidered()
```
  - getNumMethodsScheduledForRecomp
```
public static int getNumMethodsScheduledForRecomp()
```
  - getNumBase
```
public static int getNumBase()
```
  - getNumOpt0
```
public static int getNumOpt0()
```
  - getNumOpt1
```
public static int getNumOpt1()
```
  - getNumOpt2
```
public static int getNumOpt2()
```
  - getNumOpt3
```
public static int getNumOpt3()
```
  - getNumOpt4
```
static int getNumOpt4()
```
  - incrementNumAwoken
```
static void incrementNumAwoken()
```
  - incrementNumDidNothing
```
static void incrementNumDidNothing()
```
  - incrementNumMethodsConsidered
```
static void incrementNumMethodsConsidered()
```
  - incrementNumMethodsScheduledForRecomp
```
static void incrementNumMethodsScheduledForRecomp()
```
  - incrementNumBase
```
public static void incrementNumBase()
```
  - incrementNumOpt0
```
static void incrementNumOpt0()
```
  - incrementNumOpt1
```
static void incrementNumOpt1()
```
  - incrementNumOpt2
```
static void incrementNumOpt2()
```
  - incrementNumOpt3
```
static void incrementNumOpt3()
```
  - incrementNumOpt4
```
static void incrementNumOpt4()
```
  - insert
```
static void insert(ControllerPlan plan)
```
    Inserts a controller plan keyed on the underlying method
    
    Parameters:
    
    plan - the controller plan to insert
  - findPlan
```
private static LinkedList<ControllerPlan> findPlan(RVMMethod method)
```
    Looks for a controller plan for the passed method
    
    Parameters:
    
    method - The method to look for
    
    Returns:
    
    the list of controller plans for this method if one exists, otherwise, null
  - findMatchingPlan
```
public static ControllerPlan findMatchingPlan(CompiledMethod cmpMethod)
```
    Find the plan for the compiled method that is passed
    
    Parameters:
    
    cmpMethod - the compiled method of interest
    
    Returns:
    
    the matching plan or null if none exists.
  - shouldConsiderForInitialRecompilation
```
static boolean shouldConsiderForInitialRecompilation(RVMMethod method)
```
    Determine if the passed method should be considered as a candidate for _initial_ AOS recompilation. A method should not be reconsider for initial AOS recompilation if a plan already exists for the method whose status is ControllerPlan.IN_PROGRESS, ControllerPlan.COMPLETED, ControllerPlan.OUTDATED, or ControllerPlan.ABORTED_COMPILATION_ERROR because of compilation error.
    
    Parameters:
    
    method - the method of interest
    
    Returns:
    
    whether the method should be considered or not
  - planWithStatus
```
static boolean planWithStatus(RVMMethod method,
                              byte status)
```
    Return true if there is a plan with the given status for the given method
    
    Parameters:
    
    method - the method of interest
    
    status - the status of interest
    
    Returns:
    
    whether or not there is plan with that status for the method
  - requestedOSR
```
public static boolean requestedOSR(int cmid)
```
    Parameters:
    
    cmid - the compiled method's ID
    
    Returns:
    
    true iff there is a plan to transition from Base to Opt for a given CMID
  - completedPlanWithOptLevel
```
static boolean completedPlanWithOptLevel(RVMMethod method,
                                         int optLevel)
```
    Return true if there is a completed plan with the given opt level for the given method
    
    Parameters:
    
    method - the method of interest
    
    optLevel - the opt level of interest
    
    Returns:
    
    whether or not there is completed plan with that level for the method
  - findLatestPlan
```
public static ControllerPlan findLatestPlan(RVMMethod method)
```
    Looks for the last controller plan for the passed method
    
    Parameters:
    
    method - The method to look for
    
    Returns:
    
    The last controller plan for this method if it exists, otherwise, null
  - printFinalMethodStats
```
public static void printFinalMethodStats(PrintStream log)
```
    This method summarizes the recompilation actions taken for all methods in this object and produces a report to the passed PrintStream.
    
    Parameters:
    
    log - the stream to print to
  - setBitPattern
```
static int setBitPattern(int bitPattern,
                         int optLevel)
```
    Sets the optLevel bit in the passed bitPattern and return the result
    
    Parameters:
    
    bitPattern - the given bit pattern
    
    optLevel - the new opt level
    
    Returns:
    
    the new bit pattern
  - bitIsSet
```
static boolean bitIsSet(int bitPattern,
                        int optLevel)
```
    Checks if the bit position defined by the 2nd parm is set in the first parm
    
    Parameters:
    
    bitPattern - a bit pattern
    
    optLevel - the opt level to check for
    
    Returns:
    
    whether the passed bit is set
  - asString
```
static String asString()
```

Class ControllerMemory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

table

didNothing

awoken

numMethodsConsidered

numMethodsScheduledForRecomp

numBase

numOpt0

numOpt1

numOpt2

numOpt3

numOpt4

Constructor Detail

ControllerMemory

Method Detail

getNumAwoken

getNumDidNothing

getNumMethodsConsidered

getNumMethodsScheduledForRecomp

getNumBase

getNumOpt0

getNumOpt1

getNumOpt2

getNumOpt3

getNumOpt4

incrementNumAwoken

incrementNumDidNothing

incrementNumMethodsConsidered

incrementNumMethodsScheduledForRecomp

incrementNumBase

incrementNumOpt0

incrementNumOpt1

incrementNumOpt2

incrementNumOpt3

incrementNumOpt4

insert

findPlan

findMatchingPlan

shouldConsiderForInitialRecompilation

planWithStatus

requestedOSR

completedPlanWithOptLevel

findLatestPlan

printFinalMethodStats

setBitPattern

bitIsSet

asString