/usr/include/sbml/util/memory.h is in libsbml5-dev 5.13.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | /**
* @cond doxygenLibsbmlInternal
*
* @file memory.h
* @brief Safe (c|m)alloc(), free() and trace functions
* @author Ben Bornstein
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2016 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution and
* also available online as http://sbml.org/software/libsbml/license.html
* ---------------------------------------------------------------------- -->*/
#ifndef memory_h
#define memory_h
#include <sbml/common/extern.h>
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Allocates memory for an array of nmemb elements of size bytes each and
* returns a pointer to the allocated memory. The memory is set to zero.
* If the memory could not be allocated, prints an error message and exits.
*/
LIBSBML_EXTERN
void *
safe_calloc (size_t nmemb, size_t size);
/**
* Allocates size bytes of memory and returns a pointer to the allocated
* memory. If the memory could not be allocated, prints an error message
* and exits.
*/
void *
safe_malloc (size_t size);
/**
* Changes the size of the memory block pointed to by ptr to size bytes and
* returns a new pointer to it. Note: the new pointer may be different
* than ptr. If the memory could not be allocated, prints an error message
* and exits.
*/
void *
safe_realloc (void *ptr, size_t size);
/**
* Safely frees the memory pointed to by p. Without TRACE_MEMORY defined
* safe_free is a synonym for free.
*/
#define safe_free free
#ifdef TRACE_MEMORY
/**
* Initializes the memory tracing facility. Multiple calls are gracefully
* ignored.
*/
void
MemTrace_init (void);
/**
* Resets the memory tracing facility, i.e. starts a new tracing "session".
*/
void
MemTrace_reset (void);
/**
* @return the total number of safe_malloc()s and safe_calloc()s that have
* occurred in this program up to this point.
*/
unsigned int
MemTrace_getNumAllocs (void);
/**
* @return the number of safe_malloc()s and safe_calloc()s that have
* occurred without corresponding safe_free()s, i.e. a potential memory
* leak.
*/
unsigned int
MemTrace_getNumLeaks (void);
/**
* @return the total number of safe_frees() that have occurred in this
* program up to this point.
*/
unsigned int
MemTrace_getNumFrees (void);
/**
* @return the number of safe_free()s that have no corresponding
* safe_malloc() or safe_calloc(), i.e. the free has no *matching* memory
* allocation.
*/
unsigned int
MemTrace_getNumUnmatchedFrees (void);
/**
* @return the maximum number of bytes allocated in this program up to this
* point.
*/
unsigned int
MemTrace_getMaxBytes (void);
/**
* Prints the current memory trace statistics to the given stream.
*/
void
MemTrace_printStatistics (FILE *stream);
/**
* Prints the file and line number of all memory leaks that have occurred
* in this program up to this point. Output is sent to stream.
*/
void
MemTrace_printLeaks (FILE *stream);
/**
* Wrap safe_malloc() in a call to MemTrace_alloc()
*/
#define safe_malloc(size) \
MemTrace_alloc(safe_malloc(size), size, __FILE__, __LINE__)
/**
* Wrap safe_calloc() in a call to MemTrace_alloc()
*/
#define safe_calloc(nmemb, size) \
MemTrace_alloc(safe_calloc(nmemb, size), nmemb * size, __FILE__, __LINE__)
#define safe_realloc(ptr, size) \
MemTrace_realloc(safe_realloc(ptr, size), size, ptr, __FILE__, __LINE__)
/**
* Wrap safe_free() in a call to MemTrace_free()
*/
#undef safe_free
#define safe_free(ptr) MemTrace_free(ptr, __FILE__, __LINE__); free(ptr)
/**
* Traces a memory allocation by adding a MemInfoNode to AllocList.
* Address is the pointer returned by safe_malloc() or safe_calloc(). Size
* is the total number of bytes allocated. Filename and line indicate
* where in the source code the allocation occurred.
*
* This function returns location, so that it may be used in the following
* manner:
*
* MemTrace_alloc( safe_malloc(size), size, __FILE__, __LINE__ );
*
* or similarly for safe_calloc() with size replaced by nmemb * size.
*/
void *
MemTrace_alloc ( void *address, size_t size,
const char *filename, unsigned int line );
/**
* Traces a memory reallocation. This function behaves exactly like
* MemTrace_alloc(), except that the original pointer passed to realloc()
* must be passed in as well to ensure it is properly recorded as freed.
* For e.g.:
*
* MemTrace_realloc( safe_realloc(ptr, size), size, ptr, __FILE__, __LINE__)
*/
void *
MemTrace_realloc ( void *address, size_t size, void *original,
const char *filename, unsigned int line );
/**
* Traces a memory free by removing the MemInfoNode_t containing address from
* AllocList and appending it to FreeList.
*/
void
MemTrace_free (void *address, const char *filename, unsigned int line);
/**
* Declarations beyond is point are only "public" so that their prototypes
* may be checked at compile-time and data structures at runtime in and by
* the TestMemory.c unit test suite.
*/
/**
* MemInfoNode contains information about memory allocations, including the
* memory address, size (in bytes) and file and line number where the
* allocation occurred.
*
* As the name implies each MemInfoNode participates in a linked list.
*/
typedef struct MemInfoNode_
{
const void *address;
size_t size;
const char *filename;
unsigned int line;
struct MemInfoNode_ *next;
} MemInfoNode_t;
typedef struct
{
MemInfoNode_t *head;
MemInfoNode_t *tail;
unsigned int size;
} MemInfoList_t;
/**
* Creates a new MemInfoList_t and returns a pointer to it.
*/
MemInfoList_t *
MemTrace_MemInfoList_create (void);
/**
* Creates a new MemInfoNode_t and returns a pointer to it.
*/
MemInfoNode_t *
MemTrace_MemInfoNode_create ( const void *address, size_t size,
const char *filename, unsigned int line );
/**
* Frees the given MemInfoList_t and its constituent MemInfoNode_t's
*/
void
MemTrace_MemInfoList_free (MemInfoList_t *list);
/**
* Appends the given MemInfoNode_t to the given MemInfoList_t.
*/
void
MemTrace_MemInfoList_append (MemInfoList_t *list, MemInfoNode_t *node);
/**
* Returns a pointer to the MemInfoNode_t in MemInfoList_t with the given
* address or NULL if address is not found.
*/
MemInfoNode_t *
MemTrace_MemInfoList_get (const MemInfoList_t *list, const void *address);
/**
* Removes the MemInfoNode_t with the given address from MemInfoList_t and
* returns a pointer to it. If address is not found in the list, NULL is
* returned.
*/
MemInfoNode_t *
MemTrace_MemInfoList_remove (MemInfoList_t *list, const void *address);
#endif /** TRACE_MEMORY **/
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /** memory_h **/
/** @endcond */
|