Back to index

lightning-sunbird  0.9+nobinonly
plarenas.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #if defined(PLARENAS_H)
00039 #else  /* defined(PLARENAS_H) */
00040 #define PLARENAS_H
00041 
00042 PR_BEGIN_EXTERN_C
00043 
00044 typedef struct PLArenaPool      PLArenaPool;
00045 
00046 /*
00047 ** Allocate an arena pool as specified by the parameters.
00048 **
00049 ** This is equivelant to allocating the space yourself and then
00050 ** calling PL_InitArenaPool().
00051 **
00052 ** This function may fail (and return a NULL) for a variety of
00053 ** reasons. The reason for a particular failure can be discovered
00054 ** by calling PR_GetError().
00055 */
00056 #if 0  /* Not implemented */
00057 PR_EXTERN(PLArenaPool*) PL_AllocArenaPool(
00058     const char *name, PRUint32 size, PRUint32 align);
00059 #endif
00060 
00061 /*
00062 ** Destroy an arena pool previously allocated by PL_AllocArenaPool().
00063 **
00064 ** This function may fail if the arena is not empty and the caller
00065 ** wishes to check for empty upon descruction.
00066 */
00067 #if 0  /* Not implemented */
00068 PR_EXTERN(PRStatus) PL_DestroyArenaPool(PLArenaPool *pool, PRBool checkEmpty);
00069 #endif
00070 
00071 
00072 /*
00073 ** Initialize an arena pool with the given name for debugging and metering,
00074 ** with a minimum size per arena of size bytes.
00075 **/
00076 PR_EXTERN(void) PL_InitArenaPool(
00077     PLArenaPool *pool, const char *name, PRUint32 size, PRUint32 align);
00078 
00079 /*
00080 ** Finish using arenas, freeing all memory associated with them.
00081 **/
00082 PR_EXTERN(void) PL_ArenaFinish(void);
00083 
00084 /*
00085 ** Free the arenas in pool.  The user may continue to allocate from pool
00086 ** after calling this function.  There is no need to call PL_InitArenaPool()
00087 ** again unless PL_FinishArenaPool(pool) has been called.
00088 **/
00089 PR_EXTERN(void) PL_FreeArenaPool(PLArenaPool *pool);
00090 
00091 /*
00092 ** Free the arenas in pool and finish using it altogether.
00093 **/
00094 PR_EXTERN(void) PL_FinishArenaPool(PLArenaPool *pool);
00095 
00096 /*
00097 ** Compact all of the arenas in a pool so that no space is wasted.
00098 **/
00099 PR_EXTERN(void) PL_CompactArenaPool(PLArenaPool *pool);
00100 
00101 /*
00102 ** Friend functions used by the PL_ARENA_*() macros.
00103 **/
00104 PR_EXTERN(void *) PL_ArenaAllocate(PLArenaPool *pool, PRUint32 nb);
00105 
00106 PR_EXTERN(void *) PL_ArenaGrow(
00107     PLArenaPool *pool, void *p, PRUint32 size, PRUint32 incr);
00108 
00109 PR_EXTERN(void) PL_ArenaRelease(PLArenaPool *pool, char *mark);
00110 
00111 PR_END_EXTERN_C
00112 
00113 #endif /* defined(PLARENAS_H) */
00114 
00115 /* plarenas */