Partial application of linux/alpha patch. Courtesy of Falk Hueffner <falk.hueffner...
[btb/d2x.git] / mem / mem.c
1 /*
2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.  
11 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
12 */
13
14 /*
15  * $Source: /cvs/cvsroot/d2x/mem/mem.c,v $
16  * $Revision: 1.5 $
17  * $Author: bradleyb $
18  * $Date: 2001-10-19 08:06:20 $
19  *
20  * Files for debugging memory allocator
21  *
22  * $Log: not supported by cvs2svn $
23  */
24
25 #ifdef HAVE_CONFIG_H
26 #include <conf.h>
27 #endif
28
29 // Warning( "MEM: Too many malloc's!" );
30 // Warning( "MEM: Malloc returnd an already alloced block!" );
31 // Warning( "MEM: Malloc Failed!" );
32 // Warning( "MEM: Freeing the NULL pointer!" );
33 // Warning( "MEM: Freeing a non-malloced pointer!" );
34 // Warning( "MEM: %d/%d check bytes were overwritten at the end of %8x", ec, CHECKSIZE, buffer  );
35 // Warning( "MEM: %d blocks were left allocated!", numleft );
36
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <string.h>
40 #include <malloc.h>
41
42 #include "pstypes.h"
43 #include "mono.h"
44 #include "error.h"
45
46 #ifdef MACINTOSH
47
48         #include <Gestalt.h>
49         #include <Memory.h>
50         #include <Processes.h>
51         ubyte virtual_memory_on = 0;
52
53         #if defined(RELEASE) || defined(NDEBUG)
54                 #define MEMSTATS        0
55         #else
56                 #define MEMSTATS        1
57         #endif
58
59         
60         #if MEMSTATS
61                 static  int             sMemStatsFileInitialized        = false;
62                 static  FILE*   sMemStatsFile                           = NULL;
63                 static  char    sMemStatsFileName[32]           = "memstats.txt";
64         #endif  // end of if MEMSTATS
65         
66 #else   // no memstats on pc
67         #define MEMSTATS 0
68 #endif
69
70 #define FULL_MEM_CHECKING 1
71
72 #if defined(FULL_MEM_CHECKING) && !defined(NDEBUG)
73
74 #define CHECKSIZE 16
75 #define CHECKBYTE 0xFC
76
77 #define MAX_INDEX 10000
78
79 static void *MallocBase[MAX_INDEX];
80 static unsigned int MallocSize[MAX_INDEX];
81 static unsigned char Present[MAX_INDEX];
82 static char * Filename[MAX_INDEX];
83 static char * Varname[MAX_INDEX];
84 static int LineNum[MAX_INDEX];
85 static int BytesMalloced = 0;
86
87 int show_mem_info = 1;
88
89 static int free_list[MAX_INDEX];
90
91 static int num_blocks = 0;
92
93 static int Initialized = 0;
94
95 static int LargestIndex = 0;
96
97 int out_of_memory = 0;
98
99 void mem_display_blocks();
100
101 void mem_init()
102 {
103         int i;
104         
105         Initialized = 1;
106
107         for (i=0; i<MAX_INDEX; i++ )
108         {
109                 free_list[i] = i;
110                 MallocBase[i] = 0;
111                 MallocSize[i] = 0;
112                 Present[i] = 0;
113                 Filename[i] = NULL;
114                 Varname[i] = NULL;
115                 LineNum[i] = 0;
116         }
117
118         num_blocks = 0;
119         LargestIndex = 0;
120
121         atexit(mem_display_blocks);
122         
123 #ifdef MACINTOSH
124
125 // need to check for virtual memory since we will need to do some
126 // tricks based on whether it is on or not
127
128         {
129                 int                     mem_type;
130                 THz                             theD2PartionPtr = nil;
131                 unsigned long   thePartitionSize = 0;
132                 
133                 MaxApplZone();
134                 MoreMasters();                  // allocate 240 more master pointers (mainly for snd handles)
135                 MoreMasters();
136                 MoreMasters();
137                 MoreMasters();
138                 virtual_memory_on = 0;
139                 if(Gestalt(gestaltVMAttr, &mem_type) == noErr)
140                         if (mem_type & 0x1)
141                                 virtual_memory_on = 1;
142                                 
143                 #if MEMSTATS
144                         sMemStatsFile = fopen(sMemStatsFileName, "wt");
145         
146                         if (sMemStatsFile != NULL)
147                         {
148                                 sMemStatsFileInitialized = true;
149         
150                                 theD2PartionPtr = ApplicationZone();
151                                 thePartitionSize =  ((unsigned long) theD2PartionPtr->bkLim) - ((unsigned long) theD2PartionPtr);
152                                 fprintf(sMemStatsFile, "\nMemory Stats File Initialized.");
153                                 fprintf(sMemStatsFile, "\nDescent 2 launched in partition of %u bytes.\n",
154                                                 thePartitionSize);
155                         }
156                 #endif  // end of ifdef MEMSTATS
157         }
158
159 #endif  // end of ifdef macintosh
160
161 }
162
163 void PrintInfo( int id )
164 {
165         fprintf( stderr, "\tBlock '%s' created in %s, line %d.\n", Varname[id], Filename[id], LineNum[id] );
166 }
167
168
169 void * mem_malloc( unsigned int size, char * var, char * filename, int line, int fill_zero )
170 {
171         int i, id;
172         void *ptr;
173         char * pc;
174
175         if (Initialized==0)
176                 mem_init();
177
178 //      printf("malloc: %d %s %d\n", size, filename, line);
179
180 #if MEMSTATS
181         {
182                 unsigned long   theFreeMem = 0;
183         
184                 if (sMemStatsFileInitialized)
185                 {
186                         theFreeMem = FreeMem();
187                 
188                         fprintf(sMemStatsFile,
189                                         "\n%9u bytes free before attempting: MALLOC %9u bytes.",
190                                         theFreeMem,
191                                         size);
192                 }
193         }
194 #endif  // end of ifdef memstats
195
196         if ( num_blocks >= MAX_INDEX )  {
197                 fprintf( stderr,"\nMEM_OUT_OF_SLOTS: Not enough space in mem.c to hold all the mallocs.\n" );           
198                 fprintf( stderr, "\tBlock '%s' created in %s, line %d.\n", var, filename, line );
199                 Error( "MEM_OUT_OF_SLOTS" );
200         }
201
202         id = free_list[ num_blocks++ ];
203
204         if (id > LargestIndex ) LargestIndex = id;
205
206         if (id==-1)
207         {
208                 fprintf( stderr,"\nMEM_OUT_OF_SLOTS: Not enough space in mem.c to hold all the mallocs.\n" );           
209                 fprintf( stderr, "\tBlock '%s' created in %s, line %d.\n", Varname[id], Filename[id], LineNum[id] );
210                 Error( "MEM_OUT_OF_SLOTS" );
211         }
212
213 #ifndef MACINTOSH
214         ptr = malloc( size+CHECKSIZE );
215 #else
216         ptr = (void *)NewPtrClear( size+CHECKSIZE );
217 #endif
218
219         /*
220         for (j=0; j<=LargestIndex; j++ )
221         {
222                 if (Present[j] && MallocBase[j] == (unsigned int)ptr )
223                 {
224                         fprintf( stderr,"\nMEM_SPACE_USED: Malloc returned a block that is already marked as preset.\n" );
225                         fprintf( stderr, "\tBlock '%s' created in %s, line %d.\n", Varname[id], Filename[id], Line[id] );
226                         Warning( "MEM_SPACE_USED" );
227                         Int3();
228                         }
229         }
230         */
231
232         if (ptr==NULL)
233         {
234                 out_of_memory = 1;
235                 fprintf( stderr, "\nMEM_OUT_OF_MEMORY: Malloc returned NULL\n" );
236                 fprintf( stderr, "\tBlock '%s' created in %s, line %d.\n", Varname[id], Filename[id], LineNum[id] );
237                 Error( "MEM_OUT_OF_MEMORY" );
238         }
239
240         MallocBase[id] = ptr;
241         MallocSize[id] = size;
242         Varname[id] = var;
243         Filename[id] = filename;
244         LineNum[id] = line;
245         Present[id]    = 1;
246
247         pc = (char *)ptr;
248
249         BytesMalloced += size;
250
251         for (i=0; i<CHECKSIZE; i++ )
252                 pc[size+i] = CHECKBYTE;
253
254         if (fill_zero)
255                 memset( ptr, 0, size );
256
257         return ptr;
258
259 }
260
261 int mem_find_id( void * buffer )
262 {
263         int i;
264
265         for (i=0; i<=LargestIndex; i++ )
266           if (Present[i]==1)
267             if (MallocBase[i] == buffer )
268               return i;
269
270         // Didn't find id.
271         return -1;
272 }
273
274 int mem_check_integrity( int block_number )
275 {
276         int i, ErrorCount;
277         ubyte * CheckData;
278
279         CheckData = (char *)(MallocBase[block_number] + MallocSize[block_number]);
280
281         ErrorCount = 0;
282                         
283         for (i=0; i<CHECKSIZE; i++ )
284                 if (CheckData[i] != CHECKBYTE ) {
285                         ErrorCount++;
286                         fprintf( stderr, "OA: %p ", &CheckData[i] );
287                 }
288
289         if (ErrorCount &&  (!out_of_memory))    {
290                 fprintf( stderr, "\nMEM_OVERWRITE: Memory after the end of allocated block overwritten.\n" );
291                 PrintInfo( block_number );
292                 fprintf( stderr, "\t%d/%d check bytes were overwritten.\n", ErrorCount, CHECKSIZE );
293                 Int3();
294         }
295
296         return ErrorCount;
297
298 }
299
300 void mem_free( void * buffer )
301 {
302         int id;
303
304         if (Initialized==0)
305                 mem_init();
306
307 #if MEMSTATS
308         {
309                 unsigned long   theFreeMem = 0;
310         
311                 if (sMemStatsFileInitialized)
312                 {
313                         theFreeMem = FreeMem();
314                 
315                         fprintf(sMemStatsFile,
316                                         "\n%9u bytes free before attempting: FREE", theFreeMem);
317                 }
318         }
319 #endif  // end of ifdef memstats
320
321         if (buffer==NULL  &&  (!out_of_memory))
322         {
323                 fprintf( stderr, "\nMEM_FREE_NULL: An attempt was made to free the null pointer.\n" );
324                 Warning( "MEM: Freeing the NULL pointer!" );
325                 Int3();
326                 return;
327         }
328
329         id = mem_find_id( buffer );
330
331         if (id==-1 &&  (!out_of_memory))
332         {
333                 fprintf( stderr, "\nMEM_FREE_NOMALLOC: An attempt was made to free a ptr that wasn't\nallocated with mem.h included.\n" );
334                 Warning( "MEM: Freeing a non-malloced pointer!" );
335                 Int3();
336                 return;
337         }
338         
339         mem_check_integrity( id );
340         
341         BytesMalloced -= MallocSize[id];
342
343 #ifndef MACINTOSH
344         free( buffer );
345 #else
346         DisposePtr( (Ptr)buffer );
347 #endif
348         
349         
350         Present[id] = 0;
351         MallocBase[id] = 0;
352         MallocSize[id] = 0;
353
354         free_list[ --num_blocks ] = id;
355 }
356
357 void mem_display_blocks()
358 {
359         int i, numleft;
360
361         if (Initialized==0) return;
362         
363 #if MEMSTATS
364         {       
365                 if (sMemStatsFileInitialized)
366                 {
367                         unsigned long   theFreeMem = 0;
368
369                         theFreeMem = FreeMem();
370                 
371                         fprintf(sMemStatsFile,
372                                         "\n%9u bytes free before closing MEMSTATS file.", theFreeMem);
373                         fprintf(sMemStatsFile, "\nMemory Stats File Closed.");
374                         fclose(sMemStatsFile);
375                 }
376         }
377 #endif  // end of ifdef memstats
378
379         numleft = 0;
380         for (i=0; i<=LargestIndex; i++ )
381         {
382                 if (Present[i]==1 &&  (!out_of_memory))
383                 {
384                         numleft++;
385                         if (show_mem_info)      {
386                                 fprintf( stderr, "\nMEM_LEAKAGE: Memory block has not been freed.\n" );
387                                 PrintInfo( i );
388                         }
389                         mem_free( (void *)MallocBase[i] );
390                 }
391         }
392
393         if (numleft &&  (!out_of_memory))
394         {
395                 Warning( "MEM: %d blocks were left allocated!", numleft );
396         }
397
398 }
399
400 void mem_validate_heap()
401 {
402         int i;
403         
404         for (i=0; i<LargestIndex; i++  )
405                 if (Present[i]==1 )
406                         mem_check_integrity( i );
407 }
408
409 void mem_print_all()
410 {
411         FILE * ef;
412         int i, size = 0;
413
414         ef = fopen( "DESCENT.MEM", "wt" );
415         
416         for (i=0; i<LargestIndex; i++  )
417                 if (Present[i]==1 )     {
418                         size += MallocSize[i];
419                         //fprintf( ef, "Var:%s\t File:%s\t Line:%d\t Size:%d Base:%x\n", Varname[i], Filename[i], Line[i], MallocSize[i], MallocBase[i] );
420                         fprintf( ef, "%12d bytes in %s declared in %s, line %d\n", MallocSize[i], Varname[i], Filename[i], LineNum[i]  );
421                 }
422         fprintf( ef, "%d bytes (%d Kbytes) allocated.\n", size, size/1024 ); 
423         fclose(ef);
424 }
425
426 #else
427
428 static int Initialized = 0;
429 static unsigned int SmallestAddress = 0xFFFFFFF;
430 static unsigned int LargestAddress = 0x0;
431 static unsigned int BytesMalloced = 0;
432
433 void mem_display_blocks();
434
435 #define CHECKSIZE 16
436 #define CHECKBYTE 0xFC
437
438 int show_mem_info = 0;
439
440 void mem_init()
441 {
442         Initialized = 1;
443
444         SmallestAddress = 0xFFFFFFF;
445         LargestAddress = 0x0;
446
447         atexit(mem_display_blocks);
448
449 #ifdef MACINTOSH
450
451         // need to check for virtual memory since we will need to do some
452         // tricks based on whether it is on or not
453         
454         {
455                 int                     mem_type;
456                 THz                             theD2PartionPtr = nil;
457                 unsigned long   thePartitionSize = 0;
458                 
459                 MaxApplZone();
460                 MoreMasters();          // allocate 240 more master pointers (mainly for snd handles)
461                 MoreMasters();
462                 MoreMasters();
463                 MoreMasters();
464                 virtual_memory_on = 0;
465                 if(Gestalt(gestaltVMAttr, &mem_type) == noErr)
466                         if (mem_type & 0x1)
467                                 virtual_memory_on = 1;
468                                 
469                 #if MEMSTATS
470                         sMemStatsFile = fopen(sMemStatsFileName, "wt");
471
472                         if (sMemStatsFile != NULL)
473                         {
474                                 sMemStatsFileInitialized = true;
475
476                                 theD2PartionPtr = ApplicationZone();
477                                 thePartitionSize =  ((unsigned long) theD2PartionPtr->bkLim) - ((unsigned long) theD2PartionPtr);
478                                 fprintf(sMemStatsFile, "\nMemory Stats File Initialized.");
479                                 fprintf(sMemStatsFile, "\nDescent 2 launched in partition of %u bytes.\n",
480                                                 thePartitionSize);
481                         }
482                 #endif  // end of ifdef memstats
483         }
484         
485 #endif  // end of ifdef macintosh
486
487 }
488
489 void * mem_malloc( unsigned int size, char * var, char * filename, int line, int fill_zero )
490 {
491         unsigned int base;
492         void *ptr;
493         int * psize;
494
495         if (Initialized==0)
496                 mem_init();
497
498 #if MEMSTATS
499         {
500                 unsigned long   theFreeMem = 0;
501         
502                 if (sMemStatsFileInitialized)
503                 {
504                         theFreeMem = FreeMem();
505                 
506                         fprintf(sMemStatsFile,
507                                         "\n%9u bytes free before attempting: MALLOC %9u bytes.",
508                                         theFreeMem,
509                                         size);
510                 }
511         }
512 #endif  // end of ifdef memstats
513
514         if (size==0)    {
515                 fprintf( stderr, "\nMEM_MALLOC_ZERO: Attempting to malloc 0 bytes.\n" );
516                 fprintf( stderr, "\tVar %s, file %s, line %d.\n", var, filename, line );
517                 Error( "MEM_MALLOC_ZERO" );
518                 Int3();
519         }
520
521 #ifndef MACINTOSH
522         ptr = malloc( size + CHECKSIZE );
523 #else
524         ptr = (void *)NewPtrClear( size+CHECKSIZE );
525 #endif
526
527         if (ptr==NULL)  {
528                 fprintf( stderr, "\nMEM_OUT_OF_MEMORY: Malloc returned NULL\n" );
529                 fprintf( stderr, "\tVar %s, file %s, line %d.\n", var, filename, line );
530                 Error( "MEM_OUT_OF_MEMORY" );
531                 Int3();
532         }
533
534         base = (unsigned int)ptr;
535         if ( base < SmallestAddress ) SmallestAddress = base;
536         if ( (base+size) > LargestAddress ) LargestAddress = base+size;
537
538
539         psize = (int *)ptr;
540         psize--;
541         BytesMalloced += *psize;
542
543         if (fill_zero)
544                 memset( ptr, 0, size );
545
546         return ptr;
547 }
548
549 void mem_free( void * buffer )
550 {
551         int * psize = (int *)buffer;
552         psize--;
553
554         if (Initialized==0)
555                 mem_init();
556
557 #if MEMSTATS
558         {
559                 unsigned long   theFreeMem = 0;
560         
561                 if (sMemStatsFileInitialized)
562                 {
563                         theFreeMem = FreeMem();
564                 
565                         fprintf(sMemStatsFile,
566                                         "\n%9u bytes free before attempting: FREE", theFreeMem);
567                 }
568         }
569 #endif  // end of ifdef memstats
570
571         if (buffer==NULL)       {
572                 fprintf( stderr, "\nMEM_FREE_NULL: An attempt was made to free the null pointer.\n" );
573                 Warning( "MEM: Freeing the NULL pointer!" );
574                 Int3();
575                 return;
576         }
577
578         BytesMalloced -= *psize;
579
580 #ifndef MACINTOSH
581         free( buffer );
582 #else
583         DisposePtr( (Ptr)buffer );
584 #endif
585 }
586
587 void mem_display_blocks()
588 {
589         if (Initialized==0) return;
590
591 #if MEMSTATS
592         {       
593                 if (sMemStatsFileInitialized)
594                 {
595                         unsigned long   theFreeMem = 0;
596
597                         theFreeMem = FreeMem();
598                 
599                         fprintf(sMemStatsFile,
600                                         "\n%9u bytes free before closing MEMSTATS file.", theFreeMem);
601                         fprintf(sMemStatsFile, "\nMemory Stats File Closed.");
602                         fclose(sMemStatsFile);
603                 }
604         }
605 #endif  // end of ifdef memstats
606
607         if (BytesMalloced != 0 )        {
608                 fprintf( stderr, "\nMEM_LEAKAGE: %d bytes of memory have not been freed.\n", BytesMalloced );
609         }
610
611         if (show_mem_info)      {
612                 fprintf( stderr, "\n\nMEMORY USAGE:\n" );
613                 fprintf( stderr, "  %u Kbytes dynamic data\n", (LargestAddress-SmallestAddress+512)/1024 );
614                 fprintf( stderr, "  %u Kbytes code/static data.\n", (SmallestAddress-(4*1024*1024)+512)/1024 );
615                 fprintf( stderr, "  ---------------------------\n" );
616                 fprintf( stderr, "  %u Kbytes required.\n",     (LargestAddress-(4*1024*1024)+512)/1024 );
617         }
618 }
619
620 void mem_validate_heap()
621 {
622 }
623
624 void mem_print_all()
625 {
626 }
627
628 #endif
629
630
631 #ifdef MACINTOSH
632
633 // routine to try and compact and purge the process manager zone to squeeze
634 // some temporary memory out of it for QT purposes.
635
636 void PurgeTempMem()
637 {
638         OSErr err;
639         Handle tempHandle;
640         THz appZone, processZone;
641         Size heapSize;
642         
643         // compact the system zone to try and squeeze some temporary memory out of it
644         MaxMemSys(&heapSize);
645         
646         // compact the Process Manager zone to get more temporary memory
647         appZone = ApplicationZone();
648         tempHandle = TempNewHandle(10, &err);           // temporary allocation may fail
649         if (!err && (tempHandle != NULL) ) {
650                 processZone = HandleZone(tempHandle);
651                 if ( MemError() || (processZone == NULL) ) {
652                         DisposeHandle(tempHandle);
653                         return;
654                 }
655                 SetZone(processZone);
656                 MaxMem(&heapSize);                              // purge and compact the Process Manager Zone.
657                 SetZone(appZone);
658                 DisposeHandle(tempHandle);
659         }
660 }
661
662 #endif