Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

StrictPolicyImpl Class Reference

Collaboration diagram for StrictPolicyImpl:

Collaboration graph
[legend]
List of all members.

Detailed Description

An implementation of the StrictPolicy interface.

Definition at line 33 of file StrictPolicyImpl.hh.

Public Member Functions

 StrictPolicyImpl (const char *name)
 Construct a StrictPolicyImpl object with the given values.

virtual ~StrictPolicyImpl ()
 Deconstruct the policy.

virtual char * Name (void) throw (CORBA::SystemException)
 Mostly useful for debugging.

virtual void AddTask (Broker::Task_ptr new_task, const Broker::ScheduleParameters &sp) throw (CORBA::SystemException)
 NOTE: This method will be called before the reservation is made, giving the policy a chance to adjust any values.

See also:
RemoveTask
Parameters:
new_task The newly created Task object.
sp The tasks's scheduling parameters.
Exceptions:
CORBA::BAD_PARAM if task is nil.
CORBA::BAD_PARAM if task has already been added.
CORBA::BAD_INV_ORDER if the method is called without Activate() being called first.


virtual void RemoveTask (Broker::Task_ptr added_task) throw (CORBA::SystemException)
 NOTE: This method will be called after the reservation has been destroyed, so it can safely reallocate the newly freed CPU time.

See also:
AddTask
Parameters:
added_task The task to remove.
Exceptions:
CORBA::BAD_PARAM if task is nil.
CORBA::BAD_PARAM if task has already been removed.
CORBA::BAD_INV_ORDER if the method is called without Activate() being called first.


virtual Broker::TaskList * GetTaskList (void) throw (CORBA::SystemException)
 
Returns:
The list of task's managed by this policy.


virtual void Activate (const Broker::TaskList &tasks) throw (CORBA::SystemException)
 NOTE: The policy is expected to discover and adjust the scheduling parameters of any currently executing tasks.

See also:
Deactivate
Parameters:
tasks The list of tasks the policy needs to manage.
Exceptions:
CORBA::BAD_INV_ORDER if the method is called without intervening calls to Deactivate().


virtual void Deactivate (void) throw (CORBA::SystemException)
 NOTE: The policy should change any scheduling parameters of the currently executing tasks, the next policy to be activated will handle any changes.

See also:
Deactivate
Exceptions:
CORBA::BAD_INV_ORDER if the method is called on an inactive policy.


virtual void ChangeTaskCPU (Broker::RealTimeTask_ptr task, CORBA::ULong ct, CORBA::ULong status, CORBA::ULong advice) throw (CORBA::SystemException, Broker::InvalidState)
 
Parameters:
task The Task object requesting a CPU time change.
ct The Task's current CPU time.
status The status value reported by Task.ReportCPU().
advice The CPU time advice from the Task object.


virtual CORBA::Float GetMaxCPUAllocation (void) throw (CORBA::SystemException)
 
Returns:
The maximum percentage of CPU that can be allocated to all of the tasks.


virtual void SetMaxCPUAllocation (CORBA::Float amount) throw (CORBA::SystemException)
 
Parameters:
amount The maximum percentage of CPU that can be allocated to all of the tasks.


virtual void SetTaskPriority (Broker::Task_ptr task, CORBA::Short priority) throw (CORBA::SystemException)
 
Parameters:
task The task whose priority should be changed.
priority The new priority.
Exceptions:
CORBA::BAD_PARAM if task is nil.
CORBA::BAD_PARAM if task is not managed by this policy.


virtual CORBA::Short GetTaskPriority (Broker::Task_ptr task) throw (CORBA::SystemException)
 
Parameters:
task The task whose priority should be changed.
Returns:
The task's priority.
Exceptions:
CORBA::BAD_PARAM if task is nil.
CORBA::BAD_PARAM if task is not managed by this policy.



Static Public Attributes

const float DEFAULT_MAX_USED_CPU = 0.75
 Maximum percentage of CPU to allocate to tasks.

const float DEFAULT_MIN_TASK_CPU = 0.02
 Minimum percentage of CPU to allocate to a single task.


Private Types

enum  { TPB_STARVED }
enum  { TPF_STARVED = (1L << TPB_STARVED) }

Private Member Functions

void RepairTaskList (void)
 Repair the task list by removing any dead/unreachable objects.

TaskPriority * FindTaskPriority (Broker::RealTimeTask_ptr task)
 Find the TaskPriority node that corresponds to the given task.

TaskPriority * SubList (const RealTimeSchedule &rts, struct TaskPriority *ignore)
 Construct a list, ordered from lowest to highest priority, of the tasks whose schedule intersects with the given one.

CORBA::ULong TakeCPU (struct TaskPriority *sub_list, CORBA::ULong amount, struct TaskPriority *for_tp)
 Take CPU time from other tasks to give to another.

CORBA::ULong GiveCPU (struct TaskPriority *sub_list, CORBA::ULong amount, struct TaskPriority *for_tp)
 Give CPU time back to the other tasks.


Private Attributes

CORBA::String_var sp_Name
 The name of this object as registered with the NamingService.

float sp_MaxUsedCPU
 The maximum percentage of CPU time that we are allowed to allocate.

float sp_MinTaskCPU
 The minimum percentage of CPU time that a task must have.

lnList sp_List
 A list of TaskPriority objects.

CORBA::ULong sp_MaxDeadline
 The largest deadline of the tasks managed by this policy.

TaskPriority sp_FauxTask
 Fake task object used to represent CPU time that is not reserved.

Constructor & Destructor Documentation

StrictPolicyImpl::StrictPolicyImpl (  const char *  name  ) 
 

Construct a StrictPolicyImpl object with the given values.

Parameters:
name The name of this object as registered with the NamingService.

Definition at line 25 of file StrictPolicyImpl.cc.

References DEFAULT_MAX_USED_CPU, DEFAULT_MIN_TASK_CPU, lnNode::ln_Pri, lnNewList(), require, sp_FauxTask, sp_MaxUsedCPU, sp_MinTaskCPU, StrictPolicyImpl::TaskPriority::tp_Link, and StrictPolicyImpl::TaskPriority::tp_Task.

Here is the call graph for this function:

Member Function Documentation

struct StrictPolicyImpl::TaskPriority * StrictPolicyImpl::FindTaskPriority (  Broker::RealTimeTask_ptr  task  )  [private]
 

Find the TaskPriority node that corresponds to the given task.

Parameters:
task The Broker::RealTimeTask object to look up.
Returns:
The TaskPriority list node that has the given task object.
Exceptions:
Broker::Internal If no TaskPriority node exists for the given task.

Definition at line 699 of file StrictPolicyImpl.cc.

References lnList::lh_Head, lnNode::ln_Succ, require, and sp_List.

CORBA::ULong StrictPolicyImpl::GiveCPU (  struct TaskPriority *  sub_list,
CORBA::ULong  amount,
struct TaskPriority *  for_tp
)  [private]
 

Give CPU time back to the other tasks.

Parameters:
sub_list The list of tasks to give CPU time to, typically built with the SubList() method.
amount The amount of CPU time to give out.
for_tp The donating task.
Returns:
XXX ...

Definition at line 512 of file StrictPolicyImpl.cc.

References lnNode::ln_Pri, require, RealTimeSchedule::rts_Deadline, RealTimeSchedule::rts_Period, RealTimeSchedule::rts_Start, StrictPolicyImpl::TaskPriority::tp_Link, StrictPolicyImpl::TaskPriority::tp_Schedule, StrictPolicyImpl::TaskPriority::tp_SubLink, and StrictPolicyImpl::TaskPriority::tp_Task.

Referenced by RepairTaskList().

struct StrictPolicyImpl::TaskPriority * StrictPolicyImpl::SubList (  const RealTimeSchedule &  rts,
struct TaskPriority *  ignore
)  [private]
 

Construct a list, ordered from lowest to highest priority, of the tasks whose schedule intersects with the given one.

Parameters:
rts The schedule to match.
ignore The TaskPriority node to ignore when building the list or NULL if no nodes should be ignored.
Returns:
The list of nodes, linked by tp_SubLink, that match the given schedule.

Definition at line 261 of file StrictPolicyImpl.cc.

References lnList::lh_Head, lnNode::ln_Succ, RealTimeSchedule::rts_Deadline, RealTimeSchedule::rts_Period, RealTimeSchedule::rts_Start, sp_FauxTask, sp_List, sp_MaxUsedCPU, StrictPolicyImpl::TaskPriority::tp_ComputeTime, StrictPolicyImpl::TaskPriority::tp_Schedule, StrictPolicyImpl::TaskPriority::tp_SubTime, and StrictPolicyImpl::TaskPriority::tp_Task.

CORBA::ULong StrictPolicyImpl::TakeCPU (  struct TaskPriority *  sub_list,
CORBA::ULong  amount,
struct TaskPriority *  for_tp
)  [private]
 

Take CPU time from other tasks to give to another.

Parameters:
sub_list The list of tasks to take CPU time from, typically built with the SubList() method.
amount The amount of CPU time to take away.
for_tp The node that will be given the CPU time.
Returns:
The actual amount of CPU time that can be given to the task.

Definition at line 308 of file StrictPolicyImpl.cc.

References lnNode::ln_Pri, require, RealTimeSchedule::rts_Deadline, RealTimeSchedule::rts_Period, RealTimeSchedule::rts_Start, sp_MaxUsedCPU, sp_MinTaskCPU, StrictPolicyImpl::TaskPriority::tp_ComputeTime, StrictPolicyImpl::TaskPriority::tp_Flags, StrictPolicyImpl::TaskPriority::tp_Link, StrictPolicyImpl::TaskPriority::tp_Schedule, StrictPolicyImpl::TaskPriority::tp_SubLink, and StrictPolicyImpl::TaskPriority::tp_Task.

The documentation for this class was generated from the following files:
Generated on Mon Dec 1 16:30:40 2003 for CPU Broker by doxygen 1.3.4