gcc/ada/exp_smem.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                             E X P _ S M E M                              --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1998-2023, Free Software Foundation, 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 3,  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 COPYING3.  If not, go to --
  19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  This package contains routines involved in the required expansions for
  27 --  handling shared memory accesses for variables in Shared_Passive packages.
  28
  29 --  See detailed documentation in System.Shared_Storage spec for a full
  30 --  description of the approach that is taken for handling distributed
  31 --  shared memory. This expansion unit in the compiler is responsible
  32 --  for generating the calls to routines in System.Shared_Storage.
  33
  34 with Types; use Types;
  35 package Exp_Smem is
  36
  37    procedure Expand_Shared_Passive_Variable (N : Node_Id);
  38    --  N is the identifier for a shared passive variable. This routine is
  39    --  responsible for determining if this is an assigned to N, or a
  40    --  reference to N, and generating the required calls to the shared
  41    --  memory read/write procedures.
  42
  43    procedure Add_Shared_Var_Lock_Procs (N : Node_Id);
  44    --  The argument is a protected subprogram call, before it is rewritten
  45    --  by Exp_Ch9.Build_Protected_Subprogram_Call. This routine, which is
  46    --  called only in the case of an external call to a protected object
  47    --  that has Is_Shared_Passive set, deals with installing a transient scope
  48    --  and acquiring the appropriate global lock calls for this case. It also
  49    --  generates the necessary read/write calls for the protected object within
  50    --  the lock region.
  51
  52    function Make_Shared_Var_Procs (N : Node_Id) return Node_Id;
  53    --  N is the node for the declaration of a shared passive variable.
  54    --  This procedure constructs an instantiation of
  55    --  System.Shared_Storage.Shared_Var_Procs that contains the read and
  56    --  assignment procedures for the shared memory variable.
  57    --  See System.Shared_Storage for a full description of these procedures
  58    --  and how they are used. The last inserted node is returned.
  59
  60 end Exp_Smem;