D.16.1 Multiprocessor Dispatching Domains
1/3
{
AI05-0167-1}
This clause allows implementations on multiprocessor
platforms to be partitioned into distinct dispatching domains during
program startup.
Static Semantics
2/3
{
AI05-0167-1}
The following language-defined library package
exists:
3/3
with Ada.Real_Time;
package System.Multiprocessors.Dispatching_Domains is
pragma Preelaborate(Dispatching_Domains);
4/3
Dispatching_Domain_Error : exception;
5/3
type Dispatching_Domain (<>) is limited private;
6/3
System_Dispatching_Domain : constant Dispatching_Domain;
7/3
function Create (First, Last : CPU) return Dispatching_Domain;
8/3
function Get_First_CPU (Domain : Dispatching_Domain) return CPU;
9/3
function Get_Last_CPU (Domain : Dispatching_Domain) return CPU;
10/3
function Get_Dispatching_Domain (T : Task_Id := Current_Task)
return Dispatching_Domain;
11/3
procedure Assign_Task (Domain : in out Dispatching_Domain;
CPU : in CPU_Range := Not_A_Specific_CPU;
T : in Task_Id := Current_Task);
12/3
procedure Set_CPU (CPU : in CPU_Range; T : in Task_Id := Current_Task);
13/3
function Get_CPU (T : Task_Id := Current_Task) return CPU_Range;
14/3
procedure Delay_Until_And_Set_CPU (
Delay_Until_Time : in Ada.Real_Time.Time; CPU : in CPU_Range);
15/3
private
... -- not specified by the language
end System.Multiprocessors.Dispatching_Domains;
16/3
{
AI05-0167-1}
The type Dispatching_Domain represents a series
of processors on which a task may execute. Each processor is contained
within exactly one Dispatching_Domain. System_Dispatching_Domain contains
the processor or processors on which the environment task executes. At
program start-up all processors are contained within System_Dispatching_Domain.
17/3
18/3
Dispatching_Domain
The value of aspect Dispatching_Domain is an expression,
which shall be of type Dispatching_Domains.Dispatching_Domain. This aspect
is the domain to which the task (or all objects of the task type) are
assigned.
18.a/3
Aspect Description
for Dispatching_Domain: Domain
(group of processors) on which a given task should run.
Legality Rules
19/3
{
AI05-0167-1}
The Dispatching_Domain aspect shall not be specified
for a task interface.
Dynamic Semantics
20/3
{
AI05-0167-1}
The expression specified for the Dispatching_Domain
aspect of a task is evaluated for each task object (see 9.1).
The Dispatching_Domain value is then associated with the task object
whose task declaration specifies the aspect.
21/3
{
AI05-0167-1}
If a task is not explicitly assigned to any domain,
it is assigned to that of the activating task. A task always executes
on some CPU in its domain.
22/3
{
AI05-0167-1}
If both Dispatching_Domain and CPU are specified
for a task, and the CPU value is not contained within the range of processors
for the domain (and is not Not_A_Specific_CPU), the activation of the
task is defined to have failed, and it becomes a completed task (see
9.2).
23/3
{
AI05-0167-1}
The function Create creates and returns a Dispatching_Domain
containing all the processors in the range First .. Last. These processors
are removed from System_Dispatching_Domain. A call of Create will raise
Dispatching_Domain_Error if any designated processor is not currently
in System_Dispatching_Domain, or if the system cannot support a distinct
domain over the processors identified, or if a processor has a task assigned
to it, or if the allocation would leave System_Dispatching_Domain empty.
A call of Create will raise Dispatching_Domain_Error if the calling task
is not the environment task, or if Create is called after the call to
the main subprogram.
24/3
{
AI05-0167-1}
The function Get_First_CPU returns the first CPU
in Domain; Get_Last_CPU returns the last one.
25/3
{
AI05-0167-1}
The function Get_Dispatching_Domain returns the
Dispatching_Domain on which the task is assigned.
26/3
{
AI05-0167-1}
A call of the procedure Assign_Task assigns task
T to the CPU within Dispatching_Domain Domain. Task T can now execute
only on CPU unless CPU designates Not_A_Specific_CPU, in which case it
can execute on any processor within Domain. The exception Dispatching_Domain_Error
is propagated if T is already assigned to a Dispatching_Domain other
than System_Dispatching_Domain, or if CPU is not one of the processors
of Domain (and is not Not_A_Specific_CPU). A call of Assign_Task is a
task dispatching point for task T. If T is the Current_Task the effect
is immediate, otherwise the effect is as soon as practical. Assigning
a task to System_Dispatching_Domain that is already assigned to that
domain has no effect.
27/3
{
AI05-0167-1}
A call of procedure Set_CPU assigns task T to the
CPU. Task T can now execute only on CPU, unless CPU designates Not_A_Specific_CPU,
in which case it can execute on any processor within its Dispatching_Domain.
The exception Dispatching_Domain_Error is propagated if CPU is not one
of the processors of the Dispatching_Domain on which T is assigned (and
is not Not_A_Specific_CPU). A call of Set_CPU is a task dispatching point
for task T. If T is the Current_Task the effect is immediate, otherwise
the effect is as soon as practical.
28/3
{
AI05-0167-1}
The function Get_CPU returns the processor assigned
to task T, or Not_A_Specific_CPU if the task is not assigned to a processor.
29/3
{
AI05-0167-1}
A call of Delay_Until_And_Set_CPU delays the calling
task for the designated time and then assigns the task to the specified
processor when the delay expires. The exception Dispatching_Domain_Error
is propagated if P is not one of the processors of the calling task's
Dispatching_Domain (and is not Not_A_Specific_CPU).
Implementation Requirements
30/3
{
AI05-0167-1}
The implementation shall perform the operations
Assign_Task, Set_CPU, Get_CPU and Delay_Until_And_Set_CPU atomically
with respect to any of these operations on the same dispatching_domain,
processor or task.
Implementation Advice
31/3
{
AI05-0167-1}
Each dispatching domain should have separate and
disjoint ready queues.
31.a/3
Implementation Advice:
Each dispatching domain should have
separate and disjoint ready queues.
Documentation Requirements
32/3
{
AI05-0167-1}
The implementation shall document the processor(s)
on which the clock interrupt is handled and hence where delay queue and
ready queue manipulations occur. For any Interrupt_Id whose handler can
execute on more than one processor the implementation shall also document
this set of processors.
32.a/3
Documentation Requirement:
The processor(s) on which the clock
interrupt is handled; the processors on which each Interrupt_Id can be
handled.
Implementation Permissions
33/3
{
AI05-0167-1}
An implementation may limit the number of dispatching
domains that can be created and raise Dispatching_Domain_Error if an
attempt is made to exceed this number.
Extensions to Ada 2005
33.a/3
{
AI05-0167-1}
The package System.Multiprocessors.Dispatching_Domains
and the aspect Dispatching_Domains are new.
Ada 2005 and 2012 Editions sponsored in part by Ada-Europe