de.uka.ipd.sdq.simucomframework.resources

Class AbstractScheduledResource

java.lang.Object

de.uka.ipd.sdq.simulation.abstractsimengine.SimulationElement

de.uka.ipd.sdq.simulation.abstractsimengine.AbstractSimEntityDelegator

de.uka.ipd.sdq.simucomframework.entities.SimuComEntity

de.uka.ipd.sdq.simucomframework.resources.AbstractScheduledResource

All Implemented Interfaces:

IActiveResourceStateSensor, IEntity

Direct Known Subclasses:

ScheduledResource, SimulatedLinkingResource

public abstract class AbstractScheduledResource
extends SimuComEntity
implements IActiveResourceStateSensor

Base class of all resources which have their own scheduler, i.e., active resources in the PCM. Contains generic code to instrument the resource to report its results to the sensorframework

Author:

Steffen Becker, Sebastian Lehrig

Field Summary

Fields inherited from interface de.uka.ipd.sdq.simulation.abstractsimengine.IEntity

NULL

Constructor Summary

Constructors

Constructor and Description
AbstractScheduledResource(SimuComModel myModel, String typeID, String resourceContainerID, String resourceTypeID, String description, String schedulingStrategyID, int numberOfInstances, boolean requiredByContainer)

Method Summary

Modifier and Type	Method and Description
void	activateResource() Called by the framework to inform that the resource should start its lifecycle
void	addDemandListener(IDemandListener listener)
void	addOverallUtilizationListener(IOverallUtilizationListener listener)
void	addStateListener(IStateListener listener, int instance)
abstract void	consumeResource(SimuComSimProcess thread, int resourceServiceID, Map<String,Serializable> parameterMap, double demand) Called by client of this resource to make the resource simulate resource processing.
void	deactivateResource() Called by the framework to inform the resource that the simulation has been stopped.
void	demandCompleted(ISchedulableProcess simProcess) Notifies the sensor about a process whose demand has been completed by the resource.
String	getDescription()
int	getNumberOfInstances()
long	getQueueLength(int coreID)
abstract double	getRemainingDemandForProcess(SimuComSimProcess thread)
String	getResourceTypeId() Returns the id of the resource type (e.g.
abstract IActiveResource	getScheduledResource()
String	getSchedulingStrategyID()
IActiveResource	getUnderlyingResource() Returns the underlying resource
boolean	isAvailable() Retrieves the current availability status of this resource.
boolean	isRequiredByContainer() Asks if a processing resource is required by its surrounding container.
void	setAvailable(boolean isAvailable) Marks the resource as being available or unavailable.
void	update(long state, int instanceId) Notifies the sensor about a state change of the resource.
abstract void	updateDemand(SimuComSimProcess thread, double demand)

Methods inherited from class de.uka.ipd.sdq.simucomframework.entities.SimuComEntity

getModel

Methods inherited from class de.uka.ipd.sdq.simulation.abstractsimengine.AbstractSimEntityDelegator

getEncapsulatedEntity, isScheduled, reschedule

Methods inherited from class de.uka.ipd.sdq.simulation.abstractsimengine.SimulationElement

getName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractScheduledResource

public AbstractScheduledResource(SimuComModel myModel,
                                 String typeID,
                                 String resourceContainerID,
                                 String resourceTypeID,
                                 String description,
                                 String schedulingStrategyID,
                                 int numberOfInstances,
                                 boolean requiredByContainer)

Method Detail

getUnderlyingResource

public IActiveResource getUnderlyingResource()

Returns the underlying resource

Returns:

aResource

consumeResource

public abstract void consumeResource(SimuComSimProcess thread,
                                     int resourceServiceID,
                                     Map<String,Serializable> parameterMap,
                                     double demand)

Called by client of this resource to make the resource simulate resource processing. This is the queueing network service center part of our simulation. Allows passing of additional parameters.

Parameters:

thread - The thread or job requesting the processing of its demand

resourceServiceID - The id of the resource service to be called for resource consumption

parameterMap - Additional parameters which can be used by the resource. Map can be empty.

demand - The resource demand the client wishes to be processed by the resource

getRemainingDemandForProcess

public abstract double getRemainingDemandForProcess(SimuComSimProcess thread)

updateDemand

public abstract void updateDemand(SimuComSimProcess thread,
                                  double demand)

activateResource

public void activateResource()

Called by the framework to inform that the resource should start its lifecycle

deactivateResource

public void deactivateResource()

Called by the framework to inform the resource that the simulation has been stopped. Fires a IStateListener#stateChanged() event.

getScheduledResource

public abstract IActiveResource getScheduledResource()

setAvailable

public void setAvailable(boolean isAvailable)

Marks the resource as being available or unavailable.

Parameters:

isAvailable - the target state to set

isAvailable

public boolean isAvailable()

Retrieves the current availability status of this resource.

Returns:

TRUE if the resource is available; FALSE otherwise

isRequiredByContainer

public boolean isRequiredByContainer()

Asks if a processing resource is required by its surrounding container.

Returns:

TRUE if resource is required; FALSE otherwise

getDescription

public String getDescription()

getNumberOfInstances

public int getNumberOfInstances()

addStateListener

public void addStateListener(IStateListener listener,
                             int instance)

addOverallUtilizationListener

public void addOverallUtilizationListener(IOverallUtilizationListener listener)

addDemandListener

public void addDemandListener(IDemandListener listener)

update

public void update(long state,
                   int instanceId)

Description copied from interface: IActiveResourceStateSensor

Notifies the sensor about a state change of the resource.

Specified by:

update in interface IActiveResourceStateSensor

Parameters:

state - the changed state

instanceId - id of the instance whose state changed

demandCompleted

public void demandCompleted(ISchedulableProcess simProcess)

Description copied from interface: IActiveResourceStateSensor

Notifies the sensor about a process whose demand has been completed by the resource.

Specified by:

demandCompleted in interface IActiveResourceStateSensor

Parameters:

simProcess - the process whose demand has been completed by the resource.

getResourceTypeId

public String getResourceTypeId()

Returns the id of the resource type (e.g. "_oro4gG3fEdy4YaaT-RYrLQ" for the "CPU" resource type).

Be warned that this method's name may be confusing since it interprets the term "resource type id" different to the rest of SimuCom! In SimuCom, the variable name "typeID" is mostly used to refer to the name (!) of a resource type, i.e. "CPU", not "_oro4g...".

TODO: the typeID variables should be renamed to typeName or similar!

getSchedulingStrategyID

public String getSchedulingStrategyID()

getQueueLength

public long getQueueLength(int coreID)