mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 04:27:37 +00:00
97 lines
2.8 KiB
C
97 lines
2.8 KiB
C
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.1 (the "NPL"); you may not use this file except in
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
* for the specific language governing rights and limitations under the
|
|
* NPL.
|
|
*
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
* Reserved.
|
|
*/
|
|
|
|
#if defined(PLARENAS_H)
|
|
#else /* defined(PLARENAS_H) */
|
|
#define PLARENAS_H
|
|
|
|
PR_BEGIN_EXTERN_C
|
|
|
|
typedef struct PLArenaPool PLArenaPool;
|
|
|
|
/*
|
|
** Allocate an arena pool as specified by the parameters.
|
|
**
|
|
** This is equivelant to allocating the space yourself and then
|
|
** calling PL_InitArenaPool().
|
|
**
|
|
** This function may fail (and return a NULL) for a variety of
|
|
** reasons. The reason for a particular failure can be discovered
|
|
** by calling PR_GetError().
|
|
*/
|
|
#if 0 /* Not implemented */
|
|
PR_EXTERN(PLArenaPool*) PL_AllocArenaPool(
|
|
const char *name, PRUint32 size, PRUint32 align);
|
|
#endif
|
|
|
|
/*
|
|
** Destroy an arena pool previously allocated by PL_AllocArenaPool().
|
|
**
|
|
** This function may fail if the arena is not empty and the caller
|
|
** wishes to check for empty upon descruction.
|
|
*/
|
|
#if 0 /* Not implemented */
|
|
PR_EXTERN(PRStatus) PL_DestroyArenaPool(PLArenaPool *pool, PRBool checkEmpty);
|
|
#endif
|
|
|
|
|
|
/*
|
|
** Initialize an arena pool with the given name for debugging and metering,
|
|
** with a minimum size per arena of size bytes.
|
|
**/
|
|
PR_EXTERN(void) PL_InitArenaPool(
|
|
PLArenaPool *pool, const char *name, PRUint32 size, PRUint32 align);
|
|
|
|
/*
|
|
** Finish using arenas, freeing all memory associated with them.
|
|
**/
|
|
PR_EXTERN(void) PL_ArenaFinish(void);
|
|
|
|
/*
|
|
** Free the arenas in pool. The user may continue to allocate from pool
|
|
** after calling this function. There is no need to call PL_InitArenaPool()
|
|
** again unless PL_FinishArenaPool(pool) has been called.
|
|
**/
|
|
PR_EXTERN(void) PL_FreeArenaPool(PLArenaPool *pool);
|
|
|
|
/*
|
|
** Free the arenas in pool and finish using it altogether.
|
|
**/
|
|
PR_EXTERN(void) PL_FinishArenaPool(PLArenaPool *pool);
|
|
|
|
/*
|
|
** Compact all of the arenas in a pool so that no space is wasted.
|
|
**/
|
|
PR_EXTERN(void) PL_CompactArenaPool(PLArenaPool *pool);
|
|
|
|
/*
|
|
** Friend functions used by the PL_ARENA_*() macros.
|
|
**/
|
|
PR_EXTERN(void *) PL_ArenaAllocate(PLArenaPool *pool, PRUint32 nb);
|
|
|
|
PR_EXTERN(void *) PL_ArenaGrow(
|
|
PLArenaPool *pool, void *p, PRUint32 size, PRUint32 incr);
|
|
|
|
PR_EXTERN(void) PL_ArenaRelease(PLArenaPool *pool, char *mark);
|
|
|
|
PR_END_EXTERN_C
|
|
|
|
#endif /* defined(PLARENAS_H) */
|
|
|
|
/* plarenas */
|