ControllerPlan (Jikes RVM API)

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

```
public final class ControllerPlan
extends Object
```
An instance of this class describes a compilation decision made by the controller.
Constraints: Given the plan list of a method:
- Only one plan will have status COMPLETED
- Multiple plans may have status OUTDATED
- Only one plan will have status IN_PROGRESS
status states:
```
 UNINITIALIZED -> IN_PROGRESS -> COMPLETED -> OUTDATED
             \              \--> ABORTED_COMPILATION_ERROR (never recompile method)
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`ABORTED_COMPILATION_ERROR` Compilation for the method was begun, but failed in an error
`private int`	`CMID` The compiled method ID for this plan
`static byte`	`COMPLETED` The plan was successfully completed, i.e., the method was recompiled
`private CompilationPlan`	`compPlan` The associate compilation plan
`private double`	`expectedCompilationTime` The compilation time we were expecting
`private double`	`expectedSpeedup` The speedup we were expecting
`static byte`	`IN_PROGRESS` The compilation is still in progress
`static byte`	`OSR_BASE_2_OPT` The compilation plan is for a promotion from BASE to OPT
`static byte`	`OUTDATED` The compilation completed, but a new plan for the same method also completed, so this is not the most recent completed plan
`private LinkedList<ControllerPlan>`	`planList` The list that we are onstatus of this plan
`private int`	`prevCMID` The compiled method ID for the previous plan for this method
`private double`	`priority` The priority associated with this plan
`private byte`	`status` The status of this plan
`private int`	`timeCompleted` The time compilation end
`private int`	`timeCreated` The time we created this plan
`private int`	`timeInitiated` The time compilation began
`static byte`	`UNINITIALIZED` The plan was created, but the setStatus method was never called
`static byte`	`UNKNOWN` This is used by clients to initialize local variables for Java semantics

Constructor Summary

Constructors
Constructor and Description
`ControllerPlan(CompilationPlan compPlan, int timeCreated, int prevCMID, double expectedSpeedup, double expectedCompilationTime, double priority)` Construct a controller plan

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompiledMethod`	`doRecompile()` This method will recompile the method designated by the controller plan `getCompPlan()`.
`boolean`	`execute()` Execute the plan.
`int`	`getCMID()`
`CompilationPlan`	`getCompPlan()`
`double`	`getExpectedCompilationTime()`
`double`	`getExpectedSpeedup()`
`int`	`getPrevCMID()`
`double`	`getPriority()`
`byte`	`getStatus()`
`String`	`getStatusString()`
`int`	`getTimeCompleted()`
`int`	`getTimeCreated()`
`int`	`getTimeInitiated()`
`void`	`setCMID(int x)`
`void`	`setPlanList(LinkedList<ControllerPlan> list)`
`void`	`setStatus(byte newStatus)`
`void`	`setTimeCompleted(int t)`
`void`	`setTimeInitiated(int t)`
`String`	`toString()`

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

- Field Detail
  - UNINITIALIZED
```
public static final byte UNINITIALIZED
```
    The plan was created, but the setStatus method was never called
    
    See Also:
    
    Constant Field Values
  - COMPLETED
```
public static final byte COMPLETED
```
    The plan was successfully completed, i.e., the method was recompiled
    
    See Also:
    
    Constant Field Values
  - ABORTED_COMPILATION_ERROR
```
public static final byte ABORTED_COMPILATION_ERROR
```
    Compilation for the method was begun, but failed in an error
    
    See Also:
    
    Constant Field Values
  - IN_PROGRESS
```
public static final byte IN_PROGRESS
```
    The compilation is still in progress
    
    See Also:
    
    Constant Field Values
  - OUTDATED
```
public static final byte OUTDATED
```
    The compilation completed, but a new plan for the same method also completed, so this is not the most recent completed plan
    
    See Also:
    
    Constant Field Values
  - OSR_BASE_2_OPT
```
public static final byte OSR_BASE_2_OPT
```
    The compilation plan is for a promotion from BASE to OPT
    
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final byte UNKNOWN
```
    This is used by clients to initialize local variables for Java semantics
    
    See Also:
    
    Constant Field Values
  - compPlan
```
private final CompilationPlan compPlan
```
    The associate compilation plan
  - timeCreated
```
private final int timeCreated
```
    The time we created this plan
  - timeInitiated
```
private int timeInitiated
```
    The time compilation began
  - timeCompleted
```
private int timeCompleted
```
    The time compilation end
  - expectedSpeedup
```
private final double expectedSpeedup
```
    The speedup we were expecting
  - expectedCompilationTime
```
private final double expectedCompilationTime
```
    The compilation time we were expecting
  - priority
```
private final double priority
```
    The priority associated with this plan
  - CMID
```
private int CMID
```
    The compiled method ID for this plan
  - prevCMID
```
private final int prevCMID
```
    The compiled method ID for the previous plan for this method
  - status
```
private byte status
```
    The status of this plan
  - planList
```
private LinkedList<ControllerPlan> planList
```
    The list that we are onstatus of this plan
- Constructor Detail
  - ControllerPlan
```
public ControllerPlan(CompilationPlan compPlan,
                      int timeCreated,
                      int prevCMID,
                      double expectedSpeedup,
                      double expectedCompilationTime,
                      double priority)
```
    Construct a controller plan
    
    Parameters:
    
    compPlan - The compilation plan
    
    timeCreated - The "time" this plan was created
    
    prevCMID - The previous compiled method ID
    
    expectedSpeedup - Expected recompilation benefit
    
    expectedCompilationTime - Expected recompilation cost
    
    priority - How important is executing this plan?
- Method Detail
  - execute
```
public boolean execute()
```
    Execute the plan.
    
    Returns:
    
    true on success, false on failure
  - doRecompile
```
public CompiledMethod doRecompile()
```
    This method will recompile the method designated by the controller plan getCompPlan(). It also
    1. credits the samples associated with the old compiled method ID to the new method ID and clears the old value.
    2. clears inlining information
    3. updates the status of the controller plan
    Returns:
    
    null if the compilation was aborted, the new compiled method otherwise
  - getCompPlan
```
public CompilationPlan getCompPlan()
```
    Returns:
    
    the compilation plan
  - getExpectedSpeedup
```
public double getExpectedSpeedup()
```
    Returns:
    
    the expected speedup for this method due to this recompilation
  - getExpectedCompilationTime
```
public double getExpectedCompilationTime()
```
    Returns:
    
    the expected compilation time for this method
  - getPriority
```
public double getPriority()
```
    Returns:
    
    the priority (how important is it that this plan be executed)
  - getTimeCreated
```
public int getTimeCreated()
```
    Returns:
    
    the time this plan was created
  - getTimeInitiated
```
public int getTimeInitiated()
```
    Returns:
    
    the time (according to the controller clock) compilation of this plan began.
  - setTimeInitiated
```
public void setTimeInitiated(int t)
```
  - getTimeCompleted
```
public int getTimeCompleted()
```
    Returns:
    
    the time (according to the controller clock) compilation of this plan completed.
  - setTimeCompleted
```
public void setTimeCompleted(int t)
```
  - getCMID
```
public int getCMID()
```
    Returns:
    
    CMID (compiled method id) associated with the code produced by executing this plan
  - setCMID
```
public void setCMID(int x)
```
  - getPrevCMID
```
public int getPrevCMID()
```
    Returns:
    
    CMID (compiled method id) associated with the *PREVIOUS* compiled version of this method
  - getStatus
```
public byte getStatus()
```
    Returns:
    
    status of this compilation plan, chosen from the values defined in this class
  - setStatus
```
public void setStatus(byte newStatus)
```
  - setPlanList
```
public void setPlanList(LinkedList<ControllerPlan> list)
```
  - getStatusString
```
public String getStatusString()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ControllerPlan

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNINITIALIZED

COMPLETED

ABORTED_COMPILATION_ERROR

IN_PROGRESS

OUTDATED

OSR_BASE_2_OPT

UNKNOWN

compPlan

timeCreated

timeInitiated

timeCompleted

expectedSpeedup

expectedCompilationTime

priority

CMID

prevCMID

status

planList

Constructor Detail

ControllerPlan

Method Detail

execute

doRecompile

getCompPlan

getExpectedSpeedup

getExpectedCompilationTime

getPriority

getTimeCreated

getTimeInitiated

setTimeInitiated

getTimeCompleted

setTimeCompleted

getCMID

setCMID

getPrevCMID

getStatus

setStatus

setPlanList

getStatusString

toString