partial tests for kvp.c

[disorder] / lib / mem.c

diff --git a/lib/mem.c b/lib/mem.c
index 07c3495e2d656ea7df77a5325e97ae3b3e8edd9a..6d531ccaa3905d0ad7fa1849734084217116e82c 100644 (file)
--- a/lib/mem.c
+++ b/lib/mem.c
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004, 2005, 2006 Richard Kettlewell
+ * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,15 +17,21 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file lib/mem.c
+ * @brief Memory management
+ */
 
 #include <config.h>
 #include "types.h"
 
+#if GC
 #include <gc.h>
+#endif
 #include <errno.h>
 #include <string.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <assert.h>
 
 #include "mem.h"
 #include "log.h"
@@ -33,11 +39,10 @@
 
 #include "disorder.h"
 
-static void *(*do_malloc)(size_t) = GC_malloc;
-static void *(*do_realloc)(void *, size_t) = GC_realloc;
-static void *(*do_malloc_atomic)(size_t) = GC_malloc_atomic;
-static void (*do_free)(void *) = GC_free;
-
+/** @brief Allocate and zero out
+ * @param n Number of bytes to allocate
+ * @return Pointer to allocated memory,  or 0
+ */
 static void *malloc_and_zero(size_t n) {
   void *ptr = malloc(n);
 
@@ -45,18 +50,47 @@ static void *malloc_and_zero(size_t n) {
   return ptr;
 }
 
-void mem_init(int gc) {
+#if GC
+static void *(*do_malloc)(size_t) = GC_malloc;
+static void *(*do_realloc)(void *, size_t) = GC_realloc;
+static void *(*do_malloc_atomic)(size_t) = GC_malloc_atomic;
+static void (*do_free)(void *) = GC_free;
+#else
+static void *(*do_malloc)(size_t) = malloc_and_zero;
+static void *(*do_realloc)(void *, size_t) = realloc;
+static void *(*do_malloc_atomic)(size_t) = malloc;
+static void (*do_free)(void *) = free;
+#endif
+
+/** @brief Initialize memory management
+ *
+ * Must be called by all programs that use garbage collection.  Define
+ * @c ${DISORDER_GC} to @c no to suppress use of the collector
+ * (e.g. for debugging purposes).
+ */
+void mem_init(void) {
+#if GC
   const char *e;
   
-  if(!gc || ((e = getenv("DISORDER_GC")) && !strcmp(e, "no"))) {
+  if(((e = getenv("DISORDER_GC")) && !strcmp(e, "no"))) {
     do_malloc = malloc_and_zero;
     do_malloc_atomic = malloc;
     do_realloc = realloc;
     do_free = free;
-  } else
+  } else {
     GC_init();
+    assert(GC_all_interior_pointers);
+  }
+#endif
 }
 
+/** @brief Allocate memory
+ * @param n Bytes to allocate
+ * @return Pointer to allocated memory
+ *
+ * Terminates the process on error.  The allocated memory is always
+ * 0-filled.
+ */
 void *xmalloc(size_t n) {
   void *ptr;
 
@@ -65,18 +99,42 @@ void *xmalloc(size_t n) {
   return ptr;
 }
 
+/** @brief Reallocate memory
+ * @param ptr Block to reallocated
+ * @param n Bytes to allocate
+ * @return Pointer to allocated memory
+ *
+ * Terminates the process on error.  It is NOT guaranteed that any
+ * additional memory allocated is 0-filled.
+ */
 void *xrealloc(void *ptr, size_t n) {
   if(!(ptr = do_realloc(ptr, n)) && n)
     fatal(errno, "error allocating memory");
   return ptr;
 }
 
+/** @brief Allocate memory
+ * @param count Number of objects to allocate
+ * @param size Size of one object
+ * @return Pointer to allocated memory
+ *
+ * Terminates the process on error.  The allocated memory is always
+ * 0-filled.
+ */
 void *xcalloc(size_t count, size_t size) {
   if(count > SIZE_MAX / size)
     fatal(0, "excessively large calloc");
   return xmalloc(count * size);
 }
 
+/** @brief Allocate memory
+ * @param n Bytes to allocate
+ * @return Pointer to allocated memory
+ *
+ * Terminates the process on error.  The allocated memory is not
+ * guaranteed to be 0-filled and is not suitable for storing pointers
+ * in.
+ */
 void *xmalloc_noptr(size_t n) {
   void *ptr;
 
@@ -85,6 +143,15 @@ void *xmalloc_noptr(size_t n) {
   return ptr;
 }
 
+/** @brief Reallocate memory
+ * @param ptr Block to reallocated
+ * @param n Bytes to allocate
+ * @return Pointer to allocated memory
+ *
+ * Terminates the processf on error.  It is NOT guaranteed that any
+ * additional memory allocated is 0-filled.  The block must have been
+ * allocated with xmalloc_noptr() (or xrealloc_noptr()) initially.
+ */
 void *xrealloc_noptr(void *ptr, size_t n) {
   if(ptr == 0)
     return xmalloc_noptr(n);
@@ -93,6 +160,12 @@ void *xrealloc_noptr(void *ptr, size_t n) {
   return ptr;
 }
 
+/** @brief Duplicate a string
+ * @param s String to copy
+ * @return New copy of string
+ *
+ * This uses the equivalent of xmalloc_noptr() to allocate the new string.
+ */
 char *xstrdup(const char *s) {
   char *t;
 
@@ -101,6 +174,14 @@ char *xstrdup(const char *s) {
   return strcpy(t, s);
 }
 
+/** @brief Duplicate a prefix of a string
+ * @param s String to copy
+ * @param n Prefix of string to copy
+ * @return New copy of string
+ *
+ * This uses the equivalent of xmalloc_noptr() to allocate the new string.
+ * @p n must not exceed the length of the string.
+ */
 char *xstrndup(const char *s, size_t n) {
   char *t;
 
@@ -111,6 +192,9 @@ char *xstrndup(const char *s, size_t n) {
   return t;
 }
 
+/** @brief Free memory
+ * @param ptr Block to free or 0
+ */
 void xfree(void *ptr) {
   do_free(ptr);
 }
@@ -121,4 +205,3 @@ c-basic-offset:2
 comment-column:40
 End:
 */
-/* arch-tag:fceaf81fe79b2f4f87c9541774a2b8f2 */