/* -*-c-*-
*
- * $Id: lmem.h,v 1.1 1999/12/22 16:02:52 mdw Exp $
+ * $Id: lmem.h,v 1.5 2004/04/08 01:36:15 mdw Exp $
*
* Locked memory allocation
*
* (c) 1999 Straylight/Edgeware
*/
-/*----- Licensing notice --------------------------------------------------*
+/*----- Licensing notice --------------------------------------------------*
*
* This file is part of Catacomb.
*
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
- *
+ *
* Catacomb is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
- *
+ *
* You should have received a copy of the GNU Library General Public
* License along with Catacomb; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
* MA 02111-1307, USA.
*/
-/*----- Revision history --------------------------------------------------*
- *
- * $Log: lmem.h,v $
- * Revision 1.1 1999/12/22 16:02:52 mdw
- * Interface to allocating `locked' memory (which isn't paged out).
- *
- */
-
#ifndef CATACOMB_LMEM_H
#define CATACOMB_LMEM_H
#include <stddef.h>
+#include <mLib/arena.h>
#include <mLib/dstr.h>
/*----- Data structures ---------------------------------------------------*/
unsigned f; /* Various flags */
} l_node;
-enum {
- LF_ALLOC = 1
-};
+#define LF_ALLOC 1u
/* --- Locked memory buffer state --- */
typedef struct lmem {
+ arena a; /* Arena header block */
+ unsigned f; /* Various flags */
char *p; /* Pointer to locked buffer */
l_node *l; /* Pointer to block list */
size_t sz; /* Size of locked buffer */
int err; char *emsg; /* Error indicators */
} lmem;
+#define LF_LOCKED 1u
+
/*----- Functions provided ------------------------------------------------*/
/* --- @l_init@ --- *
extern void l_purge(lmem */*lm*/);
+/* --- @l_destroy@ --- *
+ *
+ * Arguments: @lmem *lm@ = pointer to locked memory descriptor
+ *
+ * Returns: ---
+ *
+ * Use: Disposes of a locked memory arena permanently.
+ */
+
+extern void l_destroy(lmem */*lm*/);
+
/* --- @l_report@ --- *
*
* Arguments: @lmem *lm@ = pointer to locked memory descriptor