gcc/ada/libgnarl/a-taside.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --              A D A . T A S K _ I D E N T I F I C A T I O N               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2024, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- This specification is derived from the Ada Reference Manual for use with --
  12 -- GNAT. The copyright notice above, and the license provisions that follow --
  13 -- apply solely to the  contents of the part following the private keyword. --
  14 --                                                                          --
  15 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  16 -- terms of the  GNU General Public License as published  by the Free Soft- --
  17 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  18 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  19 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  20 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  21 --                                                                          --
  22 -- As a special exception under Section 7 of GPL version 3, you are granted --
  23 -- additional permissions described in the GCC Runtime Library Exception,   --
  24 -- version 3.1, as published by the Free Software Foundation.               --
  25 --                                                                          --
  26 -- You should have received a copy of the GNU General Public License and    --
  27 -- a copy of the GCC Runtime Library Exception along with this program;     --
  28 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  29 -- <http://www.gnu.org/licenses/>.                                          --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 --  Preconditions in this unit are meant for analysis only, not for run-time
  37 --  checking, so that the expected exceptions are raised.
  38 --  This is enforced by setting the corresponding assertion policy to Ignore.
  39
  40 pragma Assertion_Policy (Pre => Ignore);
  41
  42 with System;
  43 with System.Tasking;
  44
  45 package Ada.Task_Identification with
  46   SPARK_Mode,
  47   Abstract_State => (Tasking_State with Synchronous),
  48   Initializes    => Tasking_State
  49 is
  50    pragma Preelaborate;
  51    --  In accordance with Ada 2005 AI-362
  52
  53    type Task_Id is private;
  54    pragma Preelaborable_Initialization (Task_Id);
  55
  56    Null_Task_Id : constant Task_Id;
  57
  58    function "=" (Left, Right : Task_Id) return Boolean with
  59      Global => null;
  60    pragma Inline ("=");
  61
  62    function Image (T : Task_Id) return String with
  63      Global => null;
  64
  65    function Current_Task return Task_Id with
  66      Volatile_Function,
  67      Global => Tasking_State;
  68    pragma Inline (Current_Task);
  69
  70    function Environment_Task return Task_Id with
  71      SPARK_Mode => Off,
  72      Global     => null;
  73    pragma Inline (Environment_Task);
  74
  75    procedure Abort_Task (T : Task_Id) with
  76      Pre    => T /= Null_Task_Id,
  77      Global => null;
  78    pragma Inline (Abort_Task);
  79    --  Note: parameter is mode IN, not IN OUT, per AI-00101
  80
  81    function Is_Terminated (T : Task_Id) return Boolean with
  82      Volatile_Function,
  83      Pre    => T /= Null_Task_Id,
  84      Global => Tasking_State;
  85    pragma Inline (Is_Terminated);
  86
  87    function Is_Callable (T : Task_Id) return Boolean with
  88      Volatile_Function,
  89      Pre    => T /= Null_Task_Id,
  90      Global => Tasking_State;
  91    pragma Inline (Is_Callable);
  92
  93    function Activation_Is_Complete (T : Task_Id) return Boolean with
  94      Volatile_Function,
  95      Pre    => T /= Null_Task_Id,
  96      Global => Tasking_State;
  97    pragma Inline (Activation_Is_Complete);
  98
  99 private
 100    pragma SPARK_Mode (Off);
 101
 102    type Task_Id is new System.Tasking.Task_Id;
 103
 104    Null_Task_Id : constant Task_Id := null;
 105
 106 end Ada.Task_Identification;