gcc/ada/s-parame.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                    S Y S T E M . P A R A M E T E R S                     --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2001 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 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 was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  This is the default version used for all systems for which no special
  35 --  target-specific version of this package is provided.
  36
  37 --  This package defines some system dependent parameters for GNAT. These
  38 --  are values that are referenced by the runtime library and are therefore
  39 --  relevant to the target machine.
  40
  41 --  The parameters whose value is defined in the spec are not generally
  42 --  expected to be changed. If they are changed, it will be necessary to
  43 --  recompile the run-time library.
  44
  45 --  The parameters which are defined by functions can be changed by modifying
  46 --  the body of System.Parameters in file s-parame.adb. A change to this body
  47 --  requires only rebinding and relinking of the application.
  48
  49 --  Note: do not introduce any pragma Inline statements into this unit, since
  50 --  otherwise the relinking and rebinding capability would be deactivated.
  51
  52 package System.Parameters is
  53 pragma Pure (Parameters);
  54
  55    ---------------------------------------
  56    -- Task And Stack Allocation Control --
  57    ---------------------------------------
  58
  59    type Task_Storage_Size is new Integer;
  60    --  Type used in tasking units for task storage size
  61
  62    type Size_Type is new Task_Storage_Size;
  63    --  Type used to provide task storage size to runtime
  64
  65    Unspecified_Size : constant Size_Type := Size_Type'First;
  66    --  Value used to indicate that no size type is set
  67
  68    subtype Ratio is Size_Type range -1 .. 100;
  69    Dynamic : constant Size_Type := -1;
  70    --  The secondary stack ratio is a constant between 0 and 100 which
  71    --  determines the percentage of the allocated task stack that is
  72    --  used by the secondary stack (the rest being the primary stack).
  73    --  The special value of minus one indicates that the secondary
  74    --  stack is to be allocated from the heap instead.
  75
  76    Sec_Stack_Ratio : constant Ratio := Dynamic;
  77    --  This constant defines the handling of the secondary stack
  78
  79    Sec_Stack_Dynamic : constant Boolean := Sec_Stack_Ratio = Dynamic;
  80    --  Convenient Boolean for testing for dynamic secondary stack
  81
  82    function Default_Stack_Size return Size_Type;
  83    --  Default task stack size used if none is specified
  84
  85    function Minimum_Stack_Size return Size_Type;
  86    --  Minimum task stack size permitted
  87
  88    function Adjust_Storage_Size (Size : Size_Type) return Size_Type;
  89    --  Given the storage size stored in the TCB, return the Storage_Size
  90    --  value required by the RM for the Storage_Size attribute. The
  91    --  required adjustment is as follows:
  92    --
  93    --    when Size = Unspecified_Size, return Default_Stack_Size
  94    --    when Size < Minimum_Stack_Size, return Minimum_Stack_Size
  95    --    otherwise return given Size
  96
  97    Stack_Grows_Down  : constant Boolean := True;
  98    --  This constant indicates whether the stack grows up (False) or
  99    --  down (True) in memory as functions are called. It is used for
 100    --  proper implementation of the stack overflow check.
 101
 102    ----------------------------------------------
 103    -- Characteristics of types in Interfaces.C --
 104    ----------------------------------------------
 105
 106    long_bits : constant := Long_Integer'Size;
 107    --  Number of bits in type long and unsigned_long. The normal convention
 108    --  is that this is the same as type Long_Integer, but this is not true
 109    --  of all targets. For example, in OpenVMS long /= Long_Integer.
 110
 111    ----------------------------------------------
 112    -- Behavior of Pragma Finalize_Storage_Only --
 113    ----------------------------------------------
 114
 115    --  Garbage_Collected is a Boolean constant whose value indicates the
 116    --  effect of the pragma Finalize_Storage_Entry on a controlled type.
 117
 118    --    Garbage_Collected = False
 119
 120    --      The system releases all storage on program termination only,
 121    --      but not other garbage collection occurs, so finalization calls
 122    --      are ommitted only for outer level onjects can be omitted if
 123    --      pragma Finalize_Storage_Only is used.
 124
 125    --    Garbage_Collected = True
 126
 127    --      The system provides full garbage collection, so it is never
 128    --      necessary to release storage for controlled objects for which
 129    --      a pragma Finalize_Storage_Only is used.
 130
 131    Garbage_Collected : constant Boolean := False;
 132    --  The storage mode for this system (release on program exit)
 133
 134    ---------------------
 135    -- Tasking Profile --
 136    ---------------------
 137
 138    --  In the following sections, constant parameters are defined to
 139    --  allow some optimizations within the tasking run time based on
 140    --  restrictions on the tasking features.
 141
 142    ----------------------
 143    -- Locking Strategy --
 144    ----------------------
 145
 146    Single_Lock : constant Boolean := False;
 147    --  Indicates whether a single lock should be used within the tasking
 148    --  run-time to protect internal structures. If True, a single lock
 149    --  will be used, meaning less locking/unlocking operations, but also
 150    --  more global contention. In general, Single_Lock should be set to
 151    --  True on single processor machines, and to False to multi-processor
 152    --  systems, but this can vary from application to application and also
 153    --  depends on the scheduling policy.
 154
 155    -------------------
 156    -- Task Abortion --
 157    -------------------
 158
 159    No_Abort : constant Boolean := False;
 160    --  This constant indicates whether abort statements and asynchronous
 161    --  transfer of control (ATC) are disallowed. If set to True, it is
 162    --  assumed that neither construct is used, and the run time does not
 163    --  need to defer/undefer abort and check for pending actions at
 164    --  completion points. A value of True for No_Abort corresponds to:
 165    --  pragma Restrictions (No_Abort_Statements);
 166    --  pragma Restrictions (Max_Asynchronous_Select_Nesting => 0);
 167
 168    ----------------------
 169    -- Dynamic Priority --
 170    ----------------------
 171
 172    Dynamic_Priority_Support : constant Boolean := True;
 173    --  This constant indicates whether dynamic changes of task priorities
 174    --  are allowed (True means normal RM mode in which such changes are
 175    --  allowed). In particular, if this is False, then we do not need to
 176    --  poll for pending base priority changes at every abort completion
 177    --  point. A value of False for Dynamic_Priority_Support corresponds
 178    --  to pragma Restrictions (No_Dynamic_Priorities);
 179
 180    --------------------
 181    -- Runtime Traces --
 182    --------------------
 183
 184    Runtime_Traces : constant Boolean := False;
 185    --  This constant indicates whether the runtime outputs traces to a
 186    --  predefined output or not (True means that traces are output).
 187    --  See System.Traces for more details.
 188
 189 end System.Parameters;