[thirdparty/gcc.git] / gcc / ada / s-taspri-mingw.ads

------------------------------------------------------------------------------
--                                                                          --
--                 GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS                 --
--                                                                          --
--                 S Y S T E M . T A S K _ P R I M I T I V E S              --
--                                                                          --
--                                  S p e c                                 --
--                                                                          --
--          Copyright (C) 1991-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 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.                                     --
--                                                                          --
-- 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.     --
--                                                                          --
------------------------------------------------------------------------------

--  This is a NT (native) version of this package

pragma Polling (Off);
--  Turn off polling, we do not want ATC polling to take place during tasking
--  operations. It causes infinite loops and other problems.

with System.OS_Interface;
with System.Win32;

package System.Task_Primitives is
   pragma Preelaborate;

   type Lock is limited private;
   --  Should be used for implementation of protected objects

   type RTS_Lock is limited private;
   --  Should be used inside the runtime system. The difference between Lock
   --  and the RTS_Lock is that the later one serves only as a semaphore so
   --  that do not check for ceiling violations.

   type Suspension_Object is limited private;
   --  Should be used for the implementation of Ada.Synchronous_Task_Control

   type Task_Body_Access is access procedure;
   --  Pointer to the task body's entry point (or possibly a wrapper
   --  declared local to the GNARL).

   type Private_Data is limited private;
   --  Any information that the GNULLI needs maintained on a per-task basis.
   --  A component of this type is guaranteed to be included in the
   --  Ada_Task_Control_Block.

   subtype Task_Address is System.Address;
   --  In some versions of Task_Primitives, notably for VMS, Task_Address is
   --  the short version of address defined in System.Aux_DEC. To avoid
   --  dragging Aux_DEC into tasking packages a tasking specific subtype is
   --  defined here.

   Task_Address_Size : constant := Standard'Address_Size;
   --  The size of Task_Address

   Alternate_Stack_Size : constant := 0;
   --  No alternate signal stack is used on this platform

private

   type Lock is record
      Mutex          : aliased System.OS_Interface.CRITICAL_SECTION;
      Priority       : Integer;
      Owner_Priority : Integer;
   end record;

   type Condition_Variable is new System.Win32.HANDLE;

   type RTS_Lock is new System.OS_Interface.CRITICAL_SECTION;

   type Suspension_Object is record
      State : Boolean;
      pragma Atomic (State);
      --  Boolean that indicates whether the object is open. This field is
      --  marked Atomic to ensure that we can read its value without locking
      --  the access to the Suspension_Object.

      Waiting : Boolean;
      --  Flag showing if there is a task already suspended on this object

      L : aliased System.OS_Interface.CRITICAL_SECTION;
      --  Protection for ensuring mutual exclusion on the Suspension_Object

      CV : aliased Win32.HANDLE;
      --  Condition variable used to queue threads until condition is signaled
   end record;

   type Private_Data is record
      Thread : aliased Win32.HANDLE;
      pragma Atomic (Thread);
      --  Thread field may be updated by two different threads of control.
      --  (See, Enter_Task and Create_Task in s-taprop.adb).
      --  They put the same value (thr_self value). We do not want to
      --  use lock on those operations and the only thing we have to
      --  make sure is that they are updated in atomic fashion.

      Thread_Id : aliased Win32.DWORD;
      --  Used to provide a better tasking support in gdb

      CV : aliased Condition_Variable;
      --  Condition Variable used to implement Sleep/Wakeup

      L : aliased RTS_Lock;
      --  Protection for all components is lock L
   end record;

end System.Task_Primitives;
Commit	Line	Data
84481f76 RK	1	------------------------------------------------------------------------------
84481f76 RK	2	-- --
b497b460	3	-- GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS --
84481f76 RK	4	-- --
	5	-- S Y S T E M . T A S K _ P R I M I T I V E S --
	6	-- --
	7	-- S p e c --
	8	-- --
748086b7	9	-- Copyright (C) 1991-2009, Free Software Foundation, Inc. --
84481f76 RK	10	-- --
	11	-- GNARL is free software; you can redistribute it and/or modify it under --
	12	-- terms of the GNU General Public License as published by the Free Soft- --
748086b7 JJ	13	-- ware Foundation; either version 3, or (at your option) any later ver- --
748086b7 JJ	14	-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
84481f76	15	-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
748086b7 JJ	16	-- or FITNESS FOR A PARTICULAR PURPOSE. --
	17	-- --
	18	-- As a special exception under Section 7 of GPL version 3, you are granted --
	19	-- additional permissions described in the GCC Runtime Library Exception, --
	20	-- version 3.1, as published by the Free Software Foundation. --
	21	-- --
	22	-- You should have received a copy of the GNU General Public License and --
	23	-- a copy of the GCC Runtime Library Exception along with this program; --
	24	-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
	25	-- <http://www.gnu.org/licenses/>. --
84481f76	26	-- --
71ff80dc	27	-- GNARL was developed by the GNARL team at Florida State University. --
fbf5a39b	28	-- Extensive contributions were provided by Ada Core Technologies, Inc. --
84481f76 RK	29	-- --
	30	------------------------------------------------------------------------------
	31
b497b460	32	-- This is a NT (native) version of this package
84481f76 RK	33
84481f76 RK	34	pragma Polling (Off);
366b8af7 RD	35	-- Turn off polling, we do not want ATC polling to take place during tasking
366b8af7 RD	36	-- operations. It causes infinite loops and other problems.
84481f76 RK	37
84481f76 RK	38	with System.OS_Interface;
3824d9af	39	with System.Win32;
84481f76 RK	40
84481f76 RK	41	package System.Task_Primitives is
3b91d88e	42	pragma Preelaborate;
84481f76 RK	43
84481f76 RK	44	type Lock is limited private;
b497b460	45	-- Should be used for implementation of protected objects
84481f76 RK	46
84481f76 RK	47	type RTS_Lock is limited private;
b497b460 JR	48	-- Should be used inside the runtime system. The difference between Lock
	49	-- and the RTS_Lock is that the later one serves only as a semaphore so
	50	-- that do not check for ceiling violations.
	51
	52	type Suspension_Object is limited private;
	53	-- Should be used for the implementation of Ada.Synchronous_Task_Control
84481f76 RK	54
	55	type Task_Body_Access is access procedure;
	56	-- Pointer to the task body's entry point (or possibly a wrapper
	57	-- declared local to the GNARL).
	58
	59	type Private_Data is limited private;
b497b460 JR	60	-- Any information that the GNULLI needs maintained on a per-task basis.
	61	-- A component of this type is guaranteed to be included in the
	62	-- Ada_Task_Control_Block.
84481f76	63
3824d9af PO	64	subtype Task_Address is System.Address;
	65	-- In some versions of Task_Primitives, notably for VMS, Task_Address is
	66	-- the short version of address defined in System.Aux_DEC. To avoid
	67	-- dragging Aux_DEC into tasking packages a tasking specific subtype is
	68	-- defined here.
	69
	70	Task_Address_Size : constant := Standard'Address_Size;
	71	-- The size of Task_Address
	72
	73	Alternate_Stack_Size : constant := 0;
	74	-- No alternate signal stack is used on this platform
	75
84481f76 RK	76	private
	77
	78	type Lock is record
	79	Mutex : aliased System.OS_Interface.CRITICAL_SECTION;
	80	Priority : Integer;
	81	Owner_Priority : Integer;
	82	end record;
	83
3824d9af	84	type Condition_Variable is new System.Win32.HANDLE;
84481f76 RK	85
	86	type RTS_Lock is new System.OS_Interface.CRITICAL_SECTION;
	87
b497b460 JR	88	type Suspension_Object is record
	89	State : Boolean;
	90	pragma Atomic (State);
	91	-- Boolean that indicates whether the object is open. This field is
	92	-- marked Atomic to ensure that we can read its value without locking
	93	-- the access to the Suspension_Object.
	94
	95	Waiting : Boolean;
	96	-- Flag showing if there is a task already suspended on this object
	97
	98	L : aliased System.OS_Interface.CRITICAL_SECTION;
	99	-- Protection for ensuring mutual exclusion on the Suspension_Object
	100
3824d9af	101	CV : aliased Win32.HANDLE;
b497b460 JR	102	-- Condition variable used to queue threads until condition is signaled
	103	end record;
	104
84481f76	105	type Private_Data is record
3824d9af	106	Thread : aliased Win32.HANDLE;
84481f76 RK	107	pragma Atomic (Thread);
	108	-- Thread field may be updated by two different threads of control.
	109	-- (See, Enter_Task and Create_Task in s-taprop.adb).
	110	-- They put the same value (thr_self value). We do not want to
	111	-- use lock on those operations and the only thing we have to
	112	-- make sure is that they are updated in atomic fashion.
	113
3824d9af	114	Thread_Id : aliased Win32.DWORD;
b497b460	115	-- Used to provide a better tasking support in gdb
84481f76 RK	116
	117	CV : aliased Condition_Variable;
	118	-- Condition Variable used to implement Sleep/Wakeup
	119
	120	L : aliased RTS_Lock;
	121	-- Protection for all components is lock L
	122	end record;
	123
	124	end System.Task_Primitives;