gcc/ada/ghost.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                                G H O S T                                 --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2014-2018, 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 that deal with the static and runtime
  27 --  semantics of Ghost entities.
  28
  29 with Opt;   use Opt;
  30 with Types; use Types;
  31
  32 package Ghost is
  33
  34    procedure Add_Ignored_Ghost_Unit (Unit : Node_Id);
  35    --  Add a single ignored Ghost compilation unit to the internal table for
  36    --  post processing.
  37
  38    procedure Check_Ghost_Completion
  39      (Prev_Id  : Entity_Id;
  40       Compl_Id : Entity_Id);
  41    --  Verify that the Ghost policy of initial entity Prev_Id is compatible
  42    --  with the Ghost policy of completing entity Compl_Id. Emit an error if
  43    --  this is not the case.
  44
  45    procedure Check_Ghost_Context
  46      (Ghost_Id  : Entity_Id;
  47       Ghost_Ref : Node_Id);
  48    --  Determine whether node Ghost_Ref appears within a Ghost-friendly context
  49    --  where Ghost entity Ghost_Id can safely reside.
  50
  51    procedure Check_Ghost_Overriding
  52      (Subp            : Entity_Id;
  53       Overridden_Subp : Entity_Id);
  54    --  Verify that the Ghost policy of parent subprogram Overridden_Subp is
  55    --  compatible with the Ghost policy of overriding subprogram Subp. Emit
  56    --  an error if this is not the case.
  57
  58    procedure Check_Ghost_Primitive (Prim : Entity_Id; Typ : Entity_Id);
  59    --  Verify that the Ghost policy of primitive operation Prim is the same as
  60    --  the Ghost policy of tagged type Typ. Emit an error if this is not the
  61    --  case.
  62
  63    procedure Check_Ghost_Refinement
  64      (State      : Node_Id;
  65       State_Id   : Entity_Id;
  66       Constit    : Node_Id;
  67       Constit_Id : Entity_Id);
  68    --  Verify that the Ghost policy of constituent Constit_Id is compatible
  69    --  with the Ghost policy of abstract state State_I.
  70
  71    procedure Check_Ghost_Type (Typ : Entity_Id);
  72    --  Verify that Ghost type Typ is neither concurrent, nor effectively
  73    --  volatile.
  74
  75    function Implements_Ghost_Interface (Typ : Entity_Id) return Boolean;
  76    --  Determine whether type Typ implements at least one Ghost interface
  77
  78    procedure Initialize;
  79    --  Initialize internal tables
  80
  81    procedure Install_Ghost_Region (Mode : Ghost_Mode_Type; N : Node_Id);
  82    pragma Inline (Install_Ghost_Region);
  83    --  Install a Ghost region described by mode Mode and ignored region start
  84    --  node N.
  85
  86    function Is_Ghost_Assignment (N : Node_Id) return Boolean;
  87    --  Determine whether arbitrary node N denotes an assignment statement whose
  88    --  target is a Ghost entity.
  89
  90    function Is_Ghost_Declaration (N : Node_Id) return Boolean;
  91    --  Determine whether arbitrary node N denotes a declaration which defines
  92    --  a Ghost entity.
  93
  94    function Is_Ghost_Pragma (N : Node_Id) return Boolean;
  95    --  Determine whether arbitrary node N denotes a pragma which encloses a
  96    --  Ghost entity or is associated with a Ghost entity.
  97
  98    function Is_Ghost_Procedure_Call (N : Node_Id) return Boolean;
  99    --  Determine whether arbitrary node N denotes a procedure call invoking a
 100    --  Ghost procedure.
 101
 102    function Is_Ignored_Ghost_Unit (N : Node_Id) return Boolean;
 103    --  Determine whether compilation unit N is subject to pragma Ghost with
 104    --  policy Ignore.
 105
 106    procedure Lock;
 107    --  Lock internal tables before calling backend
 108
 109    procedure Mark_And_Set_Ghost_Assignment (N : Node_Id);
 110    --  Mark assignment statement N as Ghost when:
 111    --
 112    --    * The left hand side denotes a Ghost entity
 113    --
 114    --  Install the Ghost mode of the assignment statement. This routine starts
 115    --  a Ghost region and must be used with routine Restore_Ghost_Region.
 116
 117    procedure Mark_And_Set_Ghost_Body
 118      (N       : Node_Id;
 119       Spec_Id : Entity_Id);
 120    --  Mark package or subprogram body N as Ghost when:
 121    --
 122    --    * The body is subject to pragma Ghost
 123    --
 124    --    * The body completes a previous declaration whose spec denoted by
 125    --      Spec_Id is a Ghost entity.
 126    --
 127    --    * The body appears within a Ghost region
 128    --
 129    --  Install the Ghost mode of the body. This routine starts a Ghost region
 130    --  and must be used with routine Restore_Ghost_Region.
 131
 132    procedure Mark_And_Set_Ghost_Completion
 133      (N       : Node_Id;
 134       Prev_Id : Entity_Id);
 135    --  Mark completion N of a deferred constant or private type [extension]
 136    --  Ghost when:
 137    --
 138    --    * The entity of the previous declaration denoted by Prev_Id is Ghost
 139    --
 140    --    * The completion appears within a Ghost region
 141    --
 142    --  Install the Ghost mode of the completion. This routine starts a Ghost
 143    --  region and must be used with routine Restore_Ghost_Region.
 144
 145    procedure Mark_And_Set_Ghost_Declaration (N : Node_Id);
 146    --  Mark declaration N as Ghost when:
 147    --
 148    --    * The declaration is subject to pragma Ghost
 149    --
 150    --    * The declaration denotes a child package or subprogram and the parent
 151    --      is a Ghost unit.
 152    --
 153    --    * The declaration appears within a Ghost region
 154    --
 155    --  Install the Ghost mode of the declaration. This routine starts a Ghost
 156    --  region and must be used with routine Restore_Ghost_Region.
 157
 158    procedure Mark_And_Set_Ghost_Instantiation
 159      (N      : Node_Id;
 160       Gen_Id : Entity_Id);
 161    --  Mark instantiation N as Ghost when:
 162    --
 163    --    * The instantiation is subject to pragma Ghost
 164    --
 165    --    * The generic template denoted by Gen_Id is Ghost
 166    --
 167    --    * The instantiation appears within a Ghost region
 168    --
 169    --  Install the Ghost mode of the instantiation. This routine starts a Ghost
 170    --  region and must be used with routine Restore_Ghost_Region.
 171
 172    procedure Mark_And_Set_Ghost_Procedure_Call (N : Node_Id);
 173    --  Mark procedure call N as Ghost when:
 174    --
 175    --    * The procedure being invoked is a Ghost entity
 176    --
 177    --  Install the Ghost mode of the procedure call. This routine starts a
 178    --  Ghost region and must be used with routine Restore_Ghost_Region.
 179
 180    procedure Mark_Ghost_Clause (N : Node_Id);
 181    --  Mark use package, use type, or with clause N as Ghost when:
 182    --
 183    --    * The clause mentions a Ghost entity
 184
 185    procedure Mark_Ghost_Pragma
 186      (N  : Node_Id;
 187       Id : Entity_Id);
 188    --  Mark pragma N as Ghost when:
 189    --
 190    --    * The pragma encloses Ghost entity Id
 191    --
 192    --    * The pragma is associated with Ghost entity Id
 193
 194    procedure Mark_Ghost_Renaming
 195      (N  : Node_Id;
 196       Id : Entity_Id);
 197    --  Mark renaming declaration N as Ghost when:
 198    --
 199    --    * Renamed entity Id denotes a Ghost entity
 200
 201    procedure Remove_Ignored_Ghost_Code;
 202    --  Remove all code marked as ignored Ghost from the trees of all qualifying
 203    --  units (SPARK RM 6.9(4)).
 204    --
 205    --  WARNING: this is a separate front end pass, care should be taken to keep
 206    --  it optimized.
 207
 208    procedure Restore_Ghost_Region (Mode : Ghost_Mode_Type; N : Node_Id);
 209    pragma Inline (Restore_Ghost_Region);
 210    --  Restore a Ghost region to a previous state described by mode Mode and
 211    --  ignored region start node N. This routine must be used in conjunction
 212    --  with the following routines:
 213    --
 214    --    Install_Ghost_Region
 215    --    Mark_And_Set_xxx
 216    --    Set_Ghost_Mode
 217
 218    procedure Set_Ghost_Mode (N : Node_Or_Entity_Id);
 219    --  Install the Ghost mode of arbitrary node N. This routine starts a Ghost
 220    --  region and must be used with routine Restore_Ghost_Region.
 221
 222    procedure Set_Is_Ghost_Entity (Id : Entity_Id);
 223    --  Set the relevant Ghost attributes of entity Id depending on the current
 224    --  Ghost assertion policy in effect.
 225
 226 end Ghost;