home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / adav313.zip / gnat-3_13p-os2-bin-20010916.zip / emx / gnatlib / s-secsta.ads < prev    next >
Text File  |  2000-07-19  |  5KB  |  103 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT COMPILER COMPONENTS                         --
  4. --                                                                          --
  5. --               S Y S T E M . S E C O N D A R Y _ S T A C K                --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.21 $
  10. --                                                                          --
  11. --          Copyright (C) 1992-1999 Free Software Foundation, Inc.          --
  12. --                                                                          --
  13. -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14. -- terms of the  GNU General Public License as published  by the Free Soft- --
  15. -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16. -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17. -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18. -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19. -- for  more details.  You should have  received  a copy of the GNU General --
  20. -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21. -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22. -- MA 02111-1307, USA.                                                      --
  23. --                                                                          --
  24. -- As a special exception,  if other files  instantiate  generics from this --
  25. -- unit, or you link  this unit with other files  to produce an executable, --
  26. -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27. -- covered  by the  GNU  General  Public  License.  This exception does not --
  28. -- however invalidate  any other reasons why  the executable file  might be --
  29. -- covered by the  GNU Public License.                                      --
  30. --                                                                          --
  31. -- GNAT was originally developed  by the GNAT team at  New York University. --
  32. -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  33. --                                                                          --
  34. ------------------------------------------------------------------------------
  35.  
  36. with System.Storage_Elements;
  37.  
  38. package System.Secondary_Stack is
  39.  
  40.    package SSE renames System.Storage_Elements;
  41.  
  42.    Default_Secondary_Stack_Size : constant := 10 * 1024;
  43.    --  Default size of a secondary stack
  44.  
  45.    procedure SS_Init
  46.      (Stk : in out System.Address;
  47.       Size : Natural := Default_Secondary_Stack_Size);
  48.    --  Initialize the secondary stack with a main stack of the given Size.
  49.    --
  50.    --  If System.Parameters.Sec_Stack_Ratio equals Dynamic, Stk is really an
  51.    --  "out" parameter that will be allocated on the heap. Then all further
  52.    --  allocations which do not overflow the main stack will not generate
  53.    --  dynamic (de)allocation calls. If the main Stack overflows, a new
  54.    --  chuck of at least the same size will be allocated and linked to the
  55.    --  previous chunk.
  56.    --
  57.    --  Otherwise (Sec_Stack_Ratio between 0 and 100), Stk is an "in" parameter
  58.    --  that is already pointing to a Stack_Id. The secondary stack in this case
  59.    --  is fixed, and any attempt to allocated more than the initial size will
  60.    --  result in a Storage_Error being raised.
  61.    --
  62.    --  Note: the reason that Stk is passed is that SS_Init is called before
  63.    --  the proper interface is established to obtain the address of the
  64.    --  stack using System.Soft_Links.Get_Sec_Stack_Addr.
  65.  
  66.    procedure SS_Allocate
  67.      (Address      : out System.Address;
  68.       Storage_Size : SSE.Storage_Count);
  69.    --  Allocate enough space for a 'Storage_Size' bytes object with Maximum
  70.    --  alignment. The address of the allocated space is returned in 'Address'
  71.  
  72.    procedure SS_Free (Stk : in out System.Address);
  73.    --  Release the memory allocated for the Secondary Stack. That is to say,
  74.    --  all the allocated chuncks.
  75.    --  Upon return, Stk will be set to System.Null_Address
  76.  
  77.    type Mark_Id is private;
  78.    --  Type used to mark the stack.
  79.  
  80.    function SS_Mark return Mark_Id;
  81.    --  Return the Mark corresponding to the current state of the stack
  82.  
  83.    procedure SS_Release (M : Mark_Id);
  84.    --  Restore the state of the stack corresponding to the mark M. If an
  85.    --  additional chunk have been allocated, it will never be freed during a
  86.  
  87.    generic
  88.       with procedure Put_Line (S : String);
  89.    procedure SS_Info;
  90.    --  Debugging procedure used to print out secondary Stack allocation
  91.    --  information. This procedure is generic in order to avoid a direct
  92.    --  dependance on a particular IO package.
  93.  
  94. private
  95.  
  96.    SS_Pool : Integer;
  97.    --  Unused entity that is just present to ease the sharing of the pool
  98.    --  mechanism for specific allocation/deallocation in the compiler
  99.  
  100.    type Mark_Id is new SSE.Integer_Address;
  101.  
  102. end System.Secondary_Stack;
  103.