gcc/ada/s-pooloc.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                    S Y S T E M . P O O L _ L O C A L                     --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2009, 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.                                     --
  17 --                                                                          --
  18 -- As a special exception under Section 7 of GPL version 3, you are granted --
  19 -- additional permissions described in the GCC Runtime Library Exception,   --
  20 -- version 3.1, as published by the Free Software Foundation.               --
  21 --                                                                          --
  22 -- You should have received a copy of the GNU General Public License and    --
  23 -- a copy of the GCC Runtime Library Exception along with this program;     --
  24 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  25 -- <http://www.gnu.org/licenses/>.                                          --
  26 --                                                                          --
  27 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31
  32 --  Storage pool for use with local objects with automatic reclaim
  33
  34 with System.Storage_Elements;
  35 with System.Pool_Global;
  36
  37 package System.Pool_Local is
  38    pragma Elaborate_Body;
  39    --  Needed to ensure that library routines can execute allocators
  40
  41    ----------------------------
  42    -- Unbounded_Reclaim_Pool --
  43    ----------------------------
  44
  45    --  Allocation strategy:
  46
  47    --    Call to malloc/free for each Allocate/Deallocate
  48    --    no user specifiable size
  49    --    Space of allocated objects is reclaimed at pool finalization
  50    --    Manages a list of allocated objects
  51
  52    type Unbounded_Reclaim_Pool is new
  53      System.Pool_Global.Unbounded_No_Reclaim_Pool with
  54        record
  55           First : System.Address := Null_Address;
  56        end record;
  57
  58    --  function Storage_Size is inherited
  59
  60    procedure Allocate
  61      (Pool         : in out Unbounded_Reclaim_Pool;
  62       Address      : out System.Address;
  63       Storage_Size : System.Storage_Elements.Storage_Count;
  64       Alignment    : System.Storage_Elements.Storage_Count);
  65
  66    procedure Deallocate
  67      (Pool         : in out Unbounded_Reclaim_Pool;
  68       Address      : System.Address;
  69       Storage_Size : System.Storage_Elements.Storage_Count;
  70       Alignment    : System.Storage_Elements.Storage_Count);
  71
  72    procedure Finalize (Pool : in out Unbounded_Reclaim_Pool);
  73
  74 end System.Pool_Local;