| OLD | NEW |
| (Empty) |
| 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 PR_BEGIN_EXTERN_C | |
| 40 | |
| 41 typedef struct PLArenaPool PLArenaPool; | |
| 42 | |
| 43 /* | |
| 44 ** Allocate an arena pool as specified by the parameters. | |
| 45 ** | |
| 46 ** This is equivelant to allocating the space yourself and then | |
| 47 ** calling PL_InitArenaPool(). | |
| 48 ** | |
| 49 ** This function may fail (and return a NULL) for a variety of | |
| 50 ** reasons. The reason for a particular failure can be discovered | |
| 51 ** by calling PR_GetError(). | |
| 52 */ | |
| 53 #if 0 /* Not implemented */ | |
| 54 PR_EXTERN(PLArenaPool*) PL_AllocArenaPool( | |
| 55 const char *name, PRUint32 size, PRUint32 align); | |
| 56 #endif | |
| 57 | |
| 58 /* | |
| 59 ** Destroy an arena pool previously allocated by PL_AllocArenaPool(). | |
| 60 ** | |
| 61 ** This function may fail if the arena is not empty and the caller | |
| 62 ** wishes to check for empty upon descruction. | |
| 63 */ | |
| 64 #if 0 /* Not implemented */ | |
| 65 PR_EXTERN(PRStatus) PL_DestroyArenaPool(PLArenaPool *pool, PRBool checkEmpty); | |
| 66 #endif | |
| 67 | |
| 68 | |
| 69 /* | |
| 70 ** Initialize an arena pool with the given name for debugging and metering, | |
| 71 ** with a minimum size per arena of size bytes. | |
| 72 **/ | |
| 73 PR_EXTERN(void) PL_InitArenaPool( | |
| 74 PLArenaPool *pool, const char *name, PRUint32 size, PRUint32 align); | |
| 75 | |
| 76 /* | |
| 77 ** Finish using arenas, freeing all memory associated with them. | |
| 78 **/ | |
| 79 PR_EXTERN(void) PL_ArenaFinish(void); | |
| 80 | |
| 81 /* | |
| 82 ** Free the arenas in pool. The user may continue to allocate from pool | |
| 83 ** after calling this function. There is no need to call PL_InitArenaPool() | |
| 84 ** again unless PL_FinishArenaPool(pool) has been called. | |
| 85 **/ | |
| 86 PR_EXTERN(void) PL_FreeArenaPool(PLArenaPool *pool); | |
| 87 | |
| 88 /* | |
| 89 ** Free the arenas in pool and finish using it altogether. | |
| 90 **/ | |
| 91 PR_EXTERN(void) PL_FinishArenaPool(PLArenaPool *pool); | |
| 92 | |
| 93 /* | |
| 94 ** Compact all of the arenas in a pool so that no space is wasted. | |
| 95 **/ | |
| 96 PR_EXTERN(void) PL_CompactArenaPool(PLArenaPool *pool); | |
| 97 | |
| 98 /* | |
| 99 ** Friend functions used by the PL_ARENA_*() macros. | |
| 100 **/ | |
| 101 PR_EXTERN(void *) PL_ArenaAllocate(PLArenaPool *pool, PRUint32 nb); | |
| 102 | |
| 103 PR_EXTERN(void *) PL_ArenaGrow( | |
| 104 PLArenaPool *pool, void *p, PRUint32 size, PRUint32 incr); | |
| 105 | |
| 106 PR_EXTERN(void) PL_ArenaRelease(PLArenaPool *pool, char *mark); | |
| 107 | |
| 108 PR_END_EXTERN_C | |
| 109 | |
| 110 #endif /* defined(PLARENAS_H) */ | |
| 111 | |
| 112 /* plarenas */ | |
| OLD | NEW |