X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcmemory.h;h=65286de3faadd762c08de6dd7059088857fd43db;hp=149e8c9044d9f72045ccc78dd82818507eefb7ee;hb=0f0340b9fbce9704cc7171f8f0104ce9103d2de6;hpb=d60003d3019371d4ce834a6cbfbf41c257f5a5f7 diff --git a/lib/silcutil/silcmemory.h b/lib/silcutil/silcmemory.h index 149e8c90..65286de3 100644 --- a/lib/silcutil/silcmemory.h +++ b/lib/silcutil/silcmemory.h @@ -1,10 +1,10 @@ /* - silcmemory.h + silcmemory.h Author: Pekka Riikonen - Copyright (C) 1999 - 2002 Pekka Riikonen + Copyright (C) 1999 - 2005 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 @@ -122,9 +122,191 @@ void *silc_memdup(const void *ptr, size_t size); #else #ifndef SILC_DIST_TOOLKIT #error "The stack trace is not supported in this distribution" -#endif /* SILC_DIST_TOOLKIT */ +#endif #include "stacktrace.h" #endif /* SILC_STACKTRACE */ + +/* Following functions that use SilcStack as memory source. */ + +/****f* silcutil/SilcMemoryAPI/silc_smalloc + * + * SYNOPSIS + * + * void *silc_smalloc(SilcStack stack, SilcUInt32 size); + * + * DESCRIPTION + * + * Allocate memory block of size of `size' from the stack indicated by + * `stack' and return pointer to it. Returns NULL on error. This + * function allocates aligned memory so it can be used to allocate + * memory for structures, for example. If you allocate strings or + * data buffers using silc_smalloc_ua is recommended instead of this + * function. + * + * NOTES + * + * Be careful with this function: do not free the returned pointer + * explicitly and do not save the returned pointer to a permanent + * location. + * + * If `stack' is NULL this function calls silc_malloc. + * + ***/ +void *silc_smalloc(SilcStack stack, SilcUInt32 size); + +/****f* silcutil/SilcMemoryAPI/silc_smalloc_ua + * + * SYNOPSIS + * + * void *silc_smalloc_ua(SilcStack stack, SilcUInt32 size); + * + * DESCRIPTION + * + * Allocate unaligned memory block of size of `size' from the stack + * indicated by `stack' and return pointer to it. Returns NULL on error. + * + * NOTES + * + * This function must not be used to allocate memory for structures. + * Use this function only for strings and data buffers. + * + * Be careful with this function: do not free the returned pointer + * explicitly and do not save the returned pointer to a permanent + * location. + * + * If `stack' is NULL this function calls silc_malloc. + * + ***/ +void *silc_smalloc_ua(SilcStack stack, SilcUInt32 size); + +/****f* silcutil/SilcMemoryAPI/silc_scalloc + * + * SYNOPSIS + * + * void *silc_scalloc(SilcStack stack, SilcUInt32 items, SilcUInt32 size); + * + * DESCRIPTION + * + * Allocate memory block of size of `size' from the stack indicated by + * `stack', zero the memory area and return pointer to it. This + * function allocates aligned memory. Returns NULL on error. + * + * NOTES + * + * Be careful with this function: do not free the returned pointer + * explicitly and do not save the returned pointer to a permanent + * location. + * + * If `stack' is NULL this function calls silc_calloc. + * + ***/ +void *silc_scalloc(SilcStack stack, SilcUInt32 items, SilcUInt32 size); + +/****f* silcutil/SilcMemoryAPI/silc_srealloc + * + * SYNOPSIS + * + * void *silc_srealloc(SilcStack stack, SilcUInt32 old_size, + * void *ptr, SilcUInt32 size); + * + * DESCRIPTION + * + * Change the size of the memory block indicated by `ptr' to the new + * 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. + * + * 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. + * + * This function can be used to reallocate only aligned memory allocated + * with silc_smalloc. + * + * If `stack' is NULL this function calls silc_realloc. + * + ***/ +void *silc_srealloc(SilcStack stack, SilcUInt32 old_size, + void *ptr, SilcUInt32 size); + +/****f* silcutil/SilcMemoryAPI/silc_srealloc_ua + * + * SYNOPSIS + * + * void *silc_srealloc_ua(SilcStack stack, SilcUInt32 old_size, + * void *ptr, SilcUInt32 size); + * + * DESCRIPTION + * + * Same as silc_srealloc but reallocates unaligned memory. + * + * NOTES + * + * This function can be used to reallocate only unaligned memory + * allocated with silc_smalloc_ua. + * + * If `stack' is NULL this function calls silc_realloc. + * + ***/ +void *silc_srealloc_ua(SilcStack stack, SilcUInt32 old_size, + void *ptr, SilcUInt32 size); + +/****f* silcutil/SilcMemoryAPI/silc_smemdup + * + * SYNOPSIS + * + * void *silc_smemdup(SilcStack stack, const void *ptr, SilcUInt32 size); + * + * DESCRIPTION + * + * Duplicates the memory area indicated by `ptr' which is the size of + * `size' bytes. Returns pointer to the duplicated memory area. This + * NULL terminates the dupped memory area by allocating `size' + 1 + * bytes, so this function can be used to duplicate strings that does not + * have NULL termination. This function allocates aligned memory so + * it can be used to duplicate also structures. Returns NULL on error. + * + * NOTES + * + * Be careful with this function: do not free the returned pointer + * explicitly and do not save the returned pointer to a permanent + * location. + * + * If `stack' is NULL this function calls silc_memdup. + * + ***/ +void *silc_smemdup(SilcStack stack, const void *ptr, SilcUInt32 size); + +/****f* silcutil/SilcMemoryAPI/silc_sstrdup + * + * SYNOPSIS + * + * char *silc_sstrdup(SilcStack stack, const char *str); + * + * DESCRIPTION + * + * Duplicates the string indicated by `str' and returns the duplicated + * string. This function allocates unaligned memory. Returns NULL + * on error. + * + * NOTES + * + * Be careful with this function: do not free the returned pointer + * explicitly and do not save the returned pointer to a permanent + * location. + * + * If `stack' is NULL this function calls silc_strdup. + * + ***/ +char *silc_sstrdup(SilcStack stack, const char *str); + #endif /* SILCMEMORY_H */