]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/Dxe/Mem/Pool.c
Clean up DxeCore to remove duplicate memory allocation & device path utility services...
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Mem / Pool.c
index 1adaa1f26970536ae97381617165b5b852112283..0691c4aba5869da76c99958eb4073f382cc05c63 100644 (file)
@@ -1,19 +1,18 @@
-/** @file \r
-\r
+/** @file\r
   UEFI Memory pool management functions.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-All rights reserved. This program and the accompanying materials                          \r
-are licensed and made available under the terms and conditions of the BSD License         \r
-which accompanies this distribution.  The full text of the license may be found at        \r
-http://opensource.org/licenses/bsd-license.php                                            \r
-                                                                                          \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
-#include <DxeMain.h>\r
+#include "DxeMain.h"\r
 \r
 #define POOL_FREE_SIGNATURE   EFI_SIGNATURE_32('p','f','r','0')\r
 typedef struct {\r
@@ -67,15 +66,17 @@ typedef struct {
     EFI_MEMORY_TYPE  MemoryType;\r
     LIST_ENTRY       FreeList[MAX_POOL_LIST];\r
     LIST_ENTRY       Link;\r
-} POOL; \r
-\r
-\r
-POOL            PoolHead[EfiMaxMemoryType];\r
-LIST_ENTRY      PoolHeadList;\r
+} POOL;\r
 \r
 //\r
+// Pool header for each memory type.\r
 //\r
+POOL            mPoolHead[EfiMaxMemoryType];\r
+\r
+//\r
+// List of pool header to search for the appropriate memory type.\r
 //\r
+LIST_ENTRY      mPoolHeadList;\r
 \r
 \r
 /**\r
@@ -91,26 +92,25 @@ CoreInitializePool (
   UINTN  Index;\r
 \r
   for (Type=0; Type < EfiMaxMemoryType; Type++) {\r
-    PoolHead[Type].Signature  = 0;\r
-    PoolHead[Type].Used       = 0;\r
-    PoolHead[Type].MemoryType = (EFI_MEMORY_TYPE) Type;\r
+    mPoolHead[Type].Signature  = 0;\r
+    mPoolHead[Type].Used       = 0;\r
+    mPoolHead[Type].MemoryType = (EFI_MEMORY_TYPE) Type;\r
     for (Index=0; Index < MAX_POOL_LIST; Index++) {\r
-        InitializeListHead (&PoolHead[Type].FreeList[Index]);\r
+        InitializeListHead (&mPoolHead[Type].FreeList[Index]);\r
     }\r
   }\r
-  InitializeListHead (&PoolHeadList);\r
+  InitializeListHead (&mPoolHeadList);\r
 }\r
 \r
 \r
 /**\r
   Look up pool head for specified memory type.\r
 \r
-  @param  MemoryType             Memory type of which pool head is looked for \r
+  @param  MemoryType             Memory type of which pool head is looked for\r
 \r
   @return Pointer of Corresponding pool head.\r
 \r
 **/\r
-STATIC\r
 POOL *\r
 LookupPoolHead (\r
   IN EFI_MEMORY_TYPE  MemoryType\r
@@ -121,12 +121,12 @@ LookupPoolHead (
   UINTN           Index;\r
 \r
   if (MemoryType >= 0 && MemoryType < EfiMaxMemoryType) {\r
-    return &PoolHead[MemoryType];\r
+    return &mPoolHead[MemoryType];\r
   }\r
 \r
   if (MemoryType < 0) {\r
 \r
-    for (Link = PoolHeadList.ForwardLink; Link != &PoolHeadList; Link = Link->ForwardLink) {\r
+    for (Link = mPoolHeadList.ForwardLink; Link != &mPoolHeadList; Link = Link->ForwardLink) {\r
       Pool = CR(Link, POOL, Link, POOL_SIGNATURE);\r
       if (Pool->MemoryType == MemoryType) {\r
         return Pool;\r
@@ -145,7 +145,7 @@ LookupPoolHead (
       InitializeListHead (&Pool->FreeList[Index]);\r
     }\r
 \r
-    InsertHeadList (&PoolHeadList, &Pool->Link);\r
+    InsertHeadList (&mPoolHeadList, &Pool->Link);\r
 \r
     return Pool;\r
   }\r
@@ -153,19 +153,18 @@ LookupPoolHead (
   return NULL;\r
 }\r
 \r
\r
 \r
 \r
 /**\r
   Allocate pool of a particular type.\r
 \r
-  @param  PoolType               Type of pool to allocate \r
-  @param  Size                   The amount of pool to allocate \r
-  @param  Buffer                 The address to return a pointer to the allocated \r
-                                 pool \r
+  @param  PoolType               Type of pool to allocate\r
+  @param  Size                   The amount of pool to allocate\r
+  @param  Buffer                 The address to return a pointer to the allocated\r
+                                 pool\r
 \r
-  @retval EFI_INVALID_PARAMETER  PoolType not valid \r
-  @retval EFI_OUT_OF_RESOURCES   Size exceeds max pool size or allocation failed. \r
+  @retval EFI_INVALID_PARAMETER  PoolType not valid\r
+  @retval EFI_OUT_OF_RESOURCES   Size exceeds max pool size or allocation failed.\r
   @retval EFI_SUCCESS            Pool successfully allocated.\r
 \r
 **/\r
@@ -186,9 +185,9 @@ CoreAllocatePool (
        PoolType == EfiConventionalMemory) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
-  \r
+\r
   *Buffer = NULL;\r
-  \r
+\r
   //\r
   // If size is too large, fail it\r
   // Base on the EFI spec, return status of EFI_OUT_OF_RESOURCES\r
@@ -216,8 +215,8 @@ CoreAllocatePool (
   Internal function to allocate pool of a particular type.\r
   Caller must have the memory lock held\r
 \r
-  @param  PoolType               Type of pool to allocate \r
-  @param  Size                   The amount of pool to allocate \r
+  @param  PoolType               Type of pool to allocate\r
+  @param  Size                   The amount of pool to allocate\r
 \r
   @return The allocate pool, or NULL\r
 \r
@@ -245,7 +244,7 @@ CoreAllocatePoolI (
   //\r
   // Adjust the size by the pool header & tail overhead\r
   //\r
-  \r
+\r
   //\r
   // Adjusting the Size to be of proper alignment so that\r
   // we don't get an unaligned access fault later when\r
@@ -294,7 +293,7 @@ CoreAllocatePoolI (
       FSize = LIST_TO_SIZE(Index);\r
 \r
       while (Offset + FSize <= DEFAULT_PAGE_ALLOCATION) {\r
-        Free = (POOL_FREE *) &NewPage[Offset];          \r
+        Free = (POOL_FREE *) &NewPage[Offset];\r
         Free->Signature = POOL_FREE_SIGNATURE;\r
         Free->Index     = (UINT32)Index;\r
         InsertHeadList (&Pool->FreeList[Index], &Free->Link);\r
@@ -320,7 +319,7 @@ Done:
   Buffer = NULL;\r
 \r
   if (Head != NULL) {\r
-    \r
+\r
     //\r
     // If we have a pool buffer, fill in the header & tail info\r
     //\r
@@ -333,14 +332,13 @@ Done:
     Buffer          = Head->Data;\r
     DEBUG_CLEAR_MEMORY (Buffer, Size - POOL_OVERHEAD);\r
 \r
-    DEBUG (\r
-      (DEBUG_POOL,\r
-      "AllocatePoolI: Type %x, Addr %x (len %x) %,d\n",\r
-       PoolType, \r
-       Buffer, \r
-       Size - POOL_OVERHEAD, \r
-      Pool->Used)\r
-      );\r
+    DEBUG ((\r
+      DEBUG_POOL,\r
+      "AllocatePoolI: Type %x, Addr %x (len %x) %,d\n", PoolType,\r
+      Buffer,\r
+      Size - POOL_OVERHEAD,\r
+      Pool->Used\r
+      ));\r
 \r
     //\r
     // Account the allocation\r
@@ -353,16 +351,15 @@ Done:
 \r
   return Buffer;\r
 }\r
-  \r
 \r
 \r
 \r
 /**\r
   Frees pool.\r
 \r
-  @param  Buffer                 The allocated pool entry to free \r
+  @param  Buffer                 The allocated pool entry to free\r
 \r
-  @retval EFI_INVALID_PARAMETER  Buffer is not a valid value. \r
+  @retval EFI_INVALID_PARAMETER  Buffer is not a valid value.\r
   @retval EFI_SUCCESS            Pool successfully freed.\r
 \r
 **/\r
@@ -374,7 +371,7 @@ CoreFreePool (
 {\r
   EFI_STATUS Status;\r
 \r
-  if (NULL == Buffer) {\r
+  if (Buffer == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -390,9 +387,9 @@ CoreFreePool (
   Internal function to free a pool entry.\r
   Caller must have the memory lock held\r
 \r
-  @param  Buffer                 The allocated pool entry to free \r
+  @param  Buffer                 The allocated pool entry to free\r
 \r
-  @retval EFI_INVALID_PARAMETER  Buffer not valid \r
+  @retval EFI_INVALID_PARAMETER  Buffer not valid\r
   @retval EFI_SUCCESS            Buffer successfully freed.\r
 \r
 **/\r
@@ -454,7 +451,7 @@ CoreFreePoolI (
   DEBUG ((DEBUG_POOL, "FreePool: %x (len %x) %,d\n", Head->Data, Head->Size - POOL_OVERHEAD, Pool->Used));\r
 \r
   //\r
-  // Determine the pool list \r
+  // Determine the pool list\r
   //\r
   Index = SIZE_TO_LIST(Size);\r
   DEBUG_CLEAR_MEMORY (Head, Size);\r
@@ -483,12 +480,12 @@ CoreFreePoolI (
     InsertHeadList (&Pool->FreeList[Index], &Free->Link);\r
 \r
     //\r
-    // See if all the pool entries in the same page as Free are freed pool \r
+    // See if all the pool entries in the same page as Free are freed pool\r
     // entries\r
     //\r
     NewPage = (CHAR8 *)((UINTN)Free & ~((DEFAULT_PAGE_ALLOCATION) -1));\r
     Free = (POOL_FREE *) &NewPage[0];\r
-    ASSERT(NULL != Free);\r
+    ASSERT(Free != NULL);\r
 \r
     if (Free->Signature == POOL_FREE_SIGNATURE) {\r
 \r
@@ -496,7 +493,7 @@ CoreFreePoolI (
 \r
       AllFree = TRUE;\r
       Offset = 0;\r
-      \r
+\r
       while ((Offset < DEFAULT_PAGE_ALLOCATION) && (AllFree)) {\r
         FSize = LIST_TO_SIZE(Index);\r
         while (Offset + FSize <= DEFAULT_PAGE_ALLOCATION) {\r
@@ -513,7 +510,7 @@ CoreFreePoolI (
       if (AllFree) {\r
 \r
         //\r
-        // All of the pool entries in the same page as Free are free pool \r
+        // All of the pool entries in the same page as Free are free pool\r
         // entries\r
         // Remove all of these pool entries from the free loop lists.\r
         //\r
@@ -521,7 +518,7 @@ CoreFreePoolI (
         ASSERT(NULL != Free);\r
         Index = Free->Index;\r
         Offset = 0;\r
-        \r
+\r
         while (Offset < DEFAULT_PAGE_ALLOCATION) {\r
           FSize = LIST_TO_SIZE(Index);\r
           while (Offset + FSize <= DEFAULT_PAGE_ALLOCATION) {\r
@@ -542,7 +539,7 @@ CoreFreePoolI (
   }\r
 \r
   //\r
-  // If this is an OS specific memory type, then check to see if the last \r
+  // If this is an OS specific memory type, then check to see if the last\r
   // portion of that memory type has been freed.  If it has, then free the\r
   // list entry for that memory type\r
   //\r