OSDN Git Service

Patch to fix -mcpu=G5 interface to EH runtime library.
[pf3gnuchains/gcc-fork.git] / gcc / ada / s-secsta.ads
index cdc6db1..ad2b34e 100644 (file)
@@ -6,9 +6,7 @@
 --                                                                          --
 --                                 S p e c                                  --
 --                                                                          --
---                            $Revision: 1.1 $
---                                                                          --
---          Copyright (C) 1992-1999 Free Software Foundation, Inc.          --
+--          Copyright (C) 1992-2004 Free Software Foundation, Inc.          --
 --                                                                          --
 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
 -- terms of the  GNU General Public License as published  by the Free Soft- --
@@ -29,7 +27,7 @@
 -- covered by the  GNU Public License.                                      --
 --                                                                          --
 -- GNAT was originally developed  by the GNAT team at  New York University. --
--- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
+-- Extensive contributions were provided by Ada Core Technologies Inc.      --
 --                                                                          --
 ------------------------------------------------------------------------------
 
@@ -39,22 +37,22 @@ package System.Secondary_Stack is
 
    package SSE renames System.Storage_Elements;
 
-   Default_Secondary_Stack_Size : constant := 10 * 1024;
-   --  Default size of a secondary stack
+   Default_Secondary_Stack_Size : Natural := 10 * 1024;
+   --  Default size of a secondary stack. May be modified by binder -D switch
 
    procedure SS_Init
-     (Stk : in out System.Address;
+     (Stk  : in out Address;
       Size : Natural := Default_Secondary_Stack_Size);
    --  Initialize the secondary stack with a main stack of the given Size.
    --
    --  If System.Parameters.Sec_Stack_Ratio equals Dynamic, Stk is really an
-   --  "out" parameter that will be allocated on the heap. Then all further
+   --  OUT parameter that will be allocated on the heap. Then all further
    --  allocations which do not overflow the main stack will not generate
    --  dynamic (de)allocation calls. If the main Stack overflows, a new
    --  chuck of at least the same size will be allocated and linked to the
    --  previous chunk.
    --
-   --  Otherwise (Sec_Stack_Ratio between 0 and 100), Stk is an "in" parameter
+   --  Otherwise (Sec_Stack_Ratio between 0 and 100), Stk is an IN parameter
    --  that is already pointing to a Stack_Id. The secondary stack in this case
    --  is fixed, and any attempt to allocated more than the initial size will
    --  result in a Storage_Error being raised.
@@ -64,18 +62,18 @@ package System.Secondary_Stack is
    --  stack using System.Soft_Links.Get_Sec_Stack_Addr.
 
    procedure SS_Allocate
-     (Address      : out System.Address;
+     (Addr         : out Address;
       Storage_Size : SSE.Storage_Count);
    --  Allocate enough space for a 'Storage_Size' bytes object with Maximum
-   --  alignment. The address of the allocated space is returned in 'Address'
+   --  alignment. The address of the allocated space is returned in Addr.
 
-   procedure SS_Free (Stk : in out System.Address);
-   --  Release the memory allocated for the Secondary Stack. That is to say,
-   --  all the allocated chuncks.
-   --  Upon return, Stk will be set to System.Null_Address
+   procedure SS_Free (Stk : in out Address);
+   --  Release the memory allocated for the Secondary Stack. That is
+   --  to say, all the allocated chunks. Upon return, Stk will be set
+   --  to System.Null_Address.
 
    type Mark_Id is private;
-   --  Type used to mark the stack.
+   --  Type used to mark the stack for mark/release processing
 
    function SS_Mark return Mark_Id;
    --  Return the Mark corresponding to the current state of the stack
@@ -84,19 +82,35 @@ package System.Secondary_Stack is
    --  Restore the state of the stack corresponding to the mark M. If an
    --  additional chunk have been allocated, it will never be freed during a
 
+   function SS_Get_Max return Long_Long_Integer;
+   --  Return maximum used space in storage units for the current secondary
+   --  stack. For a dynamically allocated secondary stack, the returned
+   --  result is always -1. For a statically allocated secondary stack,
+   --  the returned value shows the largest amount of space allocated so
+   --  far during execution of the program to the current secondary stack,
+   --  i.e. the secondary stack for the current task.
+
    generic
       with procedure Put_Line (S : String);
    procedure SS_Info;
    --  Debugging procedure used to print out secondary Stack allocation
    --  information. This procedure is generic in order to avoid a direct
-   --  dependence on a particular IO package.
+   --  dependance on a particular IO package.
 
 private
-
    SS_Pool : Integer;
    --  Unused entity that is just present to ease the sharing of the pool
    --  mechanism for specific allocation/deallocation in the compiler
 
-   type Mark_Id is new SSE.Integer_Address;
+   type SS_Ptr is new SSE.Integer_Address;
+   --  Stack pointer value for secondary stack
+
+   type Mark_Id is record
+      Sstk : System.Address;
+      Sptr : SS_Ptr;
+   end record;
+   --  A mark value contains the address of the secondary stack structure,
+   --  as returned by System.Soft_Links.Get_Sec_Stack_Addr, and a stack
+   --  pointer value corresponding to the point of the mark call.
 
 end System.Secondary_Stack;