diff options
Diffstat (limited to 'WWW/Library/Implementation/LYLeaks.h')
| -rw-r--r-- | WWW/Library/Implementation/LYLeaks.h | 283 |
1 files changed, 135 insertions, 148 deletions
diff --git a/WWW/Library/Implementation/LYLeaks.h b/WWW/Library/Implementation/LYLeaks.h index 19dc526b..81abd551 100644 --- a/WWW/Library/Implementation/LYLeaks.h +++ b/WWW/Library/Implementation/LYLeaks.h @@ -6,60 +6,60 @@ #define __LYLEAKS_H /* -** Copyright (c) 1994, University of Kansas, All Rights Reserved -** -** Include File: LYLeaks.h -** Purpose: Header to convert requests for allocation to Lynx -** custom functions to track memory leaks. -** Remarks/Portability/Dependencies/Restrictions: -** For the stdlib.h allocation functions to be overriden by the -** Lynx memory tracking functions all modules allocating, -** freeing, or resizing memory must have LY_FIND_LEAKS -** defined before including this file. -** This header file should be included in every source file which -** does any memory manipulation through use of the -** stdlib.h memory functions. -** For proper reporting of memory leaks, the function LYLeaks -** should be registered for execution by atexit as the -** very first executable statement in main. -** This code is slow and should not be used except in debugging -** circumstances (don't define LY_FIND_LEAKS). -** If you are using LY_FIND_LEAKS and don't want the LYLeak* -** memory functions to be used in a certain file, -** define NO_MEMORY_TRACKING before including this file. -** The only safe way to call the LYLeak* functions is to use -** the below macros because they depend on the static -** string created by __FILE__ to not be dynamic in -** nature (don't free it and assume will exist at all -** times during execution). -** If you are using LY_FIND_LEAKS and LY_FIND_LEAKS_EXTENDED and -** want only normal memory tracking (not extended for -** HTSprintf/HTSprintf0) to be used in a certain file, -** define NO_EXTENDED_MEMORY_TRACKING and don't define -** NO_MEMORY_TRACKING before including this file. -** Revision History: -** 05-26-94 created for Lynx 2-3-1, Garrett Arch Blythe -** 10-30-97 modified to handle StrAllocCopy() and -** StrAllocCat(). - KW & FM -** 1999-10-17 modified to handle HTSprintf0 and HTSprintf(), -** and to provide mark_malloced, if -** LY_FIND_LEAKS_EXTENDED is defined. - kw -*/ + * Copyright (c) 1994, University of Kansas, All Rights Reserved + * + * Include File: LYLeaks.h + * Purpose: Header to convert requests for allocation to Lynx + * custom functions to track memory leaks. + * Remarks/Portability/Dependencies/Restrictions: + * For the stdlib.h allocation functions to be overriden by the + * Lynx memory tracking functions all modules allocating, + * freeing, or resizing memory must have LY_FIND_LEAKS + * defined before including this file. + * This header file should be included in every source file which + * does any memory manipulation through use of the + * stdlib.h memory functions. + * For proper reporting of memory leaks, the function LYLeaks + * should be registered for execution by atexit as the + * very first executable statement in main. + * This code is slow and should not be used except in debugging + * circumstances (don't define LY_FIND_LEAKS). + * If you are using LY_FIND_LEAKS and don't want the LYLeak* + * memory functions to be used in a certain file, + * define NO_MEMORY_TRACKING before including this file. + * The only safe way to call the LYLeak* functions is to use + * the below macros because they depend on the static + * string created by __FILE__ to not be dynamic in + * nature (don't free it and assume will exist at all + * times during execution). + * If you are using LY_FIND_LEAKS and LY_FIND_LEAKS_EXTENDED and + * want only normal memory tracking (not extended for + * HTSprintf/HTSprintf0) to be used in a certain file, + * define NO_EXTENDED_MEMORY_TRACKING and don't define + * NO_MEMORY_TRACKING before including this file. + * Revision History: + * 05-26-94 created for Lynx 2-3-1, Garrett Arch Blythe + * 10-30-97 modified to handle StrAllocCopy() and + * StrAllocCat(). - KW & FM + * 1999-10-17 modified to handle HTSprintf0 and HTSprintf(), + * and to provide mark_malloced, if + * LY_FIND_LEAKS_EXTENDED is defined. - kw + */ /* Undefine this to get no improved HTSprintf0/HTSprintf tracking: */ #define LY_FIND_LEAKS_EXTENDED /* -** Required includes -*/ + * Required includes + */ #ifndef HTUTILS_H #include <HTUtils.h> #endif /* -** Constant defines -*/ + * Constant defines + */ #define MAX_CONTENT_LENGTH 50 #ifdef VMS #define LEAKAGE_SINK "sys$login:Lynx.leaks" @@ -68,65 +68,62 @@ #endif /* VMS */ /* -** Data structures -*/ -typedef struct SourceLocation_tag { - /* - * The file name and line number of where an event took place. - */ - const char *cp_FileName; - short ssi_LineNumber; -} -SourceLocation; - -typedef struct AllocationList_tag { - /* - * A singly linked list. - */ - struct AllocationList_tag *ALp_Next; - - /* - * Count the number of mallocs. - */ - long st_Sequence; - - /* - * The memory pointer allocated. - * If set to NULL, then an invalid request was made. - * The invalid pointer also. - */ - void *vp_Alloced; - void *vp_BadRequest; - - /* - * The size in bytes of the allocated memory. - */ - size_t st_Bytes; - - /* - * The source location of specific event (calloc, malloc, free). - * realloc kept separate since will track last realloc on pointer. - */ - SourceLocation SL_memory; - SourceLocation SL_realloc; + * Data structures + */ +typedef struct SourceLocation_tag { + /* + * The file name and line number of where an event took place. + */ + const char *cp_FileName; + short ssi_LineNumber; +} SourceLocation; + +typedef struct AllocationList_tag { + /* + * A singly linked list. + */ + struct AllocationList_tag *ALp_Next; + + /* + * Count the number of mallocs. + */ + long st_Sequence; + + /* + * The memory pointer allocated. If set to NULL, then an invalid request + * was made. The invalid pointer also. + */ + void *vp_Alloced; + void *vp_BadRequest; + + /* + * The size in bytes of the allocated memory. + */ + size_t st_Bytes; + + /* + * The source location of specific event (calloc, malloc, free). realloc + * kept separate since will track last realloc on pointer. + */ + SourceLocation SL_memory; + SourceLocation SL_realloc; } AllocationList; /* -** Global variable declarations -*/ + * Global variable declarations + */ /* -** Macros -*/ + * Macros + */ #if defined(LY_FIND_LEAKS) && !defined(NO_MEMORY_TRACKING) /* -** Only use these macros if we are to track memory allocations. -** The reason for using a macro instead of a define is that we want -** to track where the initial allocation took place or where -** the last reallocation took place. -** Track where the allocation took place by the __FILE__ and __LINE__ -** defines which are automatic to the compiler. -*/ + * Only use these macros if we are to track memory allocations. The reason for + * using a macro instead of a define is that we want to track where the initial + * allocation took place or where the last reallocation took place. Track + * where the allocation took place by the __FILE__ and __LINE__ defines which + * are automatic to the compiler. + */ #ifdef malloc #undef malloc #endif /* malloc */ @@ -150,9 +147,9 @@ typedef struct AllocationList_tag { #define free(vp_alloced) LYLeakFree(vp_alloced, __FILE__, __LINE__) /* -** Added the following two defines to track Lynx's frequent use -** of those macros. - KW 1997-10-12 -*/ + * Added the following two defines to track Lynx's frequent use of those + * macros. - KW 1997-10-12 + */ #ifdef StrAllocCopy #undef StrAllocCopy #endif /* StrAllocCopy */ @@ -187,66 +184,56 @@ typedef struct AllocationList_tag { #endif /* LY_FIND_LEAKS && !NO_MEMORY_TRACKING */ #if defined(LY_FIND_LEAKS) -#define PUBLIC_IF_FIND_LEAKS /* nothing */ +#define PUBLIC_IF_FIND_LEAKS /* nothing */ #else #define PUBLIC_IF_FIND_LEAKS static #endif /* -** Function declarations -** See the appropriate source file for usage. -*/ -#ifndef LYLeakSequence -extern long LYLeakSequence (void); + * Function declarations. + * See the appropriate source file for usage. + */ +#ifndef LYLeakSequence +extern long LYLeakSequence(void); #endif -extern void LYLeaks (void); +extern void LYLeaks(void); + #ifdef LY_FIND_LEAKS_EXTENDED -extern AllocationList *LYLeak_mark_malloced ( - void * vp_alloced, - size_t st_bytes, - const char * cp_File, - const short ssi_Line); +extern AllocationList *LYLeak_mark_malloced(void *vp_alloced, + size_t st_bytes, + const char *cp_File, + const short ssi_Line); #endif /* LY_FIND_LEAKS_EXTENDED */ -extern void *LYLeakMalloc ( - size_t st_bytes, - const char * cp_File, - const short ssi_Line); -extern void *LYLeakCalloc ( - size_t st_number, - size_t st_bytes, - const char * cp_File, - const short ssi_Line); -extern void *LYLeakRealloc ( - void * vp_alloced, - size_t st_newbytes, - const char * cp_File, - const short ssi_Line); -extern void LYLeakFree ( - void * vp_alloced, - const char * cp_File, - const short ssi_Line); -extern char * LYLeakSACopy ( - char ** dest, - const char * src, - const char * cp_File, - const short ssi_Line); -extern char * LYLeakSACat ( - char ** dest, - const char * src, - const char * cp_File, - const short ssi_Line); +extern void *LYLeakMalloc(size_t st_bytes, const char *cp_File, + const short ssi_Line); +extern void *LYLeakCalloc(size_t st_number, size_t st_bytes, const char *cp_File, + const short ssi_Line); +extern void *LYLeakRealloc(void *vp_alloced, + size_t st_newbytes, + const char *cp_File, + const short ssi_Line); +extern void LYLeakFree(void *vp_alloced, + const char *cp_File, + const short ssi_Line); +extern char *LYLeakSACopy(char **dest, + const char *src, + const char *cp_File, + const short ssi_Line); +extern char *LYLeakSACat(char **dest, + const char *src, + const char *cp_File, + const short ssi_Line); #ifdef LY_FIND_LEAKS_EXTENDED -/* Trick to get tracking of var arg functions without relying - on var arg preprocessor macros: */ - -typedef char * HTSprintflike (char **, const char *, ...); -extern HTSprintflike *Get_htsprintf_fn ( - const char * cp_File, - const short ssi_Line); -extern HTSprintflike *Get_htsprintf0_fn ( - const char * cp_File, - const short ssi_Line); +/* + * Trick to get tracking of var arg functions without relying on var arg + * preprocessor macros: + */ +typedef char *HTSprintflike(char **, const char *,...); +extern HTSprintflike *Get_htsprintf_fn(const char *cp_File, + const short ssi_Line); +extern HTSprintflike *Get_htsprintf0_fn(const char *cp_File, + const short ssi_Line); #endif /* LY_FIND_LEAKS_EXTENDED */ #endif /* __LYLEAKS_H */ |