gcc/ada/g-tasloc.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                       G N A T . T A S K _ L O C K                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --            Copyright (C) 1998-2002 Ada Core Technologies, Inc.           --
  10 --                                                                          --
  11 -- GNAT 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- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  20 -- MA 02111-1307, USA.                                                      --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com).   --
  30 --                                                                          --
  31 ------------------------------------------------------------------------------
  32
  33 --  Simple task lock and unlock routines
  34
  35 --  A small package containing a task lock and unlock routines for creating
  36 --  a critical region. The lock involved is a global lock, shared by all
  37 --  tasks, and by all calls to these routines, so these routines should be
  38 --  used with care to avoid unnecessary reduction of concurrency.
  39
  40 --  These routines may be used in a non-tasking program, and in that case
  41 --  they have no effect (they do NOT cause the tasking runtime to be loaded).
  42
  43 package GNAT.Task_Lock is
  44 pragma Elaborate_Body (Task_Lock);
  45
  46    procedure Lock;
  47    pragma Inline (Lock);
  48    --  Acquires the global lock, starts the execution of a critical region
  49    --  which no other task can enter until the locking task calls Unlock
  50
  51    procedure Unlock;
  52    pragma Inline (Unlock);
  53    --  Releases the global lock, allowing another task to successfully
  54    --  complete a Lock operation. Terminates the critical region.
  55    --
  56    --  The recommended protocol for using these two procedures is as
  57    --  follows:
  58    --
  59    --    Locked_Processing : begin
  60    --       Lock;
  61    --       ...
  62    --       TSL.Unlock;
  63    --
  64    --    exception
  65    --       when others =>
  66    --          Unlock;
  67    --          raise;
  68    --    end Locked_Processing;
  69    --
  70    --  This ensures that the lock is not left set if an exception is raised
  71    --  explicitly or implicitly during the critical locked region.
  72    --
  73    --  Note on multiple calls to Lock: It is permissible to call Lock
  74    --  more than once with no intervening Unlock from a single task,
  75    --  and the lock will not be released until the corresponding number
  76    --  of Unlock operations has been performed. For example:
  77    --
  78    --    GNAT.Task_Lock.Lock;     -- acquires lock
  79    --    GNAT.Task_Lock.Lock;     -- no effect
  80    --    GNAT.Task_Lock.Lock;     -- no effect
  81    --    GNAT.Task_Lock.Unlock;   -- no effect
  82    --    GNAT.Task_Lock.Unlock;   -- no effect
  83    --    GNAT.Task_Lock.Unlock;   -- releases lock
  84    --
  85    --  However, as previously noted, the Task_Lock facility should only
  86    --  be used for very local locks where the probability of conflict is
  87    --  low, so usually this kind of nesting is not a good idea in any case.
  88    --  In more complex locking situations, it is more appropriate to define
  89    --  an appropriate protected type to provide the required locking.
  90    --
  91    --  It is an error to call Unlock when there has been no prior call to
  92    --  Lock. The effect of such an erroneous call is undefined, and may
  93    --  result in deadlock, or other malfunction of the run-time system.
  94
  95 end GNAT.Task_Lock;