File: fda.c

package info (click to toggle)
fda 1.0-3
  • links: PTS
  • area: main
  • in suites: potato, woody
  • size: 96 kB
  • ctags: 74
  • sloc: ansic: 501; makefile: 47
file content (571 lines) | stat: -rw-r--r-- 13,432 bytes parent folder | download | duplicates (3)
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
/*
 * fda.c - Free Debug Allocator
 * Copyright (C) 1997 Thomas Helvey <tomh@inxpress.net>
 *
 * 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
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
#include <sys/types.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "fda.h"
#include <assert.h>

static void lowmem_fn(void)
{
  fprintf(stderr, "Warning: low memory!\n");
}

static void nomem_fn(void)
{
  fprintf(stderr, "Error: out of memory!\n");
  abort();
}

static void (*lowMemFn)(void) = lowmem_fn;
static void (*noMemFn)(void)  = nomem_fn;

void set_lowmem_handler(void (*fn)(void))
{
  lowMemFn = fn;
}

void set_nomem_handler(void (*fn)(void))
{
  noMemFn = fn;
}

#if defined(_DEBUG) || defined(DEBUG)

#define ULONGSIZE sizeof(unsigned long)
#define base_ptr(p) ((char*)(p) - ULONGSIZE)
#define base_size(s) ((((s) + 3 + 2 * ULONGSIZE) / ULONGSIZE) * ULONGSIZE)

struct _location {
  struct _location* next;
  struct _location* prev;
  const char* file;
  int         line;
  int         count;
};

struct _blkhdr {
  struct _blkhdr* next;     /* Next block in list */
  unsigned char*  buf;      /* Allocated buffer */
  size_t          size;     /* Size of allocated buffer */
  int             ref;      /* Buffer referenced flag */
  struct _location* location;  /* Where the allocation took place */
}; 

typedef struct _blkhdr   BlkHdr;
typedef struct _location Location;

static const unsigned long hell = 0xdeadbeef;
static size_t  byteCount = 0;  /* count of currently allocated bytes */
static size_t  blockCount = 0; /* count of allocated blocks */
static BlkHdr* bhTab[FDA_HASH_TABLE_SIZE];
static Location* locationList = 0;


/*
 * fda_get_byte_count - returns the client memory allocated in bytes
 */
size_t fda_get_byte_count(void)
{
  return byteCount;
}

/*
 * fda_get_block_count - returns the number of blocks allocated
 */
size_t fda_get_block_count(void)
{
  return blockCount;
}

/*
 * find_location - finds a location on the list, this
 * only compares pointers so it should only be used with
 * ANSI __FILE__ and __LINE__ macros.
 */
static Location* find_location(const char* file, int line)
{
  Location* location = locationList;
  for ( ; location; location = location->next) {
    if (file == location->file && line == location->line)
      return location;
  }
  return 0;
}

/*
 * add_location - adds a allocation location to the list
 * returns a pointer to the new location
 */
static Location* add_location(const char* file, int line)
{
  Location* location;
  assert(0 != file);
  if ((location = (Location*) malloc(sizeof(Location))) != 0) {
    location->next = locationList;
    location->prev = 0;
    location->file = file;
    location->line = line;
    location->count = 0;
    if (location->next)
      location->next->prev = location;
    locationList = location;
  }
  return location;
}

/*
 * free_location - frees a file/line info location
 */
static void free_location(Location* location)
{
  assert(0 != location && 0 == location->count);
  if (location->next != 0)
    location->next->prev = location->prev;
  if (location->prev != 0)
    location->prev->next = location->next;
  else
    locationList = location->next;
  free(location);
}

/*
 * hash_ptr - simple pointer hash function
 */
static unsigned long hash_ptr(const void* p)
{
  return ((unsigned long)p >> 2) % FDA_HASH_TABLE_SIZE;
}

/*
 * find_blk_exhaustive - find a block by scanning the
 * entire hash table. This function finds blocks that do not
 * start at the pointer returned from Malloc.
 */
static BlkHdr* find_blk_exhaustive(const unsigned char* p)
{
  int i;
  BlkHdr* bh;

  for (i = 0; i < FDA_HASH_TABLE_SIZE; ++i) {
    for (bh = bhTab[i]; bh; bh = bh->next) {
      if (bh->buf < p && p < (bh->buf + ULONGSIZE + bh->size))
        return bh;
    }
  }
  return 0;
}

/*
 * find_blk - return the block struct associated with the
 * pointer p.
 */
static BlkHdr* find_blk(const unsigned char* p)
{
  BlkHdr* bh = bhTab[hash_ptr(p)];
  for ( ; bh; bh = bh->next) {
    if (p == bh->buf)
      return bh;
  }
  return find_blk_exhaustive(p);
}

/*
 * make_blk - create a block header and add it to the hash table
 */
static int make_blk(unsigned char* p, size_t size, Location* loc)
{
  BlkHdr* bh;

  assert(0 != p && 0 < size && 0 != loc);
  if ((bh = (BlkHdr*)malloc(sizeof(BlkHdr))) != 0) {
    unsigned long h = hash_ptr(p);
    bh->ref = 0;
    bh->buf = p;
    bh->size = size;
    bh->location = loc;
    bh->next = bhTab[h];
    bhTab[h] = bh;
    ++bh->location->count;
    byteCount += size;
    ++blockCount;
  }
  return (0 != bh);
}

/*
 * free_blk - remove a block header and free it
 */
static void free_blk(const unsigned char* p)
{
  BlkHdr* bh_prev = 0;
  BlkHdr* bh;
  unsigned long h = hash_ptr(p);

  for (bh = bhTab[h]; bh; bh = bh->next) {
    if (p == bh->buf) {
      if (0 == bh_prev)
        bhTab[h] = bh->next;
      else
        bh_prev->next = bh->next;
      break;
    }
    bh_prev = bh;
  }
  /* if bh is NULL p was not allocated here */
  assert(0 != bh);
  assert(bh->location->count > 0);
  if (--bh->location->count == 0)
    free_location(bh->location);
  byteCount -= bh->size;
  --blockCount;
  SHRED_MEM(bh, sizeof(BlkHdr));
  free(bh);
}

/*
 * update_blk - update block info, rehash if pointers are different,
 * update location info if needed
 */
static void update_blk(unsigned char* p, unsigned char* np, size_t size, const char* file, int line)
{
  BlkHdr* bh;
  if (p != np) {
    BlkHdr* bh_prev = 0;
    unsigned long h = hash_ptr(p);

    /* remove the old entry from the hash table */
    for (bh = bhTab[h]; bh; bh = bh->next) {
      if (p == bh->buf) {
        if (0 == bh_prev)
          bhTab[h] = bh->next;
        else
          bh_prev->next = bh->next;
        /* put it back in the hash table at hash(np) */
        h = hash_ptr(np);
        bh->next = bhTab[h];
        bhTab[h] = bh;
        break;
      }
      bh_prev = bh;
    }
  }
  else
    bh = find_blk(p);
  /* invalid ptr? */
  assert(0 != bh);
  byteCount -= bh->size;
  byteCount += size;
  bh->buf = np;
  bh->size = size;
  /* update location info */
  if (bh->location->file != file || bh->location->line != line) {
    if (--bh->location->count == 0)
      free_location(bh->location);
    if ((bh->location = find_location(file, line)) == 0) {
      if ((bh->location = add_location(file, line)) == 0)
        noMemFn();
    }
    assert(0 != bh->location);
    ++bh->location->count;
  }
}

/*
 * fda_sizeof - returns the size of block of memory pointed to by p
 */
size_t fda_sizeof(const void* p)
{
  BlkHdr* bh = find_blk(base_ptr(p));
  assert(0 != bh && (unsigned char*)base_ptr(p) == bh->buf);
  return bh->size;
}

/*
 * fda_clear_refs - clear referenced markers on all blocks
 */
void fda_clear_refs(void)
{
  int i;
  BlkHdr* bh;

  for (i = 0; i < FDA_HASH_TABLE_SIZE; ++i) {
    for (bh = bhTab[i]; bh; bh = bh->next)
      bh->ref = 0;
  }
}

/*
 * fda_set_ref - mark block as referenced
 */
void fda_set_ref(const void* p)
{
  BlkHdr* bh = find_blk(base_ptr(p));
  assert(0 != bh);
  bh->ref = 1;
}

/*
 * fda_assert_refs - scan for all blocks and check for null
 * ptrs and unreferenced (lost) blocks
 */
void fda_assert_refs(void)
{
  int i;
  BlkHdr* bh;

  for (i = 0; i < FDA_HASH_TABLE_SIZE; ++i) {
    for (bh = bhTab[i]; bh; bh = bh->next) {
      assert(0 != bh->buf && 0 < bh->size);
      assert(1 == bh->ref);
    }
  }
}

/*
 * valid_ptr - returns true if p points to allocated memory and
 * has at least size available
 */
int valid_ptr(const void* p, size_t size)
{
  BlkHdr* bh;
  assert(0 != p && 0 < size);
  bh = find_blk(base_ptr(p));
  /* check that there are at least size bytes available from p */
  assert(((const unsigned char*)p + size) <= (bh->buf + ULONGSIZE + bh->size));
  return 1;
}

/*
 * fda_enum_locations - calls enumfn to list file, line, and count
 * info for allocations, returns the number of locations found
 */
int fda_enum_locations(void (*enumfn)(const char*, int, int))
{
  int count = 0;
  Location* location;
  assert(0 != enumfn);
  for (location = locationList; location; location = location->next) {
    (*enumfn)(location->file, location->line, location->count);
    ++count;
  }
  return count;
}

/*
 * fda_enum_leaks - scan hash table for leaks and call enumfn to
 * report them.
 */
int fda_enum_leaks(void (*enumfn)(const char*, int, size_t, void*))
{
  int count = 0;
  BlkHdr* bh;
  int i;
  for (i = 0; i < FDA_HASH_TABLE_SIZE; ++i) {
    for (bh = bhTab[i]; bh; bh = bh->next) {
      if (0 == bh->ref) {
        (*enumfn)(bh->location->file, bh->location->line, bh->size, bh->buf);
        ++count;
      }
    }
  }
  return count;
}

/*
 * fda_malloc - allocate size chunk of memory and create debug
 * records for it.
 */
void* fda_malloc(size_t size, const char* file, int line)
{
  void* p;
  size_t blk_size;
  Location* location;

  assert(0 < size && 0 != file);
  /* 
   * Make sure that there is enough room for prefix/postfix 
   * and we get an aligned buffer 
   */
  blk_size = base_size(size);

  if ((p = malloc(blk_size)) == 0) {
    lowMemFn();
    if ((p = malloc(blk_size)) == 0)
      noMemFn();
  }
  /* don't allow malloc to fail */
  assert(0 != p);
  /* shred the memory and set bounds markers */
  SHRED_MEM(p, blk_size);
  *((unsigned long*)p) = hell;
  *((unsigned long*)((char*)p + blk_size - ULONGSIZE)) = hell;

  /* find the location or create a new one */
  if ((location = find_location(file, line)) == 0) {
    if ((location = add_location(file, line)) == 0) {
      free(p);
      noMemFn();
    }
  }
  /* don't allow noMemFn to return */
  assert(0 != location);
  if (!make_blk(p, size, location)) {
    free(p);
    p = 0;
    noMemFn();
  }
  /* don't allow noMemFn to return */
  assert(0 != p);
  return (void*)((char*)p + ULONGSIZE);
}

/*
 * fda_free - check chunk of memory for overruns and free it
 */
void fda_free(void* p)
{
  if (p) {
    size_t size;
    void* ptr = base_ptr(p);
    BlkHdr* bh = find_blk(ptr);
    /* ptr invalid? */
    assert(0 != bh && ptr == bh->buf);
    size = base_size(bh->size);
    /* buffer underflow? */
    assert(hell == *((unsigned long*) ptr));
    /* 
     * buffer overflow?
     * Note: it's possible to have up to 3 bytes of unchecked space 
     * between size and hell
     */
    assert(hell == *((unsigned long*)((char*)ptr + size - ULONGSIZE)));
    SHRED_MEM(ptr, size);
    free_blk(ptr);
  }
}

/*
 * fda_realloc - resize a buffer, force reallocation if new size is
 * larger than old size
 */
void* fda_realloc(void* p, size_t size, const char* file, int line)
{
  void* np;
  size_t old_size;
  size_t blk_size;
  /* don't allow malloc or free through realloc */
  assert(0 != p && 0 < size);
  old_size = fda_sizeof(p);
  
  if (size < old_size)
    SHRED_MEM((char*)p + size, old_size - size);
  else if (size > old_size) {
    void* t = fda_malloc(size, __FILE__, __LINE__);
    memcpy(t, p, old_size);
    fda_free(p);
    p = t;
  }
  blk_size = base_size(size);
  if ((np = realloc(base_ptr(p), blk_size)) == 0) {
    lowMemFn();
    if ((np = realloc(base_ptr(p), blk_size)) == 0)
      noMemFn();
  }
  /* don't allow noMemFn to return */
  assert(0 != np);
  update_blk(base_ptr(p), np, size, file, line);
  /* shred tail */
  if (size > old_size)
    SHRED_MEM((char*)np + ULONGSIZE + old_size, blk_size - (old_size + ULONGSIZE));
  /* Note: it's possible to have up to 3 bytes between size and hell */
  *((unsigned long*)((char*)np + blk_size - ULONGSIZE)) = hell;
  return p;
}

/*
 * fda_calloc - allocate 0 initialized buffer nelems * size length
 */
void* fda_calloc(size_t nelems, size_t size, const char* file, int line)
{
  void* p;
  assert(0 < nelems && 0 < size && 0 != file);
  size *= nelems;
  p = fda_malloc(size, file, line);
  memset(p, 0, size);
  return p;
}

/*
 * fda_dupstring - duplicates a string returns newly allocated string
 */
char* fda_dupstring(const char* src, const char* file, int line)
{
  char* p;
  assert(0 != src);
  p = (char*) fda_malloc(strlen(src) + 1, file, line);
  strcpy(p, src);
  return p;
}

#else /* !defined(_DEBUG) && !defined(DEBUG) */

void* Malloc(size_t size)
{
  void* p = malloc(size);
  if (0 == p) {
    lowMemFn();
    if ((p = malloc(size)) == 0)
      noMemFn();
  }
  return p;
}

void* Realloc(void* p, size_t size)
{
  void* np = realloc(p, size);
  if (0 == np) {
    lowMemFn();
    if ((np = realloc(p, size)) == 0)
      noMemFn();
  }
  return np;
}

void* Calloc(size_t nelems, size_t size)
{
  void* np = calloc(nelems, size);
  if (0 == np) {
    lowMemFn();
    if ((np = calloc(nelems, size)) == 0)
      noMemFn();
  }
  return np;
}

char* DupString(const char* src)
{
  char* p = Malloc(strlen(src) + 1);
  strcpy(p, src);
  return p;
}

#endif /* !defined(_DEBUG) && !defined(DEBUG) */