gcc/ada/libgnarl/s-taspri__posix.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                 GNAT RUN-TIME LIBRARY (GNARL) COMPONENTS                 --
   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 --                                                                          --
   9 --            Copyright (C) 1991-2017, Florida State University             --
  10 --                     Copyright (C) 1995-2024, AdaCore                     --
  11 --                                                                          --
  12 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  13 -- terms of the  GNU General Public License as published  by the Free Soft- --
  14 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  15 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  16 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  17 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  18 --                                                                          --
  19 -- As a special exception under Section 7 of GPL version 3, you are granted --
  20 -- additional permissions described in the GCC Runtime Library Exception,   --
  21 -- version 3.1, as published by the Free Software Foundation.               --
  22 --                                                                          --
  23 -- You should have received a copy of the GNU General Public License and    --
  24 -- a copy of the GCC Runtime Library Exception along with this program;     --
  25 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  26 -- <http://www.gnu.org/licenses/>.                                          --
  27 --                                                                          --
  28 -- GNARL was developed by the GNARL team at Florida State University.       --
  29 -- Extensive contributions were provided by Ada Core Technologies, Inc.     --
  30 --                                                                          --
  31 ------------------------------------------------------------------------------
  32
  33 --  This is a POSIX-like version of this package
  34
  35 --  Note: this file can only be used for POSIX compliant systems
  36
  37 with System.OS_Interface;
  38
  39 package System.Task_Primitives is
  40    pragma Preelaborate;
  41
  42    type Lock is limited private;
  43    --  Should be used for implementation of protected objects
  44
  45    type RTS_Lock is limited private;
  46    --  Should be used inside the runtime system. The difference between Lock
  47    --  and the RTS_Lock is that the latter serves only as a semaphore so that
  48    --  we do not check for ceiling violations.
  49
  50    type Suspension_Object is limited private;
  51    --  Should be used for the implementation of Ada.Synchronous_Task_Control
  52
  53    type Task_Body_Access is access procedure;
  54    --  Pointer to the task body's entry point (or possibly a wrapper declared
  55    --  local to the GNARL).
  56
  57    type Private_Data is limited private;
  58    --  Any information that the GNULLI needs maintained on a per-task basis.
  59    --  A component of this type is guaranteed to be included in the
  60    --  Ada_Task_Control_Block.
  61
  62    subtype Task_Address is System.Address;
  63    Task_Address_Size : constant := Standard'Address_Size;
  64    --  Type used for task addresses and its size
  65
  66    Alternate_Stack_Size : constant := System.OS_Interface.Alternate_Stack_Size;
  67    --  Import value from System.OS_Interface
  68
  69 private
  70
  71    type RTS_Lock is new System.OS_Interface.pthread_mutex_t;
  72
  73    type Lock is record
  74       RW : aliased System.OS_Interface.pthread_rwlock_t;
  75       WO : aliased RTS_Lock;
  76    end record;
  77
  78    type Suspension_Object is record
  79       State : Boolean;
  80       pragma Atomic (State);
  81       --  Boolean that indicates whether the object is open. This field is
  82       --  marked Atomic to ensure that we can read its value without locking
  83       --  the access to the Suspension_Object.
  84
  85       Waiting : Boolean;
  86       --  Flag showing if there is a task already suspended on this object
  87
  88       L : aliased RTS_Lock;
  89       --  Protection for ensuring mutual exclusion on the Suspension_Object
  90
  91       CV : aliased System.OS_Interface.pthread_cond_t;
  92       --  Condition variable used to queue threads until condition is signaled
  93    end record;
  94
  95    type Private_Data is limited record
  96       Thread : aliased System.OS_Interface.pthread_t;
  97       pragma Atomic (Thread);
  98       --  Thread field may be updated by two different threads of control.
  99       --  (See, Enter_Task and Create_Task in s-taprop.adb). They put the same
 100       --  value (thr_self value). We do not want to use lock on those
 101       --  operations and the only thing we have to make sure is that they are
 102       --  updated in atomic fashion.
 103
 104       LWP : aliased System.Address;
 105       --  The purpose of this field is to provide a better tasking support on
 106       --  gdb. The order of the two first fields (Thread and LWP) is important.
 107       --  On targets where lwp is not relevant, this is equivalent to Thread.
 108
 109       CV : aliased System.OS_Interface.pthread_cond_t;
 110       --  Should be commented ??? (in all versions of taspri)
 111
 112       L : aliased RTS_Lock;
 113       --  Protection for all components is lock L
 114    end record;
 115
 116 end System.Task_Primitives;