Merge branch 'master' of git://git.ucc.asn.au/tpg/acess2
[tpg/acess2.git] / Kernel / heap.c
index 3f767eb..eefd13c 100644 (file)
@@ -8,6 +8,7 @@
 
 #define WARNINGS       1
 #define        DEBUG_TRACE     0
+#define        VERBOSE_DUMP    0
 
 // === CONSTANTS ===
 #define        HEAP_INIT_SIZE  0x8000  // 32 KiB
 void   Heap_Install(void);
 void   *Heap_Extend(int Bytes);
 void   *Heap_Merge(tHeapHead *Head);
-void   *Heap_Allocate(const char *File, int Line, size_t Bytes);
-void   *Heap_AllocateZero(const char *File, int Line, size_t Bytes);
-void   *Heap_Reallocate(const char *File, int Line, void *Ptr, size_t Bytes);
-void   Heap_Deallocate(void *Ptr);
+//void *Heap_Allocate(const char *File, int Line, size_t Bytes);
+//void *Heap_AllocateZero(const char *File, int Line, size_t Bytes);
+//void *Heap_Reallocate(const char *File, int Line, void *Ptr, size_t Bytes);
+//void Heap_Deallocate(void *Ptr);
 void   Heap_Dump(void);
 void   Heap_Stats(void);
 
 // === GLOBALS ===
-tSpinlock      glHeap;
+tMutex glHeap;
 void   *gHeapStart;
 void   *gHeapEnd;
 
@@ -48,7 +49,6 @@ void Heap_Install(void)
 }
 
 /**
- * \fn void *Heap_Extend(int Bytes)
  * \brief Extend the size of the heap
  */
 void *Heap_Extend(int Bytes)
@@ -61,18 +61,29 @@ void *Heap_Extend(int Bytes)
        if( (tVAddr)gHeapEnd == MM_KHEAP_MAX )
                return NULL;
        
+       if( Bytes == 0 ) {
+               Log_Warning("Heap", "Heap_Extend called with Bytes=%i", Bytes);
+               return NULL;
+       }
+       
        // Bounds Check
        if( (tVAddr)gHeapEnd + ((Bytes+0xFFF)&~0xFFF) > MM_KHEAP_MAX ) {
-               Bytes = MM_KHEAP_MAX - (tVAddr)gHeapEnd;
+//             Bytes = MM_KHEAP_MAX - (tVAddr)gHeapEnd;
                return NULL;
        }
        
        // Heap expands in pages
-       for(i=0;i<(Bytes+0xFFF)>>12;i++)
-               MM_Allocate( (tVAddr)gHeapEnd+(i<<12) );
+       for( i = 0; i < (Bytes+0xFFF) >> 12; i ++ )
+       {
+               if( !MM_Allocate( (tVAddr)gHeapEnd+(i<<12) ) )
+               {
+                       Warning("OOM - Heap_Extend");
+                       return NULL;
+               }
+       }
        
        // Increas heap end
-       gHeapEnd += i << 12;
+       gHeapEnd = (Uint8*)gHeapEnd + (i << 12);
        
        // Create Block
        head->Size = (Bytes+0xFFF)&~0xFFF;
@@ -85,7 +96,6 @@ void *Heap_Extend(int Bytes)
 }
 
 /**
- * \fn void *Heap_Merge(tHeapHead *Head)
  * \brief Merges two ajacent heap blocks
  */
 void *Heap_Merge(tHeapHead *Head)
@@ -130,28 +140,33 @@ void *Heap_Merge(tHeapHead *Head)
 }
 
 /**
- * \brief Allocate memory from the heap
  * \param File Allocating source file
  * \param Line Source line
- * \param Bytes        Size of region to allocate
+ * \param __Bytes      Size of region to allocate
  */
-void *Heap_Allocate(const char *File, int Line, size_t Bytes)
+void *Heap_Allocate(const char *File, int Line, size_t __Bytes)
 {
        tHeapHead       *head, *newhead;
        tHeapFoot       *foot, *newfoot;
        tHeapHead       *best = NULL;
        Uint    bestSize = 0;   // Speed hack
+       size_t  Bytes;
+
+       if( __Bytes == 0 ) {
+               //return NULL;  // TODO: Return a known un-mapped range.
+               return INVLPTR;
+       }
        
        // Get required size
        #if POW2_SIZES
-       Bytes = Bytes + sizeof(tHeapHead) + sizeof(tHeapFoot);
-       Bytes = 1UUL << LOG2(Bytes);
+       Bytes = __Bytes + sizeof(tHeapHead) + sizeof(tHeapFoot);
+       Bytes = 1UUL << LOG2(__Bytes);
        #else
-       Bytes = (Bytes + sizeof(tHeapHead) + sizeof(tHeapFoot) + MIN_SIZE-1) & ~(MIN_SIZE-1);
+       Bytes = (__Bytes + sizeof(tHeapHead) + sizeof(tHeapFoot) + MIN_SIZE-1) & ~(MIN_SIZE-1);
        #endif
        
        // Lock Heap
-       LOCK(&glHeap);
+       Mutex_Acquire(&glHeap);
        
        // Traverse Heap
        for( head = gHeapStart;
@@ -165,7 +180,7 @@ void *Heap_Allocate(const char *File, int Line, size_t Bytes)
                #else
                if( head->Size & (MIN_SIZE-1) ) {
                #endif
-                       RELEASE(&glHeap);       // Release spinlock
+                       Mutex_Release(&glHeap); // Release spinlock
                        #if WARNINGS
                        Log_Warning("Heap", "Size of heap address %p is invalid not aligned (0x%x)", head, head->Size);
                        Heap_Dump();
@@ -177,9 +192,10 @@ void *Heap_Allocate(const char *File, int Line, size_t Bytes)
                if(head->Magic == MAGIC_USED)   continue;
                // Error check
                if(head->Magic != MAGIC_FREE)   {
-                       RELEASE(&glHeap);       // Release spinlock
+                       Mutex_Release(&glHeap); // Release spinlock
                        #if WARNINGS
-                       Log_Warning("Heap", "Magic of heap address %p is invalid (0x%x)", head, head->Magic);
+                       Log_Warning("Heap", "Magic of heap address %p is invalid (%p = 0x%x)",
+                               head, &head->Magic, head->Magic);
                        Heap_Dump();
                        #endif
                        return NULL;
@@ -193,9 +209,12 @@ void *Heap_Allocate(const char *File, int Line, size_t Bytes)
                        head->Magic = MAGIC_USED;
                        head->File = File;
                        head->Line = Line;
-                       RELEASE(&glHeap);       // Release spinlock
+                       head->ValidSize = __Bytes;
+                       head->AllocateTime = now();
+                       Mutex_Release(&glHeap); // Release spinlock
                        #if DEBUG_TRACE
-                       Log("[Heap   ] Malloc'd %p (%i bytes), returning to %p", head->Data, head->Size,  __builtin_return_address(0));
+                       Debug("[Heap   ] Malloc'd %p (%i bytes), returning to %p",
+                               head->Data, head->Size,  __builtin_return_address(0));
                        #endif
                        return head->Data;
                }
@@ -220,7 +239,7 @@ void *Heap_Allocate(const char *File, int Line, size_t Bytes)
                best = Heap_Extend( Bytes );
                // Check for errors
                if(!best) {
-                       RELEASE(&glHeap);       // Release spinlock
+                       Mutex_Release(&glHeap); // Release spinlock
                        return NULL;
                }
                // Check size
@@ -228,9 +247,11 @@ void *Heap_Allocate(const char *File, int Line, size_t Bytes)
                        best->Magic = MAGIC_USED;       // Mark block as used
                        best->File = File;
                        best->Line = Line;
-                       RELEASE(&glHeap);       // Release spinlock
+                       best->ValidSize = __Bytes;
+                       best->AllocateTime = now();
+                       Mutex_Release(&glHeap); // Release spinlock
                        #if DEBUG_TRACE
-                       Log("[Heap   ] Malloc'd %p (%i bytes), returning to %p", best->Data, best->Size, __builtin_return_address(0));
+                       Debug("[Heap   ] Malloc'd %p (%i bytes), returning to %s:%i", best->Data, best->Size, File, Line);
                        #endif
                        return best->Data;
                }
@@ -247,31 +268,34 @@ void *Heap_Allocate(const char *File, int Line, size_t Bytes)
        newhead->Magic = MAGIC_FREE;
        foot->Head = newhead;   // Update backlink in old footer
        best->Size = Bytes;             // Update size in old header
+       best->ValidSize = __Bytes;
        best->Magic = MAGIC_USED;       // Mark block as used
        best->File = File;
        best->Line = Line;
+       best->AllocateTime = now();
        
-       RELEASE(&glHeap);       // Release spinlock
+       Mutex_Release(&glHeap); // Release spinlock
        #if DEBUG_TRACE
-       Log_Debug("Heap", "newhead(%p)->Size = 0x%x", newhead, newhead->Size);
-       Log_Debug("Heap", "Malloc'd %p (0x%x bytes), returning to %s:%i",
+       Debug("[Heap   ] Malloc'd %p (0x%x bytes), returning to %s:%i",
                best->Data, best->Size, File, Line);
        #endif
        return best->Data;
 }
 
 /**
- * \fn void Heap_Deallocate(void *Ptr)
  * \brief Free an allocated memory block
  */
 void Heap_Deallocate(void *Ptr)
 {
-       tHeapHead       *head;
+       tHeapHead       *head = (void*)( (Uint)Ptr - sizeof(tHeapHead) );
        tHeapFoot       *foot;
        
+       // INVLPTR is returned from Heap_Allocate when the allocation
+       // size is zero.
+       if( Ptr == INVLPTR )    return;
+       
        #if DEBUG_TRACE
-       Log_Log("Heap", "free: Ptr = %p", Ptr);
-       Log_Log("Heap", "free: Returns to %p", __builtin_return_address(0));
+       Debug("[Heap   ] free: %p freed by %p (%i old)", Ptr, __builtin_return_address(0), now()-head->AllocateTime);
        #endif
        
        // Alignment Check
@@ -283,8 +307,8 @@ void Heap_Deallocate(void *Ptr)
        // Sanity check
        if((Uint)Ptr < (Uint)gHeapStart || (Uint)Ptr > (Uint)gHeapEnd)
        {
-               Log_Warning("Heap", "free - Passed a non-heap address (%p < %p < %p)\n",
-                       gHeapStart, Ptr, gHeapEnd);
+               Log_Warning("Heap", "free - Passed a non-heap address by %p (%p < %p < %p)\n",
+                       __builtin_return_address(0), gHeapStart, Ptr, gHeapEnd);
                return;
        }
        
@@ -296,7 +320,7 @@ void Heap_Deallocate(void *Ptr)
        }
        if(head->Magic != MAGIC_USED) {
                Log_Warning("Heap", "free - Magic value is invalid (%p, 0x%x)", head, head->Magic);
-               Log_Notice("Heap", "Allocated %s:%i", head->File, head->Line);
+               Log_Notice("Heap", "Allocated by %s:%i", head->File, head->Line);
                return;
        }
        
@@ -304,28 +328,28 @@ void Heap_Deallocate(void *Ptr)
        foot = (void*)( (Uint)head + head->Size - sizeof(tHeapFoot) );
        if(foot->Head != head) {
                Log_Warning("Heap", "free - Footer backlink is incorrect (%p, 0x%x)", head, foot->Head);
-               Log_Notice("Heap", "Allocated %s:%i", head->File, head->Line);
+               Log_Notice("Heap", "Allocated by %s:%i", head->File, head->Line);
                return;
        }
        if(foot->Magic != MAGIC_FOOT) {
                Log_Warning("Heap", "free - Footer magic is invalid (%p, %p = 0x%x)", head, &foot->Magic, foot->Magic);
-               Log_Notice("Heap", "Allocated %s:%i", head->File, head->Line);
+               Log_Notice("Heap", "Allocated by %s:%i", head->File, head->Line);
                return;
        }
        
        // Lock
-       LOCK( &glHeap );
+       Mutex_Acquire( &glHeap );
        
        // Mark as free
        head->Magic = MAGIC_FREE;
-       head->File = NULL;
-       head->Line = 0;
+       //head->File = NULL;
+       //head->Line = 0;
        head->ValidSize = 0;
        // Merge blocks
        Heap_Merge( head );
        
        // Release
-       RELEASE( &glHeap );
+       Mutex_Release( &glHeap );
 }
 
 /**
@@ -337,7 +361,7 @@ void Heap_Deallocate(void *Ptr)
  */
 void *Heap_Reallocate(const char *File, int Line, void *__ptr, size_t __size)
 {
-       tHeapHead       *head = (void*)( (Uint)__ptr-8 );
+       tHeapHead       *head = (void*)( (Uint)__ptr-sizeof(tHeapHead) );
        tHeapHead       *nextHead;
        tHeapFoot       *foot;
        Uint    newSize = (__size + sizeof(tHeapFoot)+sizeof(tHeapHead)+MIN_SIZE-1)&~(MIN_SIZE-1);
@@ -441,18 +465,18 @@ void *Heap_Reallocate(const char *File, int Line, void *__ptr, size_t __size)
 }
 
 /**
- * \fn void *Heap_AllocateZero(const char *File, int Line, size_t size)
+ * \fn void *Heap_AllocateZero(const char *File, int Line, size_t Bytes)
  * \brief Allocate and Zero a buffer in memory
  * \param File Allocating file
  * \param Line Line of allocation
- * \param size Size of the allocation
+ * \param Bytes        Size of the allocation
  */
-void *Heap_AllocateZero(const char *File, int Line, size_t size)
+void *Heap_AllocateZero(const char *File, int Line, size_t Bytes)
 {
-       void    *ret = Heap_Allocate(File, Line, size);
+       void    *ret = Heap_Allocate(File, Line, Bytes);
        if(ret == NULL) return NULL;
        
-       memset( ret, 0, size );
+       memset( ret, 0, Bytes );
        
        return ret;
 }
@@ -475,24 +499,32 @@ int Heap_IsHeapAddr(void *Ptr)
        return 1;
 }
 
+/**
+ */
+void Heap_Validate(void)
+{
+       Heap_Dump();
+}
+
 #if WARNINGS
 void Heap_Dump(void)
 {
        tHeapHead       *head, *badHead;
-       tHeapFoot       *foot;
+       tHeapFoot       *foot = NULL;
        
        head = gHeapStart;
        while( (Uint)head < (Uint)gHeapEnd )
        {               
                foot = (void*)( (Uint)head + head->Size - sizeof(tHeapFoot) );
-               Log_Log("Heap", "%p (0x%llx): 0x%08lx (%i) %4C",
-                       head, MM_GetPhysAddr((Uint)head), head->Size, head->ValidSize, &head->Magic);
+               #if VERBOSE_DUMP
+               Log_Log("Heap", "%p (0x%P): 0x%08x (%i) %4C",
+                       head, MM_GetPhysAddr((tVAddr)head), head->Size, head->ValidSize, &head->Magic);
                Log_Log("Heap", "%p %4C", foot->Head, &foot->Magic);
                if(head->File) {
                        Log_Log("Heap", "%sowned by %s:%i",
                                (head->Magic==MAGIC_FREE?"was ":""), head->File, head->Line);
                }
-               Log_Log("Heap", "");
+               #endif
                
                // Sanity Check Header
                if(head->Size == 0) {
@@ -518,24 +550,44 @@ void Heap_Dump(void)
                        break;
                }
                
+               #if VERBOSE_DUMP
+               Log_Log("Heap", "");
+               #endif
+               
                // All OK? Go to next
                head = foot->NextHead;
        }
        
+       // If the heap is valid, ok!
+       if( (tVAddr)head == (tVAddr)gHeapEnd )
+               return ;
+       
        // Check for a bad return
        if( (tVAddr)head >= (tVAddr)gHeapEnd )
                return ;
+
+       #if !VERBOSE_DUMP
+       Log_Log("Heap", "%p (%P): 0x%08lx %i %4C",
+               head, MM_GetPhysAddr((Uint)head), head->Size, head->ValidSize, &head->Magic);
+       if(foot)
+               Log_Log("Heap", "Foot %p = {Head:%p,Magic:%4C}", foot, foot->Head, &foot->Magic);
+       if(head->File) {
+               Log_Log("Heap", "%sowned by %s:%i",
+                       (head->Magic==MAGIC_FREE?"was ":""), head->File, head->Line);
+       }
+       Log_Log("Heap", "");
+       #endif
        
-       badHead = head;
        
-       Log_Log("Heap", "==== Going Backwards ==== (from %p)", badHead);
+       badHead = head;
        
        // Work backwards
        foot = (void*)( (tVAddr)gHeapEnd - sizeof(tHeapFoot) );
+       Log_Log("Heap", "==== Going Backwards ==== (from %p)", foot);
        head = foot->Head;
        while( (tVAddr)head >= (tVAddr)badHead )
        {
-               Log_Log("Heap", "%p (0x%llx): 0x%08lx %i %4C",
+               Log_Log("Heap", "%p (%P): 0x%08lx %i %4C",
                        head, MM_GetPhysAddr((Uint)head), head->Size, head->ValidSize, &head->Magic);
                Log_Log("Heap", "%p %4C", foot->Head, &foot->Magic);
                if(head->File)
@@ -574,6 +626,8 @@ void Heap_Dump(void)
                head = foot->Head;
                Log_Debug("Heap", "head=%p", head);
        }
+       
+       Panic("Heap_Dump - Heap is corrupted, kernel panic!");
 }
 #endif
 
@@ -612,17 +666,32 @@ void Heap_Stats(void)
                
                // Print the block info?
                #if 1
-               Log_Debug("Heap", "%p - 0x%x Owned by %s:%i",
-                       head, head->Size, head->File, head->Line);
+               if( head->Magic == MAGIC_FREE )
+                       Log_Debug("Heap", "%p (%P) - 0x%x free",
+                               head->Data, MM_GetPhysAddr((tVAddr)&head->Data), head->Size);
+               else
+                       Log_Debug("Heap", "%p (%P) - 0x%x (%i) Owned by %s:%i (%lli ms old)",
+                               head->Data, MM_GetPhysAddr((tVAddr)&head->Data), head->Size, head->ValidSize, head->File, head->Line,
+                               now() - head->AllocateTime
+                               );
                #endif
        }
 
        Log_Log("Heap", "%i blocks (0x%x bytes)", nBlocks, totalBytes);
        Log_Log("Heap", "%i free blocks (0x%x bytes)", nFree, freeBytes);
-       frag = (nFree-1)*10000/nBlocks;
+       if(nBlocks != 0)
+               frag = (nFree-1)*10000/nBlocks;
+       else
+               frag = 0;
        Log_Log("Heap", "%i.%02i%% Heap Fragmentation", frag/100, frag%100);
-       avgAlloc = (totalBytes-freeBytes)/(nBlocks-nFree);
-       overhead = (sizeof(tHeapFoot)+sizeof(tHeapHead))*10000/avgAlloc;
+       if(nBlocks <= nFree)
+               avgAlloc = 0;
+       else
+               avgAlloc = (totalBytes-freeBytes)/(nBlocks-nFree);
+       if(avgAlloc != 0)
+               overhead = (sizeof(tHeapFoot)+sizeof(tHeapHead))*10000/avgAlloc;
+       else
+               overhead = 0;
        Log_Log("Heap", "Average allocation: %i bytes, Average Overhead: %i.%02i%%",
                avgAlloc, overhead/100, overhead%100
                );
@@ -631,6 +700,7 @@ void Heap_Stats(void)
        
        // Scan and get distribution
        #if 1
+       if(nBlocks > 0)
        {
                struct {
                        Uint    Size;

UCC git Repository :: git.ucc.asn.au