Security/libsecurity_asn1/lib/plarenas.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /*
   3  * The contents of this file are subject to the Mozilla Public
   4  * License Version 1.1 (the "License"); you may not use this file
   5  * except in compliance with the License. You may obtain a copy of
   6  * the License at http://www.mozilla.org/MPL/
   7  *
   8  * Software distributed under the License is distributed on an "AS
   9  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  10  * implied. See the License for the specific language governing
  11  * rights and limitations under the License.
  12  *
  13  * The Original Code is the Netscape Portable Runtime (NSPR).
  14  *
  15  * The Initial Developer of the Original Code is Netscape
  16  * Communications Corporation.  Portions created by Netscape are
  17  * Copyright (C) 1998-2000 Netscape Communications Corporation.  All
  18  * Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *
  22  * Alternatively, the contents of this file may be used under the
  23  * terms of the GNU General Public License Version 2 or later (the
  24  * "GPL"), in which case the provisions of the GPL are applicable
  25  * instead of those above.  If you wish to allow use of your
  26  * version of this file only under the terms of the GPL and not to
  27  * allow others to use your version of this file under the MPL,
  28  * indicate your decision by deleting the provisions above and
  29  * replace them with the notice and other provisions requiored by
  30  * the GPL.  If you do not delete the provisions above, a recipient
  31  * may use your version of this file under either the MPL or the
  32  * GPL.
  33  */
  34
  35 #if defined(PLARENAS_H)
  36 #else  /* defined(PLARENAS_H) */
  37 #define PLARENAS_H
  38
  39 #include <security_asn1/prtypes.h>
  40
  41 /* global enable/disable of mark/release mechanism */
  42 #define ARENA_MARK_ENABLE       0
  43
  44 PR_BEGIN_EXTERN_C
  45
  46 typedef struct PLArenaPool      PLArenaPool;
  47
  48 /*
  49 ** Allocate an arena pool as specified by the parameters.
  50 **
  51 ** This is equivelant to allocating the space yourself and then
  52 ** calling PL_InitArenaPool().
  53 **
  54 ** This function may fail (and return a NULL) for a variety of
  55 ** reasons. The reason for a particular failure can be discovered
  56 ** by calling PR_GetError().
  57 */
  58 #if 0  /* Not implemented */
  59 PR_EXTERN(PLArenaPool*) PL_AllocArenaPool(
  60     const char *name, PRUint32 size, PRUint32 align);
  61 #endif
  62
  63 /*
  64 ** Destroy an arena pool previously allocated by PL_AllocArenaPool().
  65 **
  66 ** This function may fail if the arena is not empty and the caller
  67 ** wishes to check for empty upon descruction.
  68 */
  69 #if 0  /* Not implemented */
  70 PR_EXTERN(PRStatus) PL_DestroyArenaPool(PLArenaPool *pool, PRBool checkEmpty);
  71 #endif
  72
  73
  74 /*
  75 ** Initialize an arena pool with the given name for debugging and metering,
  76 ** with a minimum size per arena of size bytes.
  77 **/
  78 PR_EXTERN(void) PL_InitArenaPool(
  79     PLArenaPool *pool, const char *name, PRUint32 size, PRUint32 align);
  80
  81 /*
  82 ** Finish using arenas, freeing all memory associated with them.
  83 **/
  84 PR_EXTERN(void) PL_ArenaFinish(void);
  85
  86 /*
  87 ** Free the arenas in pool.  The user may continue to allocate from pool
  88 ** after calling this function.  There is no need to call PL_InitArenaPool()
  89 ** again unless PL_FinishArenaPool(pool) has been called.
  90 **/
  91 PR_EXTERN(void) PL_FreeArenaPool(PLArenaPool *pool);
  92
  93 /*
  94 ** Free the arenas in pool and finish using it altogether.
  95 **/
  96 PR_EXTERN(void) PL_FinishArenaPool(PLArenaPool *pool);
  97
  98 /*
  99 ** Compact all of the arenas in a pool so that no space is wasted.
 100 ** NOT IMPLEMENTED.  Do not use.
 101 **/
 102 PR_EXTERN(void) PL_CompactArenaPool(PLArenaPool *pool);
 103
 104 /*
 105 ** Friend functions used by the PL_ARENA_*() macros.
 106 **
 107 ** WARNING: do not call these functions directly. Always use the
 108 ** PL_ARENA_*() macros.
 109 **/
 110 PR_EXTERN(void *) PL_ArenaAllocate(PLArenaPool *pool, PRUint32 nb);
 111
 112 PR_EXTERN(void *) PL_ArenaGrow(
 113     PLArenaPool *pool, void *p, PRUint32 size, PRUint32 incr);
 114
 115 PR_EXTERN(void) PL_ArenaRelease(PLArenaPool *pool, char *mark);
 116
 117 /*
 118  ** memset contents of all arenas in pool to pattern
 119  */
 120 PR_EXTERN(void) PL_ClearArenaPool(PLArenaPool *pool, PRInt32 pattern);
 121
 122 PR_END_EXTERN_C
 123
 124 #endif /* defined(PLARENAS_H) */
 125
 126 /* plarenas */