nsprpub/lib/ds/plarenas.h

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