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

   1 /* -*-c-*-
   2  *
   3  * $Id: arena.h,v 1.1 2000/06/17 10:40:10 mdw Exp $
   4  *
   5  * Abstraction for memory allocation arenas
   6  *
   7  * (c) 2000 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Catacomb.
  13  *
  14  * Catacomb is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * Catacomb is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with Catacomb; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: arena.h,v $
  33  * Revision 1.1  2000/06/17 10:40:10  mdw
  34  * Support for secure memory arenas.
  35  *
  36  */
  37
  38 #ifndef CATACOMB_ARENA_H
  39 #define CATACOMB_ARENA_H
  40
  41 #ifdef __cplusplus
  42   extern "C" {
  43 #endif
  44
  45 /*----- Header files ------------------------------------------------------*/
  46
  47 #include <mLib/arena.h>
  48 #include <mLib/sub.h>
  49
  50 /*----- Global variables --------------------------------------------------*/
  51
  52 extern arena *arena_secure;
  53 extern subarena *arena_subsecure;
  54
  55 /*----- Handy macros ------------------------------------------------------*/
  56
  57 #define S_ALLOC(sz) A_ALLOC(arena_secure, sz)
  58 #define S_FREE(sz) A_FREE(arena_secure, sz)
  59
  60 #define XS_ALLOC(sz) x_alloc(arena_secure, sz)
  61 #define XS_REALLOC(p, sz) x_realloc(arena_secure, p, sz)
  62 #define XS_FREE(p) x_free(arena_secure, p)
  63
  64 #define S_CREATE(type) A_CREATE(arena_subsecure, type)
  65 #define S_DESTROY(p) A_DESTROY(arena_subsecure, p)
  66
  67 /*----- Functions provided ------------------------------------------------*/
  68
  69 /* --- @arena_setsecure@ --- *
  70  *
  71  * Arguments:   @arena *a@ = arena to use for secure allocation
  72  *
  73  * Returns:     ---
  74  *
  75  * Use:         Call at the beginning of the program to set the arena for
  76  *              secure allocations.
  77  */
  78
  79 extern void arena_setsecure(arena */*a*/);
  80
  81 /*----- That's all, folks -------------------------------------------------*/
  82
  83 #ifdef __cplusplus
  84   }
  85 #endif
  86
  87 #endif