3 * $Id: mparena.h,v 1.3 2000/06/17 11:35:48 mdw Exp $
5 * Allocation and freeing of MP buffers
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.3 2000/06/17 11:35:48 mdw
34 * Overhaul to use mLib's arena system underneath.
36 * Revision 1.2 1999/12/10 23:28:59 mdw
37 * Memory allocation counting.
39 * Revision 1.1 1999/11/17 18:02:16 mdw
40 * New multiprecision integer arithmetic suite.
44 #ifndef CATACOMB_MPARENA_H
45 #define CATACOMB_MPARENA_H
51 /*----- Header files ------------------------------------------------------*/
53 #include <mLib/arena.h>
55 #ifndef CATACOMB_MPW_H
59 /*----- Data structures ---------------------------------------------------*/
61 /* --- @mparena_node@ --- *
63 * For internal use by the MP arena manager. The free blocks are held in a
64 * binary tree by size, held in the first digit of each vector.
67 typedef struct mparena_node
{
68 struct mparena_node
*left
, *right
;
72 /* --- @mparena@ --- *
77 typedef struct mparena
{
83 /*----- Standard arenas ---------------------------------------------------*/
85 extern mparena mparena_global
;
86 #define MPARENA_GLOBAL (&mparena_global)
88 extern mparena mparena_secure
;
89 #define MPARENA_SECURE (&mparena_secure)
91 /*----- Functions provided ------------------------------------------------*/
93 /* --- @mparena_create@ --- *
95 * Arguments: @mparena *a@ = pointer to arena block
99 * Use: Initializes an MP arena so that blocks can be allocated from
103 extern void mparena_create(mparena */
*a*/
);
105 #define MPARENA_INIT { 0, 0, &arena_stdlib }
107 /* --- @mparena_setarena@ --- *
109 * Arguments: @mparena *a@ = pointer to MP arena block
110 * @arena *aa@ = pointer to arena
114 * Use: Sets the underlying arena for an MP arena.
117 extern void mparena_setarena(mparena */
*a*/
, arena */
*aa*/
);
119 /* --- @mparena_destroy@ --- *
121 * Arguments: @mparena *a@ = pointer to arena block
125 * Use: Frees an MP arena, and all the vectors held within it. The
126 * blocks which are currently allocated can be freed into some
127 * other MP arena, as long as the underlying arenas are the
131 extern void mparena_destroy(mparena */
*a*/
);
133 /* --- @mparena_count@ --- *
135 * Arguments: @mparena *a@ = pointer to arena block
137 * Returns: Number of allocated blocks from this arena.
139 * Use: Reports the number of blocks allocated from the arena and not
143 extern unsigned mparena_count(mparena */
*a*/
);
145 /* --- @mpalloc@ --- *
147 * Arguments: @mparena *a@ = pointer to arena block
148 * @size_t sz@ = number of digits required
150 * Returns: Pointer to a suitably sized block.
152 * Use: Allocates a lump of data suitable for use as an array of MP
156 extern mpw
*mpalloc(mparena */
*a*/
, size_t /*sz*/);
158 /* --- @mpfree@ --- *
160 * Arguments: @mparena *a@ = pointer to arena block
161 * @mpw *v@ = pointer to allocated vector
165 * Use: Returns an MP vector to an arena.
168 extern void mpfree(mparena */
*a*/
, mpw */
*v*/
);
170 /*----- That's all, folks -------------------------------------------------*/