- Add protection for calling from c++

- Add more detailed doxygen docs
- Add new function : lam_malloc_debug() to set malloc debug level at run-time
- Use LAM output streams to display messages
- Add lam_malloc_init and finalize for setting up and tearing down
  output message streams (called during lam_init() and lam_finalize())

This commit was SVN r514.

src/lam/mem/malloc.c

@@ -0,0 +1,71 @@
+/*
+ * $HEADER$
+ */
+
+#include "lam_config.h"
+
+#include "lam/mem/malloc.h"
+#include "lam/util/output.h"
+
+
+/*
+ * Public variables
+ */
+int lam_malloc_debug_level = LAM_MALLOC_DEBUG_LEVEL;
+int lam_malloc_output = -1;
+
+
+/*
+ * Private variables
+ */
+static lam_output_stream_t malloc_stream = {
+  /* debugging */
+  true,
+  /* verbose level */
+  5, 
+  /* syslog */
+  false, 0, NULL,
+  /* prefix */
+  "malloc_debug: ",
+  /* stdout */
+  false,
+  /* stderr */
+  true,
+  /* file */
+  false, false, NULL
+};
+
+/**
+ * Initialize malloc debug output.
+ *
+ * This function is invoked to setup a dedicated output stream for
+ * malloc debug functions.  It does \em not (currently) do anything
+ * other than that (i.e., no internal accounting for tracking
+ * malloc/free statements, etc.).
+ *
+ * It is invoked as part of lam_init().  Although this function is not
+ * \em necessary for LAM_MALLOC() and LAM_FREE(), it is strong
+ * recommended because no output messages -- regardless of the malloc
+ * debug level set by lam_malloc_debug() -- will be displayed unless
+ * this function is invoked first.
+ */
+void lam_malloc_init(void)
+{
+  lam_malloc_output = lam_output_open(&malloc_stream);
+}
+
+
+/**
+ * Shut down malloc debug output.
+ *
+ * This function is invoked as part of lam_finalize() to shut down the
+ * output stream for malloc debug messages.
+ */
+void lam_malloc_finalize(void)
+{
+  if (-1 != lam_malloc_output) {
+    lam_output_close(lam_malloc_output);
+    lam_malloc_output = -1;
+  }
+}
+

src/lam/mem/malloc.h

@@ -7,9 +7,13 @@
 #ifndef LAM_MALLOC_H
 #define LAM_MALLOC_H
 
-#include <stdlib.h>
 #include "lam_config.h"
 
+#include <stdlib.h>
+
+#include "lam/util/output.h"
+
+
 /*
  * Set LAM_MALLOC_DEBUG_LEVEL to
  * 0 for no checking
@@ -21,42 +25,60 @@
 #define LAM_MALLOC_DEBUG_LEVEL 2
 #endif
 
-static inline void *lam_malloc(size_t size, int debug_level, char *file, 
+#if defined(c_plusplus) || defined(__cplusplus)
-                               int line);
+extern "C" {
-static inline void lam_free(void *addr, int debug_level, char *file, int line);
+#endif
+  void lam_malloc_init(void);
+  void lam_malloc_finalize(void);
+#if defined(c_plusplus) || defined(__cplusplus)
+}
+#endif
+
+extern int lam_malloc_debug_level;
+extern int lam_malloc_output;
+
+static inline void lam_malloc_debug(int level);
+static inline void *lam_malloc(size_t size, char *file, int line);
+static inline void lam_free(void *addr, char *file, int line);
+
 
 /**
+ * Used to set the debug level for malloc debug.
+ *
+ * @param level The level of debugging (0 = none, 1 = some, 2 = more)
+ *
+ * This value defaults to the LAM_MALLOC_DEBUG_LEVEL.
+ */
+static inline void lam_malloc_debug(int level)
+{
+  lam_malloc_debug_level = level;
+}
+
+/**
+ * \internal
+ *
  * Back-end error-checking malloc function for LAM (you should use the
  * LAM_MALLOC() macro instead of this function).
  *
  * @param size The number of bytes to allocate
- * @param debug_level What debug level to use (0=none, 1=some, 2=more)
  * @param file Typically the __FILE__ macro
  * @param line Typically the __LINE__ macro
  */
-static inline void *lam_malloc(size_t size, int debug_level, char *file, 
+static inline void *lam_malloc(size_t size, char *file, int line)
-                               int line)
 {
-    void *addr = NULL;
+    void *addr;
-    if (debug_level > 1) {
+    if (lam_malloc_debug_level > 1) {
         if (size <= 0) {
-#if 0
+          lam_output(lam_malloc_output, "Request for %ld bytes (%s, %d)", 
-          /* JMS Replace with logging output */
+                     (long) size, file, line);
-            lam_set_file_line(file, line);
-            lam_warn("Warning: lam_malloc: Request for %ld bytes\n",
-                      (long) size);
-#endif
         }
     }
     addr = malloc(size);
-    if (debug_level > 0) {
+    if (lam_malloc_debug_level > 0) {
         if (NULL == addr) {
-#if 0
+            lam_output(lam_malloc_output, 
-          /* JMS Replace with logging output */
+                       "Request for %ld bytes failed (%s, %d)",
-            lam_set_file_line(file, line);
+                       (long) size, file, line);
-            lam_err("Error: lam_malloc: Request for %ld bytes failed\n",
-                     (long) size);
-#endif
         }
     }
 
@@ -65,25 +87,24 @@ static inline void *lam_malloc(size_t size, int debug_level, char *file,
 
 
 /**
+ * \internal
+ *
  * Back-end error-checking free function for LAM (you should use the
  * LAM_FREE() macro instead of this function).
  *
- * @param addr Address previously returned by lam_malloc()
+ * @param addr Address on the heap to free()
- * @param debug_level What debug level to use (0=none, 1=some, 2=more)
  * @param file Typically the __FILE__ macro
  * @param line Typically the __LINE__ macro
  */
-static inline void lam_free(void *addr, int debug_level, char *file, int line)
+#include <stdio.h>
+static inline void lam_free(void *addr, char *file, int line)
 {
-    if (debug_level > 1 && NULL == addr) {
+    if (lam_malloc_debug_level > 1 && NULL == addr) {
-#if 0
+      printf("INVALID FREE!\n");
-          /* JMS Replace with logging output */
+        lam_output(lam_malloc_output, "Invalid free (%s, %d)", file, line);
-        lam_set_file_line(file, line);
+    } else {
-        lam_warn("Warning: lam_free: Invalid pointer %p\n", addr);
+      free(addr);
-#endif
-        return;
     }
-    free(addr);
 }
 
 #if LAM_MALLOC_DEBUG_LEVEL > 0
@@ -98,7 +119,7 @@ static inline void lam_free(void *addr, int debug_level, char *file, int line)
  * is disabled.
  */
 #define LAM_MALLOC(SIZE) \
-    lam_malloc(SIZE, LAM_MALLOC_DEBUG_LEVEL, __FILE__, __LINE__)
+    lam_malloc(SIZE, __FILE__, __LINE__)
 
 /**
  * Error-checking free function for LAM.  
@@ -108,10 +129,13 @@ static inline void lam_free(void *addr, int debug_level, char *file, int line)
  * This macro will invoke lam_free() if compile-time debugging was
  * enabled, or just invoke free() directly if compile-time debugging
  * is disabled.
+ *
+ * The memory to be freed can be allocated from anywhere (e.g.,
+ * strdup()) -- it does not have to be allocated by LAM_MALLOC().
  */
 #define LAM_FREE(ADDR) \
     do { \
-      lam_free((ADDR), LAM_MALLOC_DEBUG_LEVEL, __FILE__, __LINE__); \
+      lam_free((ADDR), __FILE__, __LINE__); \
       (ADDR) = NULL; \
     } while (0)
 #else