Renamed stacktrace to memtrace

[runtime.git] / lib / silcutil / silcmemory.h

diff --git a/lib/silcutil/silcmemory.h b/lib/silcutil/silcmemory.h
index ddcf8bc15b7f858202fcc0630b10a90af1c3ebd7..64c13b5b5243a7658d3aa454ad81bea68a576fa6 100644 (file)
--- a/lib/silcutil/silcmemory.h
+++ b/lib/silcutil/silcmemory.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1999 - 2007 Pekka Riikonen
+  Copyright (C) 1999 - 2008 Pekka Riikonen
 
   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,13 +17,11 @@
 
 */
 
-/****h* silcutil/SILC Memory Interface
+/****h* silcutil/Memory Interface
  *
  * DESCRIPTION
  *
- * Basic utility functions for allocating memory. All SILC routines, and
- * applications use these functions when they need to allocate, manipulate
- * and free memory.
+ * Routines for allocating and freeing memory.
  *
  ***/
 
@@ -32,9 +30,9 @@
 
 /* Prototypes */
 
-#ifndef SILC_STACKTRACE
+#ifndef SILC_MEMTRACE
 
-/****f* silcutil/SilcMemoryAPI/silc_malloc
+/****f* silcutil/silc_malloc
  *
  * SYNOPSIS
  *
@@ -49,7 +47,7 @@
  ***/
 void *silc_malloc(size_t size);
 
-/****f* silcutil/SilcMemoryAPI/silc_calloc
+/****f* silcutil/silc_calloc
  *
  * SYNOPSIS
  *
@@ -65,7 +63,7 @@ void *silc_malloc(size_t size);
  ***/
 void *silc_calloc(size_t items, size_t size);
 
-/****f* silcutil/SilcMemoryAPI/silc_realloc
+/****f* silcutil/silc_realloc
  *
  * SYNOPSIS
  *
@@ -87,7 +85,7 @@ void *silc_calloc(size_t items, size_t size);
  ***/
 void *silc_realloc(void *ptr, size_t size);
 
-/****f* silcutil/SilcMemoryAPI/silc_free
+/****f* silcutil/silc_free
  *
  * SYNOPSIS
  *
@@ -101,7 +99,7 @@ void *silc_realloc(void *ptr, size_t size);
  ***/
 void silc_free(void *ptr);
 
-/****f* silcutil/SilcMemoryAPI/silc_memdup
+/****f* silcutil/silc_memdup
  *
  * SYNOPSIS
  *
@@ -118,7 +116,7 @@ void silc_free(void *ptr);
  ***/
 void *silc_memdup(const void *ptr, size_t size);
 
-/****f* silcutil/SilcMemoryAPI/silc_strdup
+/****f* silcutil/silc_strdup
  *
  * SYNOPSIS
  *
@@ -133,17 +131,13 @@ void *silc_memdup(const void *ptr, size_t size);
 char *silc_strdup(const char *str);
 
 #else
-#ifndef SILC_DIST_TOOLKIT
-#error "The stack trace is not supported in this distribution"
-#endif /* SILC_DIST_TOOLKIT */
-
-#include "stacktrace.h"
-#endif /* SILC_STACKTRACE */
+#include "memtrace.h"
+#endif /* SILC_MEMTRACE */
 
 
 /* Following functions that use SilcStack as memory source. */
 
-/****f* silcutil/SilcMemoryAPI/silc_smalloc
+/****f* silcutil/silc_smalloc
  *
  * SYNOPSIS
  *
@@ -167,7 +161,7 @@ char *silc_strdup(const char *str);
  ***/
 void *silc_smalloc(SilcStack stack, SilcUInt32 size);
 
-/****f* silcutil/SilcMemoryAPI/silc_scalloc
+/****f* silcutil/silc_scalloc
  *
  * SYNOPSIS
  *
@@ -190,7 +184,7 @@ void *silc_smalloc(SilcStack stack, SilcUInt32 size);
  ***/
 void *silc_scalloc(SilcStack stack, SilcUInt32 items, SilcUInt32 size);
 
-/****f* silcutil/SilcMemoryAPI/silc_srealloc
+/****f* silcutil/silc_srealloc
  *
  * SYNOPSIS
  *
@@ -203,17 +197,13 @@ void *silc_scalloc(SilcStack stack, SilcUInt32 items, SilcUInt32 size);
  *    size of `size' bytes.  The contents of `ptr' will not be changed.
  *    If `ptr' is NULL the call is equivalent to silc_smalloc.  If `size'
  *    is zero (0) error will occur.  Returns NULL on error and the old
- *    pointer remain intact.
+ *    pointer remain intact.  This may return different pointer from `ptr'
  *
  * NOTES
  *
- *    This function reallocates successfully only if the previous allocation
- *    to `stack' was `ptr'.  If there was another memory allocation between
- *    allocating `ptr' and this call, this routine will return NULL.  The
- *    NULL is also returned if the `size' does not fit to current stack
- *    and allocating new block would require slow copying of the data.  It
- *    is left to the caller to decide whether to allocate new pointer and
- *    copy the old data in case this function returns NULL.
+ *    If the reallocation from `stack' fails, this function will allocate
+ *    new block of size of `size' bytes from `stack' and copy the data from
+ *    `ptr' to the new memory block.
  *
  *    If `stack' is NULL this function calls silc_realloc.
  *
@@ -221,7 +211,7 @@ void *silc_scalloc(SilcStack stack, SilcUInt32 items, SilcUInt32 size);
 void *silc_srealloc(SilcStack stack, SilcUInt32 old_size,
                    void *ptr, SilcUInt32 size);
 
-/****f* silcutil/SilcMemoryAPI/silc_smemdup
+/****f* silcutil/silc_smemdup
  *
  * SYNOPSIS
  *
@@ -247,7 +237,7 @@ void *silc_srealloc(SilcStack stack, SilcUInt32 old_size,
  ***/
 void *silc_smemdup(SilcStack stack, const void *ptr, SilcUInt32 size);
 
-/****f* silcutil/SilcMemoryAPI/silc_sfree
+/****f* silcutil/silc_sfree
  *
  * SYNOPSIS
  *
@@ -262,7 +252,7 @@ void *silc_smemdup(SilcStack stack, const void *ptr, SilcUInt32 size);
  ***/
 void silc_sfree(SilcStack stack, void *ptr);
 
-/****f* silcutil/SilcMemoryAPI/silc_sstrdup
+/****f* silcutil/silc_sstrdup
  *
  * SYNOPSIS
  *