/usr/include/ug/heaps.h is in libug-dev 3.12.1-2.
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 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
/*! \file heaps.h
* \ingroup low
*/
/** \addtogroup low
*
* @{
*/
/****************************************************************************/
/* */
/* File: heaps.h */
/* */
/* Purpose: low-level memory management for ug */
/* */
/* Author: Peter Bastian */
/* Interdisziplinaeres Zentrum fuer Wissenschaftliches Rechnen */
/* Universitaet Heidelberg */
/* Im Neuenheimer Feld 368 */
/* 6900 Heidelberg */
/* */
/* History: 29.01.92 begin, ug version 2.0 */
/* */
/* Revision: 04.09.95 */
/* */
/****************************************************************************/
/* RCS_ID
$Header$
*/
/****************************************************************************/
/* */
/* auto include mechanism and other include files */
/* */
/****************************************************************************/
#ifndef __HEAPS__
#define __HEAPS__
#if UG_USE_SYSTEM_HEAP
#include <vector>
#endif
#include "ugtypes.h"
#include "namespace.h"
START_UG_NAMESPACE
/****************************************************************************/
/* */
/* defines in the following order */
/* */
/* compile time constants defining static data size (i.e. arrays) */
/* other constants */
/* macros */
/* */
/****************************************************************************/
/****************************************************************************/
/* defines for the simple and general heap management */
/****************************************************************************/
/** \brief Smallest heap to allocate */
#define MIN_HEAP_SIZE 256
/** \brief Max depth of mark/release calls */
#define MARK_STACK_SIZE 128
enum HeapType {GENERAL_HEAP, /**< Heap with alloc/free mechanism */
SIMPLE_HEAP /**< Heap with mark/release mechanism*/
};
enum HeapAllocMode
{FROM_TOP=1, /**< Allocate from top of stack */
FROM_BOTTOM=2 /**< Allocate from bottom of stack */
};
/** \brief Number of free object pointers */
#define MAXFREEOBJECTS 128
/* by convention, tempory memory on a simple heap should allocated FROM_TOP */
/* the Freelist memory is allocated FROM_BOTTOM */
#define MarkTmpMem(p,kp) Mark(p,FROM_TOP,kp)
#define GetTmpMem(p,n,k) GetMemUsingKey(p,n,FROM_TOP,k)
#define ReleaseTmpMem(p,k) Release(p,FROM_TOP,k)
/****************************************************************************/
/****************************************************************************/
/** @name Defines and macros for the virtual heap management */
/** \brief That many blocks can be allocated */
#define MAXNBLOCKS 50
/** \brief Pass to init routine if no heap yet */
#define SIZE_UNKNOWN 0
/** \brief The memory sized neded for the vhm */
#define SIZEOF_VHM sizeof(VIRT_HEAP_MGMT)
/** \brief Ok return code for virtual heap mgmt*/
#define BHM_OK 0
/** \brief Return codes of DefineBlock */
enum {HEAP_FULL = 1, /**< Return code if storage exhausted */
BLOCK_DEFINED = 2, /**< Return code if block already defined*/
NO_FREE_BLOCK = 3 /**< Return code if no free block found */
};
/* return codes of FreeBlock */
/** \brief Return code if the block is not defined */
#define BLOCK_NOT_DEFINED 1
/* some useful macros */
#define OFFSET_IN_HEAP(vhm,id) (GetBlockDesc((VIRT_HEAP_MGMT*)vhm,id).offset)
#define TOTUSED_IN_HEAP(vhm) ((vhm).TotalUsed)
#define IS_BLOCK_DEFINED(vhm,id) (GetBlockDesc((VIRT_HEAP_MGMT*)vhm,id)!=NULL)
/* @} */
/****************************************************************************/
/* */
/* data structures exported by the corresponding source file */
/* */
/****************************************************************************/
typedef unsigned long MEM;
/****************************************************************************/
/* structs and typedefs for the simple and general heap management */
/****************************************************************************/
struct block {
MEM size;
struct block *next,*previous;
};
typedef struct {
enum HeapType type;
MEM size;
MEM used;
MEM freelistmem;
struct block *heapptr;
INT topStackPtr,bottomStackPtr;
MEM topStack[MARK_STACK_SIZE];
MEM bottomStack[MARK_STACK_SIZE];
INT SizeOfFreeObjects[MAXFREEOBJECTS];
void *freeObjects[MAXFREEOBJECTS];
#ifdef Debug
INT objcount[MAXFREEOBJECTS];
#endif
#if UG_USE_SYSTEM_HEAP
/* This is used only if UG_USE_SYSTEM_HEAP is set, but I don't want the
* #ifdef in an installed header, hence the data member is there all the time. */
std::vector<void*> markedMemory[MARK_STACK_SIZE];
#endif
} HEAP;
/****************************************************************************/
/* structs and typedefs for the block virtual management */
/****************************************************************************/
typedef struct {
INT id; /*!< Id for this block */
MEM offset; /*!< Offset of the data in the heap */
MEM size; /*!< Size of the data in the heap */
} BLOCK_DESC;
typedef struct {
INT locked; /**< If true the TotalSize is fixed */
MEM TotalSize; /**< Total size of the associated heap */
MEM TotalUsed; /**< Total size used */
INT UsedBlocks; /**< Number of blocks initialized */
INT nGaps; /**< true if a gap between exist. blocks */
MEM LargestGap; /**< Largest free gap between blocks */
BLOCK_DESC BlockDesc[MAXNBLOCKS];
/**< The different block descriptors */
} VIRT_HEAP_MGMT;
/****************************************************************************/
/* typedefs for the block virtual management */
/****************************************************************************/
typedef INT BLOCK_ID;
typedef struct block BLOCK;
/****************************************************************************/
/* */
/* definition of exported global variables */
/* */
/****************************************************************************/
#if defined(DYNAMIC_MEMORY_ALLOCMODEL) && defined(Debug)
extern INT check_of_getcallstack;
extern INT check_of_putcallstack;
#endif
/****************************************************************************/
/* */
/* function declarations */
/* */
/****************************************************************************/
INT InitHeaps (void);
/** @name Functions for the simple and general heap management */
/* @{ */
HEAP *NewHeap (enum HeapType type, MEM size, void *buffer);
void DisposeHeap (HEAP *theHeap);
void *GetMem (HEAP *theHeap, MEM n, enum HeapAllocMode mode);
void *GetMemUsingKey (HEAP *theHeap, MEM n, enum HeapAllocMode mode, INT key);
void DisposeMem (HEAP *theHeap, void *buffer);
void *GetFreelistMemory (HEAP *theHeap, INT size);
INT PutFreelistMemory (HEAP *theHeap, void *object, INT size);
INT Mark (HEAP *theHeap, INT mode, INT *key);
INT Release (HEAP *theHeap, INT mode, INT key);
MEM HeapSize (const HEAP *theHeap);
MEM HeapUsed (const HEAP *theHeap);
MEM HeapFree (const HEAP *theHeap);
MEM HeapFreelistUsed (const HEAP *theHeap);
MEM HeapTotalFree (const HEAP *theHeap);
void HeapStat (const HEAP *theHeap);
/* @} */
/** @name Functions for the virtual heap management */
/* @{ */
INT InitVirtualHeapManagement(VIRT_HEAP_MGMT *theVHM, MEM TotalSize);
MEM CalcAndFixTotalSize (VIRT_HEAP_MGMT *theVHM);
BLOCK_ID GetNewBlockID (void);
BLOCK_DESC *GetBlockDesc (VIRT_HEAP_MGMT *theVHM, BLOCK_ID id);
INT DefineBlock (VIRT_HEAP_MGMT *theVHM, BLOCK_ID id, MEM size);
INT FreeBlock (VIRT_HEAP_MGMT *theVHM, BLOCK_ID id);
/* @} */
END_UG_NAMESPACE
/** @} */
#endif
|