chiark - git - mdw - mLib/blob - mem/pool-sub.c

   1 /* -*-c-*-
   2  *
   3  * Subarenas in resource pools
   4  *
   5  * (c) 2000 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU Library General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 /*----- Header files ------------------------------------------------------*/
  29
  30 #include "pool.h"
  31 #include "sub.h"
  32
  33 /*----- Main code ---------------------------------------------------------*/
  34
  35 /* --- @pool_subarena@ --- *
  36  *
  37  * Arguments:   @pool *p@ = pointer to the pool
  38  *
  39  * Returns:     A subarena built from the pool's memory allocator.
  40  *
  41  * Use:         Creates a suballocation arena attached to a pool.  The arena
  42  *              and all of its memory will be freed when the pool is
  43  *              destroyed.
  44  */
  45
  46 subarena *pool_subarena(pool *p)
  47 {
  48   subarena *sa = pool_alloc(p, sizeof(subarena));
  49   subarena_create(sa, &p->a);
  50   return (sa);
  51 }
  52
  53 /*----- That's all, folks -------------------------------------------------*/