git.distorted.org.uk Git - u/mdw/catacomb/blob - base/arena.h

   1 /* -*-c-*-
   2  *
   3  * Abstraction for memory allocation arenas
   4  *
   5  * (c) 2000 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of Catacomb.
  11  *
  12  * Catacomb 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  * Catacomb 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 Catacomb; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 #ifndef CATACOMB_ARENA_H
  29 #define CATACOMB_ARENA_H
  30
  31 #ifdef __cplusplus
  32   extern "C" {
  33 #endif
  34
  35 /*----- Header files ------------------------------------------------------*/
  36
  37 #include <mLib/arena.h>
  38 #include <mLib/sub.h>
  39
  40 /*----- Global variables --------------------------------------------------*/
  41
  42 extern arena *arena_secure;
  43 extern subarena *arena_subsecure;
  44
  45 /*----- Handy macros ------------------------------------------------------*/
  46
  47 #define S_ALLOC(sz) A_ALLOC(arena_secure, sz)
  48 #define S_FREE(sz) A_FREE(arena_secure, sz)
  49
  50 #define XS_ALLOC(sz) x_alloc(arena_secure, sz)
  51 #define XS_REALLOC(p, sz) x_realloc(arena_secure, p, sz)
  52 #define XS_FREE(p) x_free(arena_secure, p)
  53
  54 #define S_CREATE(type) A_CREATE(arena_subsecure, type)
  55 #define S_DESTROY(p) A_DESTROY(arena_subsecure, p)
  56
  57 /*----- Functions provided ------------------------------------------------*/
  58
  59 /* --- @arena_setsecure@ --- *
  60  *
  61  * Arguments:   @arena *a@ = arena to use for secure allocation
  62  *
  63  * Returns:     ---
  64  *
  65  * Use:         Call at the beginning of the program to set the arena for
  66  *              secure allocations.
  67  */
  68
  69 extern void arena_setsecure(arena */*a*/);
  70
  71 /*----- That's all, folks -------------------------------------------------*/
  72
  73 #ifdef __cplusplus
  74   }
  75 #endif
  76
  77 #endif