]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/Dxe/Mem/Pool.c
MdeModulePkg/DxeCore: switch to MdePkg allocation granularity macros
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Mem / Pool.c
index f99293da5c51a2eb7dd04b565102f02e548658af..5248ee2e6c0221cc2fbd713078b2a4a621c03da0 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   UEFI Memory pool management functions.\r
 \r
-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
 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
@@ -15,6 +15,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "DxeMain.h"\r
 #include "Imem.h"\r
 \r
+STATIC EFI_LOCK mPoolMemoryLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY);\r
+\r
 #define POOL_FREE_SIGNATURE   SIGNATURE_32('p','f','r','0')\r
 typedef struct {\r
   UINT32          Signature;\r
@@ -41,19 +43,24 @@ typedef struct {
   UINTN       Size;\r
 } POOL_TAIL;\r
 \r
-\r
-#define POOL_SHIFT  7\r
-\r
 #define POOL_OVERHEAD (SIZE_OF_POOL_HEAD + sizeof(POOL_TAIL))\r
 \r
 #define HEAD_TO_TAIL(a)   \\r
   ((POOL_TAIL *) (((CHAR8 *) (a)) + (a)->Size - sizeof(POOL_TAIL)));\r
 \r
+//\r
+// Each element is the sum of the 2 previous ones: this allows us to migrate\r
+// blocks between bins by splitting them up, while not wasting too much memory\r
+// as we would in a strict power-of-2 sequence\r
+//\r
+STATIC CONST UINT16 mPoolSizeTable[] = {\r
+  128, 256, 384, 640, 1024, 1664, 2688, 4352, 7040, 11392, 18432, 29824\r
+};\r
 \r
-#define SIZE_TO_LIST(a)   ((a) >> POOL_SHIFT)\r
-#define LIST_TO_SIZE(a)   ((a+1) << POOL_SHIFT)\r
+#define SIZE_TO_LIST(a)   (GetPoolIndexFromSize (a))\r
+#define LIST_TO_SIZE(a)   (mPoolSizeTable [a])\r
 \r
-#define MAX_POOL_LIST       SIZE_TO_LIST(DEFAULT_PAGE_ALLOCATION)\r
+#define MAX_POOL_LIST     (ARRAY_SIZE (mPoolSizeTable))\r
 \r
 #define MAX_POOL_SIZE     (MAX_ADDRESS - POOL_OVERHEAD)\r
 \r
@@ -80,6 +87,29 @@ POOL            mPoolHead[EfiMaxMemoryType];
 //\r
 LIST_ENTRY      mPoolHeadList = INITIALIZE_LIST_HEAD_VARIABLE (mPoolHeadList);\r
 \r
+/**\r
+  Get pool size table index from the specified size.\r
+\r
+  @param  Size          The specified size to get index from pool table.\r
+\r
+  @return               The index of pool size table.\r
+\r
+**/\r
+STATIC\r
+UINTN\r
+GetPoolIndexFromSize (\r
+  UINTN   Size\r
+  )\r
+{\r
+  UINTN   Index;\r
+\r
+  for (Index = 0; Index < MAX_POOL_LIST; Index++) {\r
+    if (mPoolSizeTable [Index] >= Size) {\r
+      return Index;\r
+    }\r
+  }\r
+  return MAX_POOL_LIST;\r
+}\r
 \r
 /**\r
   Called to initialize the pool.\r
@@ -126,10 +156,11 @@ LookupPoolHead (
   }\r
 \r
   //\r
-  // MemoryType values in the range 0x80000000..0xFFFFFFFF are reserved for use by UEFI \r
-  // OS loaders that are provided by operating system vendors\r
+  // MemoryType values in the range 0x80000000..0xFFFFFFFF are reserved for use by UEFI\r
+  // OS loaders that are provided by operating system vendors.\r
+  // MemoryType values in the range 0x70000000..0x7FFFFFFF are reserved for OEM use.\r
   //\r
-  if ((INT32)MemoryType < 0) {\r
+  if ((UINT32) MemoryType >= MEMORY_TYPE_OEM_RESERVED_MIN) {\r
 \r
     for (Link = mPoolHeadList.ForwardLink; Link != &mPoolHeadList; Link = Link->ForwardLink) {\r
       Pool = CR(Link, POOL, Link, POOL_SIGNATURE);\r
@@ -168,7 +199,9 @@ LookupPoolHead (
   @param  Buffer                 The address to return a pointer to the allocated\r
                                  pool\r
 \r
-  @retval EFI_INVALID_PARAMETER  PoolType not valid or Buffer is NULL. \r
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.\r
+                                 PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF.\r
+                                 PoolType is EfiPersistentMemory.\r
   @retval EFI_OUT_OF_RESOURCES   Size exceeds max pool size or allocation failed.\r
   @retval EFI_SUCCESS            Pool successfully allocated.\r
 \r
@@ -186,8 +219,8 @@ CoreInternalAllocatePool (
   //\r
   // If it's not a valid type, fail it\r
   //\r
-  if ((PoolType >= EfiMaxMemoryType && PoolType <= 0x7fffffff) ||\r
-       PoolType == EfiConventionalMemory) {\r
+  if ((PoolType >= EfiMaxMemoryType && PoolType < MEMORY_TYPE_OEM_RESERVED_MIN) ||\r
+       (PoolType == EfiConventionalMemory) || (PoolType == EfiPersistentMemory)) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -208,13 +241,13 @@ CoreInternalAllocatePool (
   //\r
   // Acquire the memory lock and make the allocation\r
   //\r
-  Status = CoreAcquireLockOrFail (&gMemoryLock);\r
+  Status = CoreAcquireLockOrFail (&mPoolMemoryLock);\r
   if (EFI_ERROR (Status)) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
   *Buffer = CoreAllocatePoolI (PoolType, Size);\r
-  CoreReleaseMemoryLock ();\r
+  CoreReleaseLock (&mPoolMemoryLock);\r
   return (*Buffer != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES;\r
 }\r
 \r
@@ -226,7 +259,9 @@ CoreInternalAllocatePool (
   @param  Buffer                 The address to return a pointer to the allocated\r
                                  pool\r
 \r
-  @retval EFI_INVALID_PARAMETER  PoolType not valid or Buffer is NULL. \r
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.\r
+                                 PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF.\r
+                                 PoolType is EfiPersistentMemory.\r
   @retval EFI_OUT_OF_RESOURCES   Size exceeds max pool size or allocation failed.\r
   @retval EFI_SUCCESS            Pool successfully allocated.\r
 \r
@@ -243,11 +278,45 @@ CoreAllocatePool (
 \r
   Status = CoreInternalAllocatePool (PoolType, Size, Buffer);\r
   if (!EFI_ERROR (Status)) {\r
-    CoreUpdateProfile ((EFI_PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS (0), MemoryProfileActionAllocatePool, PoolType, Size, *Buffer);\r
+    CoreUpdateProfile (\r
+      (EFI_PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS (0),\r
+      MemoryProfileActionAllocatePool,\r
+      PoolType,\r
+      Size,\r
+      *Buffer,\r
+      NULL\r
+      );\r
+    InstallMemoryAttributesTableOnMemoryAllocation (PoolType);\r
   }\r
   return Status;\r
 }\r
 \r
+STATIC\r
+VOID *\r
+CoreAllocatePoolPagesI (\r
+  IN EFI_MEMORY_TYPE    PoolType,\r
+  IN UINTN              NoPages,\r
+  IN UINTN              Granularity\r
+  )\r
+{\r
+  VOID        *Buffer;\r
+  EFI_STATUS  Status;\r
+\r
+  Status = CoreAcquireLockOrFail (&gMemoryLock);\r
+  if (EFI_ERROR (Status)) {\r
+    return NULL;\r
+  }\r
+\r
+  Buffer = CoreAllocatePoolPages (PoolType, NoPages, Granularity);\r
+  CoreReleaseMemoryLock ();\r
+\r
+  if (Buffer != NULL) {\r
+    ApplyMemoryProtectionPolicy (EfiConventionalMemory, PoolType,\r
+      (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer, EFI_PAGES_TO_SIZE (NoPages));\r
+  }\r
+  return Buffer;\r
+}\r
+\r
 /**\r
   Internal function to allocate pool of a particular type.\r
   Caller must have the memory lock held\r
@@ -272,20 +341,20 @@ CoreAllocatePoolI (
   VOID        *Buffer;\r
   UINTN       Index;\r
   UINTN       FSize;\r
-  UINTN       Offset;\r
+  UINTN       Offset, MaxOffset;\r
   UINTN       NoPages;\r
   UINTN       Granularity;\r
 \r
-  ASSERT_LOCKED (&gMemoryLock);\r
+  ASSERT_LOCKED (&mPoolMemoryLock);\r
 \r
   if  (PoolType == EfiACPIReclaimMemory   ||\r
        PoolType == EfiACPIMemoryNVS       ||\r
        PoolType == EfiRuntimeServicesCode ||\r
        PoolType == EfiRuntimeServicesData) {\r
 \r
-    Granularity = EFI_ACPI_RUNTIME_PAGE_ALLOCATION_ALIGNMENT;\r
+    Granularity = RUNTIME_PAGE_ALLOCATION_GRANULARITY;\r
   } else {\r
-    Granularity = DEFAULT_PAGE_ALLOCATION;\r
+    Granularity = DEFAULT_PAGE_ALLOCATION_GRANULARITY;\r
   }\r
 \r
   //\r
@@ -311,10 +380,10 @@ CoreAllocatePoolI (
   // If allocation is over max size, just allocate pages for the request\r
   // (slow)\r
   //\r
-  if (Index >= MAX_POOL_LIST) {\r
+  if (Index >= SIZE_TO_LIST (Granularity)) {\r
     NoPages = EFI_SIZE_TO_PAGES(Size) + EFI_SIZE_TO_PAGES (Granularity) - 1;\r
     NoPages &= ~(UINTN)(EFI_SIZE_TO_PAGES (Granularity) - 1);\r
-    Head = CoreAllocatePoolPages (PoolType, NoPages, Granularity);\r
+    Head = CoreAllocatePoolPagesI (PoolType, NoPages, Granularity);\r
     goto Done;\r
   }\r
 \r
@@ -323,35 +392,56 @@ CoreAllocatePoolI (
   //\r
   if (IsListEmpty (&Pool->FreeList[Index])) {\r
 \r
+    Offset = LIST_TO_SIZE (Index);\r
+    MaxOffset = Granularity;\r
+\r
+    //\r
+    // Check the bins holding larger blocks, and carve one up if needed\r
+    //\r
+    while (++Index < SIZE_TO_LIST (Granularity)) {\r
+      if (!IsListEmpty (&Pool->FreeList[Index])) {\r
+        Free = CR (Pool->FreeList[Index].ForwardLink, POOL_FREE, Link, POOL_FREE_SIGNATURE);\r
+        RemoveEntryList (&Free->Link);\r
+        NewPage = (VOID *) Free;\r
+        MaxOffset = LIST_TO_SIZE (Index);\r
+        goto Carve;\r
+      }\r
+    }\r
+\r
     //\r
     // Get another page\r
     //\r
-    NewPage = CoreAllocatePoolPages(PoolType, EFI_SIZE_TO_PAGES (Granularity), Granularity);\r
+    NewPage = CoreAllocatePoolPages(PoolType, EFI_SIZE_TO_PAGES (Granularity), Granularity);\r
     if (NewPage == NULL) {\r
       goto Done;\r
     }\r
 \r
     //\r
-    // Carve up new page into free pool blocks\r
+    // Serve the allocation request from the head of the allocated block\r
+    //\r
+Carve:\r
+    Head = (POOL_HEAD *) NewPage;\r
+\r
     //\r
-    Offset = 0;\r
-    while (Offset < Granularity) {\r
+    // Carve up remaining space into free pool blocks\r
+    //\r
+    Index--;\r
+    while (Offset < MaxOffset) {\r
       ASSERT (Index < MAX_POOL_LIST);\r
       FSize = LIST_TO_SIZE(Index);\r
 \r
-      while (Offset + FSize <= Granularity) {\r
+      while (Offset + FSize <= MaxOffset) {\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
         Offset += FSize;\r
       }\r
-\r
       Index -= 1;\r
     }\r
 \r
-    ASSERT (Offset == Granularity);\r
-    Index = SIZE_TO_LIST(Size);\r
+    ASSERT (Offset == MaxOffset);\r
+    goto Done;\r
   }\r
 \r
   //\r
@@ -405,6 +495,7 @@ Done:
   Frees pool.\r
 \r
   @param  Buffer                 The allocated pool entry to free\r
+  @param  PoolType               Pointer to pool type\r
 \r
   @retval EFI_INVALID_PARAMETER  Buffer is not a valid value.\r
   @retval EFI_SUCCESS            Pool successfully freed.\r
@@ -413,7 +504,8 @@ Done:
 EFI_STATUS\r
 EFIAPI\r
 CoreInternalFreePool (\r
-  IN VOID        *Buffer\r
+  IN VOID               *Buffer,\r
+  OUT EFI_MEMORY_TYPE   *PoolType OPTIONAL\r
   )\r
 {\r
   EFI_STATUS Status;\r
@@ -422,9 +514,9 @@ CoreInternalFreePool (
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  CoreAcquireMemoryLock ();\r
-  Status = CoreFreePoolI (Buffer);\r
-  CoreReleaseMemoryLock ();\r
+  CoreAcquireLock (&mPoolMemoryLock);\r
+  Status = CoreFreePoolI (Buffer, PoolType);\r
+  CoreReleaseLock (&mPoolMemoryLock);\r
   return Status;\r
 }\r
 \r
@@ -443,20 +535,46 @@ CoreFreePool (
   IN VOID  *Buffer\r
   )\r
 {\r
-  EFI_STATUS  Status;\r
+  EFI_STATUS        Status;\r
+  EFI_MEMORY_TYPE   PoolType;\r
 \r
-  Status = CoreInternalFreePool (Buffer);\r
+  Status = CoreInternalFreePool (Buffer, &PoolType);\r
   if (!EFI_ERROR (Status)) {\r
-    CoreUpdateProfile ((EFI_PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS (0), MemoryProfileActionFreePool, (EFI_MEMORY_TYPE) 0, 0, Buffer);\r
+    CoreUpdateProfile (\r
+      (EFI_PHYSICAL_ADDRESS) (UINTN) RETURN_ADDRESS (0),\r
+      MemoryProfileActionFreePool,\r
+      PoolType,\r
+      0,\r
+      Buffer,\r
+      NULL\r
+      );\r
+    InstallMemoryAttributesTableOnMemoryAllocation (PoolType);\r
   }\r
   return Status;\r
 }\r
 \r
+STATIC\r
+VOID\r
+CoreFreePoolPagesI (\r
+  IN EFI_MEMORY_TYPE        PoolType,\r
+  IN EFI_PHYSICAL_ADDRESS   Memory,\r
+  IN UINTN                  NoPages\r
+  )\r
+{\r
+  CoreAcquireMemoryLock ();\r
+  CoreFreePoolPages (Memory, NoPages);\r
+  CoreReleaseMemoryLock ();\r
+\r
+  ApplyMemoryProtectionPolicy (PoolType, EfiConventionalMemory,\r
+    (EFI_PHYSICAL_ADDRESS)(UINTN)Memory, EFI_PAGES_TO_SIZE (NoPages));\r
+}\r
+\r
 /**\r
   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  PoolType               Pointer to pool type\r
 \r
   @retval EFI_INVALID_PARAMETER  Buffer not valid\r
   @retval EFI_SUCCESS            Buffer successfully freed.\r
@@ -464,7 +582,8 @@ CoreFreePool (
 **/\r
 EFI_STATUS\r
 CoreFreePoolI (\r
-  IN VOID       *Buffer\r
+  IN VOID               *Buffer,\r
+  OUT EFI_MEMORY_TYPE   *PoolType OPTIONAL\r
   )\r
 {\r
   POOL        *Pool;\r
@@ -475,7 +594,6 @@ CoreFreePoolI (
   UINTN       NoPages;\r
   UINTN       Size;\r
   CHAR8       *NewPage;\r
-  UINTN       FSize;\r
   UINTN       Offset;\r
   BOOLEAN     AllFree;\r
   UINTN       Granularity;\r
@@ -499,7 +617,7 @@ CoreFreePoolI (
   //\r
   ASSERT (Tail->Signature == POOL_TAIL_SIGNATURE);\r
   ASSERT (Head->Size == Tail->Size);\r
-  ASSERT_LOCKED (&gMemoryLock);\r
+  ASSERT_LOCKED (&mPoolMemoryLock);\r
 \r
   if (Tail->Signature != POOL_TAIL_SIGNATURE) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -525,9 +643,13 @@ CoreFreePoolI (
        Head->Type == EfiRuntimeServicesCode ||\r
        Head->Type == EfiRuntimeServicesData) {\r
 \r
-    Granularity = EFI_ACPI_RUNTIME_PAGE_ALLOCATION_ALIGNMENT;\r
+    Granularity = RUNTIME_PAGE_ALLOCATION_GRANULARITY;\r
   } else {\r
-    Granularity = DEFAULT_PAGE_ALLOCATION;\r
+    Granularity = DEFAULT_PAGE_ALLOCATION_GRANULARITY;\r
+  }\r
+\r
+  if (PoolType != NULL) {\r
+    *PoolType = Head->Type;\r
   }\r
 \r
   //\r
@@ -539,14 +661,14 @@ CoreFreePoolI (
   //\r
   // If it's not on the list, it must be pool pages\r
   //\r
-  if (Index >= MAX_POOL_LIST) {\r
+  if (Index >= SIZE_TO_LIST (Granularity)) {\r
 \r
     //\r
     // Return the memory pages back to free memory\r
     //\r
     NoPages = EFI_SIZE_TO_PAGES(Size) + EFI_SIZE_TO_PAGES (Granularity) - 1;\r
     NoPages &= ~(UINTN)(EFI_SIZE_TO_PAGES (Granularity) - 1);\r
-    CoreFreePoolPages ((EFI_PHYSICAL_ADDRESS) (UINTN) Head, NoPages);\r
+    CoreFreePoolPagesI (Pool->MemoryType, (EFI_PHYSICAL_ADDRESS) (UINTN) Head, NoPages);\r
 \r
   } else {\r
 \r
@@ -569,22 +691,16 @@ CoreFreePoolI (
 \r
     if (Free->Signature == POOL_FREE_SIGNATURE) {\r
 \r
-      Index = Free->Index;\r
-\r
       AllFree = TRUE;\r
       Offset = 0;\r
 \r
       while ((Offset < Granularity) && (AllFree)) {\r
-        FSize = LIST_TO_SIZE(Index);\r
-        while (Offset + FSize <= Granularity) {\r
-          Free = (POOL_FREE *) &NewPage[Offset];\r
-          ASSERT(Free != NULL);\r
-          if (Free->Signature != POOL_FREE_SIGNATURE) {\r
-            AllFree = FALSE;\r
-          }\r
-          Offset += FSize;\r
+        Free = (POOL_FREE *) &NewPage[Offset];\r
+        ASSERT(Free != NULL);\r
+        if (Free->Signature != POOL_FREE_SIGNATURE) {\r
+          AllFree = FALSE;\r
         }\r
-        Index -= 1;\r
+        Offset += LIST_TO_SIZE(Free->Index);\r
       }\r
 \r
       if (AllFree) {\r
@@ -596,36 +712,32 @@ CoreFreePoolI (
         //\r
         Free = (POOL_FREE *) &NewPage[0];\r
         ASSERT(Free != NULL);\r
-        Index = Free->Index;\r
         Offset = 0;\r
 \r
         while (Offset < Granularity) {\r
-          FSize = LIST_TO_SIZE(Index);\r
-          while (Offset + FSize <= Granularity) {\r
-            Free = (POOL_FREE *) &NewPage[Offset];\r
-            ASSERT(Free != NULL);\r
-            RemoveEntryList (&Free->Link);\r
-            Offset += FSize;\r
-          }\r
-          Index -= 1;\r
+          Free = (POOL_FREE *) &NewPage[Offset];\r
+          ASSERT(Free != NULL);\r
+          RemoveEntryList (&Free->Link);\r
+          Offset += LIST_TO_SIZE(Free->Index);\r
         }\r
 \r
         //\r
         // Free the page\r
         //\r
-        CoreFreePoolPages ((EFI_PHYSICAL_ADDRESS) (UINTN)NewPage, EFI_SIZE_TO_PAGES (Granularity));\r
+        CoreFreePoolPagesI (Pool->MemoryType, (EFI_PHYSICAL_ADDRESS) (UINTN)NewPage,\r
+          EFI_SIZE_TO_PAGES (Granularity));\r
       }\r
     }\r
   }\r
 \r
   //\r
-  // If this is an OS specific memory type, then check to see if the last\r
+  // If this is an OS/OEM 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
-  if ((INT32)Pool->MemoryType < 0 && Pool->Used == 0) {\r
+  if (((UINT32) Pool->MemoryType >= MEMORY_TYPE_OEM_RESERVED_MIN) && Pool->Used == 0) {\r
     RemoveEntryList (&Pool->Link);\r
-    CoreFreePoolI (Pool);\r
+    CoreFreePoolI (Pool, NULL);\r
   }\r
 \r
   return EFI_SUCCESS;\r