xmlmemory.c 25.6 KB
Newer Older
1
/*
2
 * xmlmemory.c:  libxml memory allocator wrapper.
3
 *
4
 * daniel@veillard.com
5 6
 */

7
#define IN_LIBXML
8
#include "libxml.h"
9 10 11 12 13 14

#include <string.h>

#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
15

16 17 18
#ifdef HAVE_TIME_H
#include <time.h>
#endif
19 20 21 22

#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#else
23 24 25 26
#ifdef HAVE_MALLOC_H
#include <malloc.h>
#endif
#endif
27

28 29 30 31
#ifdef HAVE_CTYPE_H
#include <ctype.h>
#endif

32
/* #define DEBUG_MEMORY */
33

34 35 36
/**
 * MEM_LIST:
 *
37
 * keep track of all allocated blocks for error reporting
38 39
 * Always build the memory list !
 */
40
#ifdef DEBUG_MEMORY_LOCATION
41 42 43
#ifndef MEM_LIST
#define MEM_LIST /* keep a list of all the allocated memory blocks */
#endif
44
#endif
45

46
#include <libxml/globals.h>	/* must come before xmlmemory.h */
47 48
#include <libxml/xmlmemory.h>
#include <libxml/xmlerror.h>
49
#include <libxml/threads.h>
50

51
static int xmlMemInitialized = 0;
52
static unsigned long  debugMemSize = 0;
53
static unsigned long  debugMemBlocks = 0;
54
static unsigned long  debugMaxMemSize = 0;
55
static xmlMutexPtr xmlMemMutex = NULL;
56

57 58 59 60
void xmlMallocBreakpoint(void);

/************************************************************************
 *									*
61
 *		Macros, variables and associated types			*
62 63 64
 *									*
 ************************************************************************/

65
#if !defined(LIBXML_THREAD_ENABLED) && !defined(LIBXML_THREAD_ALLOC_ENABLED)
66 67 68 69 70 71 72 73 74
#ifdef xmlMalloc
#undef xmlMalloc
#endif
#ifdef xmlRealloc
#undef xmlRealloc
#endif
#ifdef xmlMemStrdup
#undef xmlMemStrdup
#endif
75
#endif
76 77 78 79 80 81 82 83 84 85

/*
 * Each of the blocks allocated begin with a header containing informations
 */

#define MEMTAG 0x5aa5

#define MALLOC_TYPE 1
#define REALLOC_TYPE 2
#define STRDUP_TYPE 3
86 87
#define MALLOC_ATOMIC_TYPE 4
#define REALLOC_ATOMIC_TYPE 5
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

typedef struct memnod {
    unsigned int   mh_tag;
    unsigned int   mh_type;
    unsigned long  mh_number;
    size_t         mh_size;
#ifdef MEM_LIST
   struct memnod *mh_next;
   struct memnod *mh_prev;
#endif
   const char    *mh_file;
   unsigned int   mh_line;
}  MEMHDR;


#ifdef SUN4
#define ALIGN_SIZE  16
#else
#define ALIGN_SIZE  sizeof(double)
#endif
#define HDR_SIZE    sizeof(MEMHDR)
#define RESERVE_SIZE (((HDR_SIZE + (ALIGN_SIZE-1)) \
		      / ALIGN_SIZE ) * ALIGN_SIZE)


#define CLIENT_2_HDR(a) ((MEMHDR *) (((char *) (a)) - RESERVE_SIZE))
#define HDR_2_CLIENT(a)    ((void *) (((char *) (a)) + RESERVE_SIZE))


117 118
static unsigned int block=0;
static unsigned int xmlMemStopAtBlock = 0;
119
static void *xmlMemTraceBlockAt = NULL;
120 121 122 123
#ifdef MEM_LIST
static MEMHDR *memlist = NULL;
#endif

124
static void debugmem_tag_error(void *addr);
125
#ifdef MEM_LIST
126 127
static void  debugmem_list_add(MEMHDR *);
static void debugmem_list_delete(MEMHDR *);
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
#endif
#define Mem_Tag_Err(a) debugmem_tag_error(a);

#ifndef TEST_POINT
#define TEST_POINT
#endif

/**
 * xmlMallocBreakpoint:
 *
 * Breakpoint to use in conjunction with xmlMemStopAtBlock. When the block
 * number reaches the specified value this function is called. One need to add a breakpoint
 * to it to get the context in which the given block is allocated.
 */

void
xmlMallocBreakpoint(void) {
    xmlGenericError(xmlGenericErrorContext,
	    "xmlMallocBreakpoint reached on block %d\n", xmlMemStopAtBlock);
}

/**
 * xmlMallocLoc:
 * @size:  an int specifying the size in byte to allocate.
 * @file:  the file name or NULL
 * @line:  the line number
 *
 * a malloc() equivalent, with logging of the allocation info.
 *
 * Returns a pointer to the allocated area or NULL in case of lack of memory.
 */

void *
161
xmlMallocLoc(size_t size, const char * file, int line)
162 163
{
    MEMHDR *p;
164
    void *ret;
165

166 167 168 169 170 171 172
    if (!xmlMemInitialized) xmlInitMemory();
#ifdef DEBUG_MEMORY
    xmlGenericError(xmlGenericErrorContext,
	    "Malloc(%d)\n",size);
#endif

    TEST_POINT
173

174 175 176 177
    p = (MEMHDR *) malloc(RESERVE_SIZE+size);

    if (!p) {
	xmlGenericError(xmlGenericErrorContext,
178
		"xmlMallocLoc : Out of free space\n");
179 180
	xmlMemoryDump();
	return(NULL);
181
    }
182 183 184 185 186
    p->mh_tag = MEMTAG;
    p->mh_size = size;
    p->mh_type = MALLOC_TYPE;
    p->mh_file = file;
    p->mh_line = line;
187 188
    xmlMutexLock(xmlMemMutex);
    p->mh_number = ++block;
189
    debugMemSize += size;
190
    debugMemBlocks++;
191 192 193 194
    if (debugMemSize > debugMaxMemSize) debugMaxMemSize = debugMemSize;
#ifdef MEM_LIST
    debugmem_list_add(p);
#endif
195
    xmlMutexUnlock(xmlMemMutex);
196

197 198 199 200
#ifdef DEBUG_MEMORY
    xmlGenericError(xmlGenericErrorContext,
	    "Malloc(%d) Ok\n",size);
#endif
201

202
    if (xmlMemStopAtBlock == p->mh_number) xmlMallocBreakpoint();
203

204 205 206 207
    ret = HDR_2_CLIENT(p);

    if (xmlMemTraceBlockAt == ret) {
	xmlGenericError(xmlGenericErrorContext,
208 209
			"%p : Malloc(%lu) Ok\n", xmlMemTraceBlockAt,
			(long unsigned)size);
210 211 212
	xmlMallocBreakpoint();
    }

213 214
    TEST_POINT

215
    return(ret);
216 217
}

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
/**
 * xmlMallocAtomicLoc:
 * @size:  an int specifying the size in byte to allocate.
 * @file:  the file name or NULL
 * @line:  the line number
 *
 * a malloc() equivalent, with logging of the allocation info.
 *
 * Returns a pointer to the allocated area or NULL in case of lack of memory.
 */

void *
xmlMallocAtomicLoc(size_t size, const char * file, int line)
{
    MEMHDR *p;
    void *ret;
234

235 236 237 238 239 240 241
    if (!xmlMemInitialized) xmlInitMemory();
#ifdef DEBUG_MEMORY
    xmlGenericError(xmlGenericErrorContext,
	    "Malloc(%d)\n",size);
#endif

    TEST_POINT
242

243 244 245 246 247 248 249
    p = (MEMHDR *) malloc(RESERVE_SIZE+size);

    if (!p) {
	xmlGenericError(xmlGenericErrorContext,
		"xmlMallocLoc : Out of free space\n");
	xmlMemoryDump();
	return(NULL);
250
    }
251 252 253 254 255
    p->mh_tag = MEMTAG;
    p->mh_size = size;
    p->mh_type = MALLOC_ATOMIC_TYPE;
    p->mh_file = file;
    p->mh_line = line;
256 257
    xmlMutexLock(xmlMemMutex);
    p->mh_number = ++block;
258
    debugMemSize += size;
259
    debugMemBlocks++;
260 261 262 263
    if (debugMemSize > debugMaxMemSize) debugMaxMemSize = debugMemSize;
#ifdef MEM_LIST
    debugmem_list_add(p);
#endif
264
    xmlMutexUnlock(xmlMemMutex);
265 266 267 268 269

#ifdef DEBUG_MEMORY
    xmlGenericError(xmlGenericErrorContext,
	    "Malloc(%d) Ok\n",size);
#endif
270

271
    if (xmlMemStopAtBlock == p->mh_number) xmlMallocBreakpoint();
272 273 274 275 276

    ret = HDR_2_CLIENT(p);

    if (xmlMemTraceBlockAt == ret) {
	xmlGenericError(xmlGenericErrorContext,
277 278
			"%p : Malloc(%lu) Ok\n", xmlMemTraceBlockAt,
			(long unsigned)size);
279 280 281 282 283 284 285
	xmlMallocBreakpoint();
    }

    TEST_POINT

    return(ret);
}
286 287 288 289 290 291 292 293 294 295
/**
 * xmlMemMalloc:
 * @size:  an int specifying the size in byte to allocate.
 *
 * a malloc() equivalent, with logging of the allocation info.
 *
 * Returns a pointer to the allocated area or NULL in case of lack of memory.
 */

void *
296
xmlMemMalloc(size_t size)
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
{
    return(xmlMallocLoc(size, "none", 0));
}

/**
 * xmlReallocLoc:
 * @ptr:  the initial memory block pointer
 * @size:  an int specifying the size in byte to allocate.
 * @file:  the file name or NULL
 * @line:  the line number
 *
 * a realloc() equivalent, with logging of the allocation info.
 *
 * Returns a pointer to the allocated area or NULL in case of lack of memory.
 */

void *
314
xmlReallocLoc(void *ptr,size_t size, const char * file, int line)
315
{
316
    MEMHDR *p, *tmp;
317
    unsigned long number;
318 319 320
#ifdef DEBUG_MEMORY
    size_t oldsize;
#endif
321

322
    if (ptr == NULL)
323 324 325
        return(xmlMallocLoc(size, file, line));

    if (!xmlMemInitialized) xmlInitMemory();
326 327 328 329
    TEST_POINT

    p = CLIENT_2_HDR(ptr);
    number = p->mh_number;
330
    if (xmlMemStopAtBlock == number) xmlMallocBreakpoint();
331 332 333 334 335
    if (p->mh_tag != MEMTAG) {
       Mem_Tag_Err(p);
	 goto error;
    }
    p->mh_tag = ~MEMTAG;
336
    xmlMutexLock(xmlMemMutex);
337
    debugMemSize -= p->mh_size;
338
    debugMemBlocks--;
339 340 341
#ifdef DEBUG_MEMORY
    oldsize = p->mh_size;
#endif
342 343 344
#ifdef MEM_LIST
    debugmem_list_delete(p);
#endif
345
    xmlMutexUnlock(xmlMemMutex);
346

347 348 349
    tmp = (MEMHDR *) realloc(p,RESERVE_SIZE+size);
    if (!tmp) {
	 free(p);
350 351
	 goto error;
    }
352
    p = tmp;
353 354
    if (xmlMemTraceBlockAt == ptr) {
	xmlGenericError(xmlGenericErrorContext,
355 356 357
			"%p : Realloced(%lu -> %lu) Ok\n",
			xmlMemTraceBlockAt, (long unsigned)p->mh_size,
			(long unsigned)size);
358 359
	xmlMallocBreakpoint();
    }
360 361 362 363 364 365
    p->mh_tag = MEMTAG;
    p->mh_number = number;
    p->mh_type = REALLOC_TYPE;
    p->mh_size = size;
    p->mh_file = file;
    p->mh_line = line;
366
    xmlMutexLock(xmlMemMutex);
367
    debugMemSize += size;
368
    debugMemBlocks++;
369 370 371 372
    if (debugMemSize > debugMaxMemSize) debugMaxMemSize = debugMemSize;
#ifdef MEM_LIST
    debugmem_list_add(p);
#endif
373
    xmlMutexUnlock(xmlMemMutex);
374 375 376

    TEST_POINT

377 378 379 380
#ifdef DEBUG_MEMORY
    xmlGenericError(xmlGenericErrorContext,
	    "Realloced(%d to %d) Ok\n", oldsize, size);
#endif
381
    return(HDR_2_CLIENT(p));
382 383

error:
384 385 386 387 388 389 390 391 392 393 394 395 396 397
    return(NULL);
}

/**
 * xmlMemRealloc:
 * @ptr:  the initial memory block pointer
 * @size:  an int specifying the size in byte to allocate.
 *
 * a realloc() equivalent, with logging of the allocation info.
 *
 * Returns a pointer to the allocated area or NULL in case of lack of memory.
 */

void *
398
xmlMemRealloc(void *ptr,size_t size) {
399 400 401 402 403 404 405 406 407 408 409 410 411
    return(xmlReallocLoc(ptr, size, "none", 0));
}

/**
 * xmlMemFree:
 * @ptr:  the memory block pointer
 *
 * a free() equivalent, with error checking.
 */
void
xmlMemFree(void *ptr)
{
    MEMHDR *p;
412
    char *target;
413 414 415
#ifdef DEBUG_MEMORY
    size_t size;
#endif
416

417 418 419
    if (ptr == NULL)
	return;

420 421 422 423 424 425 426 427 428 429 430 431
    if (ptr == (void *) -1) {
	xmlGenericError(xmlGenericErrorContext,
	    "trying to free pointer from freed area\n");
        goto error;
    }

    if (xmlMemTraceBlockAt == ptr) {
	xmlGenericError(xmlGenericErrorContext,
			"%p : Freed()\n", xmlMemTraceBlockAt);
	xmlMallocBreakpoint();
    }

432 433
    TEST_POINT

434 435
    target = (char *) ptr;

436 437
    p = CLIENT_2_HDR(ptr);
    if (p->mh_tag != MEMTAG) {
438 439
        Mem_Tag_Err(p);
        goto error;
440
    }
441
    if (xmlMemStopAtBlock == p->mh_number) xmlMallocBreakpoint();
442
    p->mh_tag = ~MEMTAG;
443
    memset(target, -1, p->mh_size);
444 445
    xmlMutexLock(xmlMemMutex);
    debugMemSize -= p->mh_size;
446
    debugMemBlocks--;
447 448 449
#ifdef DEBUG_MEMORY
    size = p->mh_size;
#endif
450 451 452
#ifdef MEM_LIST
    debugmem_list_delete(p);
#endif
453 454
    xmlMutexUnlock(xmlMemMutex);

455 456 457 458
    free(p);

    TEST_POINT

459 460 461 462
#ifdef DEBUG_MEMORY
    xmlGenericError(xmlGenericErrorContext,
	    "Freed(%d) Ok\n", size);
#endif
463

464
    return;
465 466

error:
467
    xmlGenericError(xmlGenericErrorContext,
468
	    "xmlMemFree(%lX) error\n", (unsigned long) ptr);
469
    xmlMallocBreakpoint();
470 471 472 473 474
    return;
}

/**
 * xmlMemStrdupLoc:
475
 * @str:  the initial string pointer
476 477 478 479 480
 * @file:  the file name or NULL
 * @line:  the line number
 *
 * a strdup() equivalent, with logging of the allocation info.
 *
481
 * Returns a pointer to the new string or NULL if allocation error occurred.
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
 */

char *
xmlMemStrdupLoc(const char *str, const char *file, int line)
{
    char *s;
    size_t size = strlen(str) + 1;
    MEMHDR *p;

    if (!xmlMemInitialized) xmlInitMemory();
    TEST_POINT

    p = (MEMHDR *) malloc(RESERVE_SIZE+size);
    if (!p) {
      goto error;
    }
    p->mh_tag = MEMTAG;
    p->mh_size = size;
    p->mh_type = STRDUP_TYPE;
    p->mh_file = file;
    p->mh_line = line;
503 504
    xmlMutexLock(xmlMemMutex);
    p->mh_number = ++block;
505
    debugMemSize += size;
506
    debugMemBlocks++;
507 508 509 510
    if (debugMemSize > debugMaxMemSize) debugMaxMemSize = debugMemSize;
#ifdef MEM_LIST
    debugmem_list_add(p);
#endif
511
    xmlMutexUnlock(xmlMemMutex);
512

513
    s = (char *) HDR_2_CLIENT(p);
514

515
    if (xmlMemStopAtBlock == p->mh_number) xmlMallocBreakpoint();
516

517
    strcpy(s,str);
518

519 520
    TEST_POINT

521 522 523 524 525 526
    if (xmlMemTraceBlockAt == s) {
	xmlGenericError(xmlGenericErrorContext,
			"%p : Strdup() Ok\n", xmlMemTraceBlockAt);
	xmlMallocBreakpoint();
    }

527 528 529 530 531 532 533 534
    return(s);

error:
    return(NULL);
}

/**
 * xmlMemoryStrdup:
535
 * @str:  the initial string pointer
536 537 538
 *
 * a strdup() equivalent, with logging of the allocation info.
 *
539
 * Returns a pointer to the new string or NULL if allocation error occurred.
540 541 542 543 544 545 546 547 548 549
 */

char *
xmlMemoryStrdup(const char *str) {
    return(xmlMemStrdupLoc(str, "none", 0));
}

/**
 * xmlMemUsed:
 *
550
 * Provides the amount of memory currently allocated
551 552 553 554 555 556 557 558 559
 *
 * Returns an int representing the amount of memory allocated.
 */

int
xmlMemUsed(void) {
     return(debugMemSize);
}

560 561 562 563 564 565 566 567 568 569 570 571 572
/**
 * xmlMemBlocks:
 *
 * Provides the number of memory areas currently allocated
 *
 * Returns an int representing the number of blocks
 */

int
xmlMemBlocks(void) {
     return(debugMemBlocks);
}

573 574 575 576 577 578 579 580 581
#ifdef MEM_LIST
/**
 * xmlMemContentShow:
 * @fp:  a FILE descriptor used as the output file
 * @p:  a memory block header
 *
 * tries to show some content from the memory block
 */

582
static void
583 584
xmlMemContentShow(FILE *fp, MEMHDR *p)
{
585 586
    int i,j,k,len;
    const char *buf;
587 588 589 590 591

    if (p == NULL) {
	fprintf(fp, " NULL");
	return;
    }
592 593
    len = p->mh_size;
    buf = (const char *) HDR_2_CLIENT(p);
594 595 596

    for (i = 0;i < len;i++) {
        if (buf[i] == 0) break;
597
	if (!isprint((unsigned char) buf[i])) break;
598 599 600 601 602 603
    }
    if ((i < 4) && ((buf[i] != 0) || (i == 0))) {
        if (len >= 4) {
	    MEMHDR *q;
	    void *cur;

604
            for (j = 0;(j < len -3) && (j < 40);j += 4) {
605 606 607
		cur = *((void **) &buf[j]);
		q = CLIENT_2_HDR(cur);
		p = memlist;
608
		k = 0;
609 610 611
		while (p != NULL) {
		    if (p == q) break;
		    p = p->mh_next;
612
		    if (k++ > 100) break;
613 614 615 616 617 618 619 620 621 622 623
		}
		if ((p != NULL) && (p == q)) {
		    fprintf(fp, " pointer to #%lu at index %d",
		            p->mh_number, j);
		    return;
		}
	    }
	}
    } else if ((i == 0) && (buf[i] == 0)) {
        fprintf(fp," null");
    } else {
624
        if (buf[i] == 0) fprintf(fp," \"%.25s\"", buf);
625 626 627 628 629 630 631 632 633 634
	else {
            fprintf(fp," [");
	    for (j = 0;j < i;j++)
                fprintf(fp,"%c", buf[j]);
            fprintf(fp,"]");
	}
    }
}
#endif

635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
/**
 * xmlMemDisplayLast:
 * @fp:  a FILE descriptor used as the output file, if NULL, the result is
 *       written to the file .memorylist
 * @nbBytes: the amount of memory to dump
 *
 * the last nbBytes of memory allocated and not freed, useful for dumping
 * the memory left allocated between two places at runtime.
 */

void
xmlMemDisplayLast(FILE *fp, long nbBytes)
{
#ifdef MEM_LIST
    MEMHDR *p;
    unsigned idx;
    int     nb = 0;
#endif
    FILE *old_fp = fp;

    if (nbBytes <= 0)
        return;

    if (fp == NULL) {
	fp = fopen(".memorylist", "w");
	if (fp == NULL)
	    return;
    }

#ifdef MEM_LIST
    fprintf(fp,"   Last %li MEMORY ALLOCATED : %lu, MAX was %lu\n",
            nbBytes, debugMemSize, debugMaxMemSize);
    fprintf(fp,"BLOCK  NUMBER   SIZE  TYPE\n");
    idx = 0;
    xmlMutexLock(xmlMemMutex);
    p = memlist;
    while ((p) && (nbBytes > 0)) {
	  fprintf(fp,"%-5u  %6lu %6lu ",idx++,p->mh_number,
		  (unsigned long)p->mh_size);
        switch (p->mh_type) {
           case STRDUP_TYPE:fprintf(fp,"strdup()  in ");break;
           case MALLOC_TYPE:fprintf(fp,"malloc()  in ");break;
           case REALLOC_TYPE:fprintf(fp,"realloc() in ");break;
           case MALLOC_ATOMIC_TYPE:fprintf(fp,"atomicmalloc()  in ");break;
           case REALLOC_ATOMIC_TYPE:fprintf(fp,"atomicrealloc() in ");break;
           default:
	        fprintf(fp,"Unknown memory block, may be corrupted");
		xmlMutexUnlock(xmlMemMutex);
		if (old_fp == NULL)
		    fclose(fp);
		return;
        }
	if (p->mh_file != NULL) fprintf(fp,"%s(%u)", p->mh_file, p->mh_line);
        if (p->mh_tag != MEMTAG)
	      fprintf(fp,"  INVALID");
        nb++;
	if (nb < 100)
	    xmlMemContentShow(fp, p);
	else
	    fprintf(fp," skip");

        fprintf(fp,"\n");
	nbBytes -= (unsigned long)p->mh_size;
        p = p->mh_next;
    }
    xmlMutexUnlock(xmlMemMutex);
#else
    fprintf(fp,"Memory list not compiled (MEM_LIST not defined !)\n");
#endif
    if (old_fp == NULL)
	fclose(fp);
}

708 709 710 711 712 713 714 715 716 717 718 719 720
/**
 * xmlMemDisplay:
 * @fp:  a FILE descriptor used as the output file, if NULL, the result is
 *       written to the file .memorylist
 *
 * show in-extenso the memory blocks allocated
 */

void
xmlMemDisplay(FILE *fp)
{
#ifdef MEM_LIST
    MEMHDR *p;
721
    unsigned idx;
722
    int     nb = 0;
723 724 725 726
#if defined(HAVE_LOCALTIME) && defined(HAVE_STRFTIME)
    time_t currentTime;
    char buf[500];
    struct tm * tstruct;
727 728 729 730 731 732 733 734 735
#endif
#endif
    FILE *old_fp = fp;

    if (fp == NULL) {
	fp = fopen(".memorylist", "w");
	if (fp == NULL)
	    return;
    }
736

737 738
#ifdef MEM_LIST
#if defined(HAVE_LOCALTIME) && defined(HAVE_STRFTIME)
739 740
    currentTime = time(NULL);
    tstruct = localtime(&currentTime);
741
    strftime(buf, sizeof(buf) - 1, "%I:%M:%S %p", tstruct);
742 743 744
    fprintf(fp,"      %s\n\n", buf);
#endif

745

746 747 748 749
    fprintf(fp,"      MEMORY ALLOCATED : %lu, MAX was %lu\n",
            debugMemSize, debugMaxMemSize);
    fprintf(fp,"BLOCK  NUMBER   SIZE  TYPE\n");
    idx = 0;
750
    xmlMutexLock(xmlMemMutex);
751 752
    p = memlist;
    while (p) {
753 754
	  fprintf(fp,"%-5u  %6lu %6lu ",idx++,p->mh_number,
		  (unsigned long)p->mh_size);
755 756 757
        switch (p->mh_type) {
           case STRDUP_TYPE:fprintf(fp,"strdup()  in ");break;
           case MALLOC_TYPE:fprintf(fp,"malloc()  in ");break;
758
           case REALLOC_TYPE:fprintf(fp,"realloc() in ");break;
759
           case MALLOC_ATOMIC_TYPE:fprintf(fp,"atomicmalloc()  in ");break;
760 761
           case REALLOC_ATOMIC_TYPE:fprintf(fp,"atomicrealloc() in ");break;
           default:
762
	        fprintf(fp,"Unknown memory block, may be corrupted");
763
		xmlMutexUnlock(xmlMemMutex);
764 765
		if (old_fp == NULL)
		    fclose(fp);
766
		return;
767
        }
768
	if (p->mh_file != NULL) fprintf(fp,"%s(%u)", p->mh_file, p->mh_line);
769 770
        if (p->mh_tag != MEMTAG)
	      fprintf(fp,"  INVALID");
771 772 773 774 775 776
        nb++;
	if (nb < 100)
	    xmlMemContentShow(fp, p);
	else
	    fprintf(fp," skip");

777 778 779
        fprintf(fp,"\n");
        p = p->mh_next;
    }
780
    xmlMutexUnlock(xmlMemMutex);
781 782 783
#else
    fprintf(fp,"Memory list not compiled (MEM_LIST not defined !)\n");
#endif
784 785
    if (old_fp == NULL)
	fclose(fp);
786 787 788 789
}

#ifdef MEM_LIST

790
static void debugmem_list_add(MEMHDR *p)
791 792 793 794 795 796 797 798 799 800 801
{
     p->mh_next = memlist;
     p->mh_prev = NULL;
     if (memlist) memlist->mh_prev = p;
     memlist = p;
#ifdef MEM_LIST_DEBUG
     if (stderr)
     Mem_Display(stderr);
#endif
}

802
static void debugmem_list_delete(MEMHDR *p)
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
{
     if (p->mh_next)
     p->mh_next->mh_prev = p->mh_prev;
     if (p->mh_prev)
     p->mh_prev->mh_next = p->mh_next;
     else memlist = p->mh_next;
#ifdef MEM_LIST_DEBUG
     if (stderr)
     Mem_Display(stderr);
#endif
}

#endif

/*
818 819 820
 * debugmem_tag_error:
 *
 * internal error function.
821
 */
822

823
static void debugmem_tag_error(void *p)
824 825 826 827 828 829 830 831 832
{
     xmlGenericError(xmlGenericErrorContext,
	     "Memory tag error occurs :%p \n\t bye\n", p);
#ifdef MEM_LIST
     if (stderr)
     xmlMemDisplay(stderr);
#endif
}

833
#ifdef MEM_LIST
834
static FILE *xmlMemoryDumpFile = NULL;
835
#endif
836

837 838 839 840 841 842 843 844 845 846
/**
 * xmlMemShow:
 * @fp:  a FILE descriptor used as the output file
 * @nr:  number of entries to dump
 *
 * show a show display of the memory allocated, and dump
 * the @nr last allocated areas which were not freed
 */

void
847
xmlMemShow(FILE *fp, int nr ATTRIBUTE_UNUSED)
848 849 850 851 852 853 854 855 856
{
#ifdef MEM_LIST
    MEMHDR *p;
#endif

    if (fp != NULL)
	fprintf(fp,"      MEMORY ALLOCATED : %lu, MAX was %lu\n",
		debugMemSize, debugMaxMemSize);
#ifdef MEM_LIST
857
    xmlMutexLock(xmlMemMutex);
858 859 860 861 862 863 864 865 866 867 868 869 870 871
    if (nr > 0) {
	fprintf(fp,"NUMBER   SIZE  TYPE   WHERE\n");
	p = memlist;
	while ((p) && nr > 0) {
	      fprintf(fp,"%6lu %6lu ",p->mh_number,(unsigned long)p->mh_size);
	    switch (p->mh_type) {
	       case STRDUP_TYPE:fprintf(fp,"strdup()  in ");break;
	       case MALLOC_TYPE:fprintf(fp,"malloc()  in ");break;
	       case MALLOC_ATOMIC_TYPE:fprintf(fp,"atomicmalloc()  in ");break;
	      case REALLOC_TYPE:fprintf(fp,"realloc() in ");break;
	      case REALLOC_ATOMIC_TYPE:fprintf(fp,"atomicrealloc() in ");break;
		default:fprintf(fp,"   ???    in ");break;
	    }
	    if (p->mh_file != NULL)
872
	        fprintf(fp,"%s(%u)", p->mh_file, p->mh_line);
873 874 875 876 877 878 879 880
	    if (p->mh_tag != MEMTAG)
		fprintf(fp,"  INVALID");
	    xmlMemContentShow(fp, p);
	    fprintf(fp,"\n");
	    nr--;
	    p = p->mh_next;
	}
    }
881
    xmlMutexUnlock(xmlMemMutex);
882
#endif /* MEM_LIST */
883 884
}

885 886 887 888 889 890 891 892 893
/**
 * xmlMemoryDump:
 *
 * Dump in-extenso the memory blocks allocated to the file .memorylist
 */

void
xmlMemoryDump(void)
{
894
#ifdef MEM_LIST
895 896
    FILE *dump;

897 898
    if (debugMaxMemSize == 0)
	return;
899
    dump = fopen(".memdump", "w");
900 901
    if (dump == NULL)
	xmlMemoryDumpFile = stderr;
902 903 904 905 906
    else xmlMemoryDumpFile = dump;

    xmlMemDisplay(xmlMemoryDumpFile);

    if (dump != NULL) fclose(dump);
907
#endif /* MEM_LIST */
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
}


/****************************************************************
 *								*
 *		Initialization Routines				*
 *								*
 ****************************************************************/

/**
 * xmlInitMemory:
 *
 * Initialize the memory layer.
 *
 * Returns 0 on success
 */
int
xmlInitMemory(void)
{
927 928
#ifdef HAVE_STDLIB_H
     char *breakpoint;
929
#endif
930 931 932
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlInitMemory()\n");
933
#endif
934 935 936 937 938
    /*
     This is really not good code (see Bug 130419).  Suggestions for
     improvement will be welcome!
    */
     if (xmlMemInitialized) return(-1);
939 940
     xmlMemInitialized = 1;
     xmlMemMutex = xmlNewMutex();
941 942 943 944

#ifdef HAVE_STDLIB_H
     breakpoint = getenv("XML_MEM_BREAKPOINT");
     if (breakpoint != NULL) {
945
         sscanf(breakpoint, "%ud", &xmlMemStopAtBlock);
946
     }
947
#endif
948 949 950 951 952
#ifdef HAVE_STDLIB_H
     breakpoint = getenv("XML_MEM_TRACE");
     if (breakpoint != NULL) {
         sscanf(breakpoint, "%p", &xmlMemTraceBlockAt);
     }
953 954
#endif

955 956 957
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlInitMemory() Ok\n");
958
#endif
959
     return(0);
960 961
}

962 963 964
/**
 * xmlCleanupMemory:
 *
965 966
 * Free up all the memory allocated by the library for its own
 * use. This should not be called by user level code.
967 968 969
 */
void
xmlCleanupMemory(void) {
970 971 972
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlCleanupMemory()\n");
973
#endif
974 975 976 977
    if (xmlMemInitialized == 0)
        return;

    xmlFreeMutex(xmlMemMutex);
978
    xmlMemMutex = NULL;
979
    xmlMemInitialized = 0;
980 981 982
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlCleanupMemory() Ok\n");
983
#endif
984 985
}

986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
/**
 * xmlMemSetup:
 * @freeFunc: the free() function to use
 * @mallocFunc: the malloc() function to use
 * @reallocFunc: the realloc() function to use
 * @strdupFunc: the strdup() function to use
 *
 * Override the default memory access functions with a new set
 * This has to be called before any other libxml routines !
 *
 * Should this be blocked if there was already some allocations
 * done ?
 *
 * Returns 0 on success
 */
int
xmlMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
            xmlReallocFunc reallocFunc, xmlStrdupFunc strdupFunc) {
1004 1005 1006
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlMemSetup()\n");
1007
#endif
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
    if (freeFunc == NULL)
	return(-1);
    if (mallocFunc == NULL)
	return(-1);
    if (reallocFunc == NULL)
	return(-1);
    if (strdupFunc == NULL)
	return(-1);
    xmlFree = freeFunc;
    xmlMalloc = mallocFunc;
1018
    xmlMallocAtomic = mallocFunc;
1019 1020
    xmlRealloc = reallocFunc;
    xmlMemStrdup = strdupFunc;
1021 1022 1023
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlMemSetup() Ok\n");
1024
#endif
1025 1026 1027 1028 1029
    return(0);
}

/**
 * xmlMemGet:
1030 1031 1032 1033
 * @freeFunc: place to save the free() function in use
 * @mallocFunc: place to save the malloc() function in use
 * @reallocFunc: place to save the realloc() function in use
 * @strdupFunc: place to save the strdup() function in use
1034
 *
1035
 * Provides the memory access functions set currently in use
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
 *
 * Returns 0 on success
 */
int
xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
	  xmlReallocFunc *reallocFunc, xmlStrdupFunc *strdupFunc) {
    if (freeFunc != NULL) *freeFunc = xmlFree;
    if (mallocFunc != NULL) *mallocFunc = xmlMalloc;
    if (reallocFunc != NULL) *reallocFunc = xmlRealloc;
    if (strdupFunc != NULL) *strdupFunc = xmlMemStrdup;
    return(0);
}

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
/**
 * xmlGcMemSetup:
 * @freeFunc: the free() function to use
 * @mallocFunc: the malloc() function to use
 * @mallocAtomicFunc: the malloc() function to use for atomic allocations
 * @reallocFunc: the realloc() function to use
 * @strdupFunc: the strdup() function to use
 *
 * Override the default memory access functions with a new set
 * This has to be called before any other libxml routines !
 * The mallocAtomicFunc is specialized for atomic block
 * allocations (i.e. of areas  useful for garbage collected memory allocators
 *
 * Should this be blocked if there was already some allocations
 * done ?
 *
 * Returns 0 on success
 */
int
xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
              xmlMallocFunc mallocAtomicFunc, xmlReallocFunc reallocFunc,
	      xmlStrdupFunc strdupFunc) {
1071 1072 1073
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlGcMemSetup()\n");
1074
#endif
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
    if (freeFunc == NULL)
	return(-1);
    if (mallocFunc == NULL)
	return(-1);
    if (mallocAtomicFunc == NULL)
	return(-1);
    if (reallocFunc == NULL)
	return(-1);
    if (strdupFunc == NULL)
	return(-1);
    xmlFree = freeFunc;
    xmlMalloc = mallocFunc;
    xmlMallocAtomic = mallocAtomicFunc;
    xmlRealloc = reallocFunc;
    xmlMemStrdup = strdupFunc;
1090 1091 1092
#ifdef DEBUG_MEMORY
     xmlGenericError(xmlGenericErrorContext,
	     "xmlGcMemSetup() Ok\n");
1093
#endif
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
    return(0);
}

/**
 * xmlGcMemGet:
 * @freeFunc: place to save the free() function in use
 * @mallocFunc: place to save the malloc() function in use
 * @mallocAtomicFunc: place to save the atomic malloc() function in use
 * @reallocFunc: place to save the realloc() function in use
 * @strdupFunc: place to save the strdup() function in use
 *
 * Provides the memory access functions set currently in use
 * The mallocAtomicFunc is specialized for atomic block
 * allocations (i.e. of areas  useful for garbage collected memory allocators
 *
 * Returns 0 on success
 */
int
xmlGcMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
            xmlMallocFunc *mallocAtomicFunc, xmlReallocFunc *reallocFunc,
	    xmlStrdupFunc *strdupFunc) {
    if (freeFunc != NULL) *freeFunc = xmlFree;
    if (mallocFunc != NULL) *mallocFunc = xmlMalloc;
    if (mallocAtomicFunc != NULL) *mallocAtomicFunc = xmlMallocAtomic;
    if (reallocFunc != NULL) *reallocFunc = xmlRealloc;
    if (strdupFunc != NULL) *strdupFunc = xmlMemStrdup;
    return(0);
}

1123 1124
#define bottom_xmlmemory
#include "elfgcchack.h"