OSDN Git Service

2009-12-01 Thomas Quinot <quinot@adacore.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / s-tassta.ads
index 92084f0..0364743 100644 (file)
@@ -1,33 +1,31 @@
 ------------------------------------------------------------------------------
 --                                                                          --
---                GNU ADA RUN-TIME LIBRARY (GNARL) COMPONENTS               --
+--                 GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS                 --
 --                                                                          --
 --                 S Y S T E M . T A S K I N G . S T A G E S                --
 --                                                                          --
 --                                  S p e c                                 --
 --                                                                          --
---          Copyright (C) 1992-1999, Free Software Foundation, Inc.         --
+--          Copyright (C) 1992-2009, Free Software Foundation, Inc.         --
 --                                                                          --
 -- GNARL is free software; you can  redistribute it  and/or modify it under --
 -- terms of the  GNU General Public License as published  by the Free Soft- --
--- ware  Foundation;  either version 2,  or (at your option) any later ver- --
--- sion. GNARL is distributed in the hope that it will be useful, but WITH- --
+-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
+-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
--- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
--- for  more details.  You should have  received  a copy of the GNU General --
--- Public License  distributed with GNARL; see file COPYING.  If not, write --
--- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
--- MA 02111-1307, USA.                                                      --
+-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
 --                                                                          --
--- As a special exception,  if other files  instantiate  generics from this --
--- unit, or you link  this unit with other files  to produce an executable, --
--- this  unit  does not  by itself cause  the resulting  executable  to  be --
--- covered  by the  GNU  General  Public  License.  This exception does not --
--- however invalidate  any other reasons why  the executable file  might be --
--- covered by the  GNU Public License.                                      --
+-- As a special exception under Section 7 of GPL version 3, you are granted --
+-- additional permissions described in the GCC Runtime Library Exception,   --
+-- version 3.1, as published by the Free Software Foundation.               --
+--                                                                          --
+-- You should have received a copy of the GNU General Public License and    --
+-- a copy of the GCC Runtime Library Exception along with this program;     --
+-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
+-- <http://www.gnu.org/licenses/>.                                          --
 --                                                                          --
 -- GNARL was developed by the GNARL team at Florida State University.       --
--- Extensive contributions were provided by Ada Core Technologies Inc.      --
+-- Extensive contributions were provided by Ada Core Technologies, Inc.     --
 --                                                                          --
 ------------------------------------------------------------------------------
 
 
 --  Note: Only the compiler is allowed to use this interface, by generating
 --  direct calls to it, via Rtsfind.
+
 --  Any changes to this interface may require corresponding compiler changes
 --  in exp_ch9.adb and possibly exp_ch7.adb
 
 with System.Task_Info;
---  used for Task_Info_Type
-
 with System.Parameters;
---  used for Size_Type
+
+with Ada.Real_Time;
 
 package System.Tasking.Stages is
    pragma Elaborate_Body;
 
    --   The compiler will expand in the GNAT tree the following construct:
-   --
+
    --   task type T (Discr : Integer);
-   --
+
    --   task body T is
    --      ...declarations, possibly some controlled...
    --   begin
    --      ...B...;
    --   end T;
-   --
+
    --   T1 : T (1);
-   --
+
    --  as follows:
-   --
+
    --   enter_master.all;
-   --
+
    --   _chain : aliased activation_chain;
-   --   _init_proc (_chain);
-   --
+   --   activation_chainIP (_chain);
+
    --   task type t (discr : integer);
    --   tE : aliased boolean := false;
    --   tZ : size_type := unspecified_size;
@@ -76,24 +74,24 @@ package System.Tasking.Stages is
    --   end record;
    --   procedure tB (_task : access tV);
    --   freeze tV [
-   --      procedure _init_proc (_init : in out tV; _master : master_id;
+   --      procedure tVIP (_init : in out tV; _master : master_id;
    --        _chain : in out activation_chain; _task_id : in task_image_type;
    --        discr : integer) is
    --      begin
    --         _init.discr := discr;
    --         _init._task_id := null;
    --         create_task (unspecified_priority, tZ,
-   --           unspecified_task_info, 0, _master,
-   --           task_procedure_access!(tB'address),
+   --           unspecified_task_info, ada__real_time__time_span_zero, 0,
+   --           _master, task_procedure_access!(tB'address),
    --           _init'address, tE'unchecked_access, _chain, _task_id, _init.
    --           _task_id);
    --         return;
-   --      end _init_proc;
+   --      end tVIP;
    --   ]
-   --
+
    --   procedure tB (_task : access tV) is
    --      discr : integer renames _task.discr;
-   --
+
    --      procedure _clean is
    --      begin
    --         abort_defer.all;
@@ -111,19 +109,19 @@ package System.Tasking.Stages is
    --   at end
    --      _clean;
    --   end tB;
-   --
+
    --   tE := true;
    --   t1 : t (1);
-   --   master : constant master_id := current_master.all;
-   --   t1I : task_image_type := new string'"t1";
-   --   _init_proc (t1, _master, _chain, t1I, 1);
-   --
+   --   _master : constant master_id := current_master.all;
+   --   t1S : task_image_type := new string'"t1";
+   --   task_image_typeIP (t1, _master, _chain, t1S, 1);
+
    --   activate_tasks (_chain'unchecked_access);
 
    procedure Abort_Tasks (Tasks : Task_List);
-   --  Compiler interface only. Do not call from within the RTS.
-   --  Initiate abortion, however, the actual abortion is done by abortee by
-   --  means of Abort_Handler and Abort_Undefer
+   --  Compiler interface only. Do not call from within the RTS. Initiate
+   --  abort, however, the actual abort is done by abortee by means of
+   --  Abort_Handler and Abort_Undefer
    --
    --  source code:
    --     Abort T1, T2;
@@ -143,6 +141,8 @@ package System.Tasking.Stages is
    --  it is not needed if priority-based scheduling is supported, since all
    --  the activated tasks synchronize on the activators lock before they
    --  start activating and so they should start activating in priority order.
+   --  ??? Actually, the body of this package DOES reverse the chain, so I
+   --  don't understand the above comment.
 
    procedure Complete_Activation;
    --  Compiler interface only. Do not call from within the RTS.
@@ -167,17 +167,19 @@ package System.Tasking.Stages is
    --  now in order to wake up the activator (the environment task).
 
    procedure Create_Task
-     (Priority      : Integer;
-      Size          : System.Parameters.Size_Type;
-      Task_Info     : System.Task_Info.Task_Info_Type;
-      Num_Entries   : Task_Entry_Index;
-      Master        : Master_Level;
-      State         : Task_Procedure_Access;
-      Discriminants : System.Address;
-      Elaborated    : Access_Boolean;
-      Chain         : in out Activation_Chain;
-      Task_Image    : System.Task_Info.Task_Image_Type;
-      Created_Task  : out Task_ID);
+     (Priority          : Integer;
+      Size              : System.Parameters.Size_Type;
+      Task_Info         : System.Task_Info.Task_Info_Type;
+      Relative_Deadline : Ada.Real_Time.Time_Span;
+      Num_Entries       : Task_Entry_Index;
+      Master            : Master_Level;
+      State             : Task_Procedure_Access;
+      Discriminants     : System.Address;
+      Elaborated        : Access_Boolean;
+      Chain             : in out Activation_Chain;
+      Task_Image        : String;
+      Created_Task      : out Task_Id;
+      Build_Entry_Names : Boolean);
    --  Compiler interface only. Do not call from within the RTS.
    --  This must be called to create a new task.
    --
@@ -186,6 +188,8 @@ package System.Tasking.Stages is
    --  Size is the stack size of the task to create
    --  Task_Info is the task info associated with the created task, or
    --   Unspecified_Task_Info if none.
+   --  Relative_Deadline is the relative deadline associated with the created
+   --   task by means of a pragma Relative_Deadline, or 0.0 if none.
    --  State is the compiler generated task's procedure body
    --  Discriminants is a pointer to a limited record whose discriminants
    --   are those of the task to create. This parameter should be passed as
@@ -196,10 +200,12 @@ package System.Tasking.Stages is
    --   Created_Task.Activation_Link will be Chain.T_ID, and Chain.T_ID
    --   will be Created_Task (e.g the created task will be linked at the front
    --   of Chain).
-   --  Task_Image is a pointer to a string created by the compiler that the
+   --  Task_Image is a string created by the compiler that the
    --   run time can store to ease the debugging and the
    --   Ada.Task_Identification facility.
    --  Created_Task is the resulting task.
+   --  Build_Entry_Names is a flag which controls the allocation of the data
+   --   structure which stores all entry names.
    --
    --  This procedure can raise Storage_Error if the task creation failed.
 
@@ -214,7 +220,7 @@ package System.Tasking.Stages is
    --  declared.
 
    procedure Expunge_Unactivated_Tasks (Chain : in out Activation_Chain);
-   --  Compiler interface only.  Do not call from within the RTS.
+   --  Compiler interface only. Do not call from within the RTS.
    --  This must be called by the compiler-generated code for an allocator if
    --  the allocated object contains tasks, if the allocator exits without
    --  calling Activate_Tasks for a given activation chains, as can happen if
@@ -250,12 +256,35 @@ package System.Tasking.Stages is
    --  It currently also executes the global finalization list, and then resets
    --  the "soft links".
 
-   procedure Free_Task (T : Task_ID);
+   procedure Free_Task (T : Task_Id);
    --  Recover all runtime system storage associated with the task T, but only
    --  if T has terminated. Do nothing in the other case. It is called from
    --  Unchecked_Deallocation, for objects that are or contain tasks.
 
-   function Terminated (T : Task_ID) return Boolean;
+   procedure Move_Activation_Chain
+     (From, To   : Activation_Chain_Access;
+      New_Master : Master_ID);
+   --  Compiler interface only. Do not call from within the RTS.
+   --  Move all tasks on From list to To list, and change their Master_of_Task
+   --  to be New_Master. This is used to implement build-in-place function
+   --  returns. Tasks that are part of the return object are initially placed
+   --  on an activation chain local to the return statement, and their master
+   --  is the return statement, in case the return statement is left
+   --  prematurely (due to raising an exception, being aborted, or a goto or
+   --  exit statement). Once the return statement has completed successfully,
+   --  Move_Activation_Chain is called to move them to the caller's activation
+   --  chain, and change their master to the one passed in by the caller. If
+   --  that doesn't happen, they will never be activated, and will become
+   --  terminated on leaving the return statement.
+
+   procedure Set_Entry_Name
+     (T   : Task_Id;
+      Pos : Task_Entry_Index;
+      Val : String_Access);
+   --  This is called by the compiler to map a string which denotes an entry
+   --  name to a task entry index.
+
+   function Terminated (T : Task_Id) return Boolean;
    --  This is called by the compiler to implement the 'Terminated attribute.
    --  Though is not required to be so by the ARM, we choose to synchronize
    --  with the task's ATCB, so that this is more useful for polling the state
@@ -268,4 +297,9 @@ package System.Tasking.Stages is
    --  code expansion:
    --     terminated (t1._task_id)
 
+   procedure Terminate_Task (Self_ID : Task_Id);
+   --  Terminate the calling task.
+   --  This should only be called by the Task_Wrapper procedure, and to
+   --  deallocate storage associate with foreign tasks.
+
 end System.Tasking.Stages;