| e386b444 |
1 | /** @file\r |
| 2 | Support routines for memory allocation routines for use with drivers.\r |
| 3 | \r |
| 4 | Copyright (c) 2006, Intel Corporation<BR>\r |
| 5 | All rights reserved. This program and the accompanying materials \r |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r |
| 7 | which accompanies this distribution. The full text of the license may be found at \r |
| 8 | http://opensource.org/licenses/bsd-license.php \r |
| 9 | \r |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
| 12 | \r |
| e386b444 |
13 | **/\r |
| 14 | \r |
| c892d846 |
15 | \r |
| c7d265a9 |
16 | #include <PiDxe.h>\r |
| c892d846 |
17 | \r |
| 18 | \r |
| c7d265a9 |
19 | #include <Library/MemoryAllocationLib.h>\r |
| 20 | #include <Library/UefiBootServicesTableLib.h>\r |
| 21 | #include <Library/BaseMemoryLib.h>\r |
| 22 | #include <Library/DebugLib.h>\r |
| e386b444 |
23 | \r |
| e386b444 |
24 | /**\r |
| 25 | Allocates one or more 4KB pages of a certain memory type.\r |
| 26 | \r |
| 27 | Allocates the number of 4KB pages of a certain memory type and returns a pointer to the allocated\r |
| 28 | buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned.\r |
| 29 | If there is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 30 | \r |
| 31 | @param MemoryType The type of memory to allocate.\r |
| 32 | @param Pages The number of 4 KB pages to allocate.\r |
| 33 | \r |
| 34 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 35 | \r |
| 36 | **/\r |
| 37 | VOID *\r |
| 38 | InternalAllocatePages (\r |
| 39 | IN EFI_MEMORY_TYPE MemoryType, \r |
| 40 | IN UINTN Pages\r |
| 41 | )\r |
| 42 | {\r |
| 43 | EFI_STATUS Status;\r |
| 44 | EFI_PHYSICAL_ADDRESS Memory; \r |
| 45 | \r |
| 46 | if (Pages == 0) {\r |
| 47 | return NULL;\r |
| 48 | }\r |
| 49 | \r |
| 50 | Status = gBS->AllocatePages (AllocateAnyPages, MemoryType, Pages, &Memory);\r |
| 51 | if (EFI_ERROR (Status)) {\r |
| 52 | Memory = 0;\r |
| 53 | }\r |
| 54 | return (VOID *) (UINTN) Memory;\r |
| 55 | }\r |
| 56 | \r |
| 57 | /**\r |
| 58 | Allocates one or more 4KB pages of type EfiBootServicesData.\r |
| 59 | \r |
| 60 | Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the\r |
| 61 | allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r |
| 62 | is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r |
| 63 | returned.\r |
| 64 | \r |
| 65 | @param Pages The number of 4 KB pages to allocate.\r |
| 66 | \r |
| 67 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 68 | \r |
| 69 | **/\r |
| 70 | VOID *\r |
| 71 | EFIAPI\r |
| 72 | AllocatePages (\r |
| 73 | IN UINTN Pages\r |
| 74 | )\r |
| 75 | {\r |
| 76 | return InternalAllocatePages (EfiBootServicesData, Pages);\r |
| 77 | }\r |
| 78 | \r |
| 79 | /**\r |
| 80 | Allocates one or more 4KB pages of type EfiRuntimeServicesData.\r |
| 81 | \r |
| 82 | Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the\r |
| 83 | allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r |
| 84 | is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r |
| 85 | returned.\r |
| 86 | \r |
| 87 | @param Pages The number of 4 KB pages to allocate.\r |
| 88 | \r |
| 89 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 90 | \r |
| 91 | **/\r |
| 92 | VOID *\r |
| 93 | EFIAPI\r |
| 94 | AllocateRuntimePages (\r |
| 95 | IN UINTN Pages\r |
| 96 | )\r |
| 97 | {\r |
| 98 | return InternalAllocatePages (EfiRuntimeServicesData, Pages);\r |
| 99 | }\r |
| 100 | \r |
| 101 | /**\r |
| 102 | Allocates one or more 4KB pages of type EfiReservedMemoryType.\r |
| 103 | \r |
| 104 | Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the\r |
| 105 | allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r |
| 106 | is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r |
| 107 | returned.\r |
| 108 | \r |
| 109 | @param Pages The number of 4 KB pages to allocate.\r |
| 110 | \r |
| 111 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 112 | \r |
| 113 | **/\r |
| 114 | VOID *\r |
| 115 | EFIAPI\r |
| 116 | AllocateReservedPages (\r |
| 117 | IN UINTN Pages\r |
| 118 | )\r |
| 119 | {\r |
| 120 | return InternalAllocatePages (EfiReservedMemoryType, Pages);\r |
| 121 | }\r |
| 122 | \r |
| 123 | /**\r |
| 124 | Frees one or more 4KB pages that were previously allocated with one of the page allocation\r |
| 125 | functions in the Memory Allocation Library.\r |
| 126 | \r |
| 127 | Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer\r |
| 128 | must have been allocated on a previous call to the page allocation services of the Memory\r |
| 129 | Allocation Library.\r |
| 130 | If Buffer was not allocated with a page allocation function in the Memory Allocation Library,\r |
| 131 | then ASSERT().\r |
| 132 | If Pages is zero, then ASSERT().\r |
| 133 | \r |
| 134 | @param Buffer Pointer to the buffer of pages to free.\r |
| 135 | @param Pages The number of 4 KB pages to free.\r |
| 136 | \r |
| 137 | **/\r |
| 138 | VOID\r |
| 139 | EFIAPI\r |
| 140 | FreePages (\r |
| 141 | IN VOID *Buffer,\r |
| 142 | IN UINTN Pages\r |
| 143 | )\r |
| 144 | {\r |
| 145 | EFI_STATUS Status;\r |
| 146 | \r |
| 147 | ASSERT (Pages != 0);\r |
| 148 | Status = gBS->FreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer, Pages);\r |
| 149 | ASSERT_EFI_ERROR (Status);\r |
| 150 | }\r |
| 151 | \r |
| 152 | /**\r |
| 153 | Allocates one or more 4KB pages of a certain memory type at a specified alignment.\r |
| 154 | \r |
| 155 | Allocates the number of 4KB pages specified by Pages of a certain memory type with an alignment\r |
| 156 | specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned.\r |
| 157 | If there is not enough memory at the specified alignment remaining to satisfy the request, then\r |
| 158 | NULL is returned.\r |
| 159 | If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r |
| 160 | \r |
| 161 | @param MemoryType The type of memory to allocate.\r |
| 162 | @param Pages The number of 4 KB pages to allocate.\r |
| 163 | @param Alignment The requested alignment of the allocation. Must be a power of two.\r |
| 164 | If Alignment is zero, then byte alignment is used.\r |
| 165 | \r |
| 166 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 167 | \r |
| 168 | **/\r |
| 169 | VOID *\r |
| 170 | InternalAllocateAlignedPages (\r |
| 171 | IN EFI_MEMORY_TYPE MemoryType, \r |
| 172 | IN UINTN Pages,\r |
| 173 | IN UINTN Alignment\r |
| 174 | )\r |
| 175 | {\r |
| 176 | EFI_STATUS Status;\r |
| 177 | EFI_PHYSICAL_ADDRESS Memory;\r |
| 178 | UINTN AlignedMemory;\r |
| 179 | UINTN AlignmentMask;\r |
| 180 | UINTN UnalignedPages;\r |
| 181 | UINTN RealPages;\r |
| 182 | \r |
| 183 | //\r |
| 184 | // Alignment must be a power of two or zero.\r |
| 185 | //\r |
| 186 | ASSERT ((Alignment & (Alignment - 1)) == 0);\r |
| 187 | \r |
| 188 | if (Pages == 0) {\r |
| 189 | return NULL;\r |
| 190 | }\r |
| 191 | if (Alignment > EFI_PAGE_SIZE) {\r |
| 192 | //\r |
| 193 | // Caculate the total number of pages since alignment is larger than page size.\r |
| 194 | //\r |
| 195 | AlignmentMask = Alignment - 1;\r |
| 196 | RealPages = Pages + EFI_SIZE_TO_PAGES (Alignment);\r |
| 197 | //\r |
| 198 | // Make sure that Pages plus EFI_SIZE_TO_PAGES (Alignment) does not overflow.\r |
| 199 | //\r |
| 200 | ASSERT (RealPages > Pages);\r |
| 201 | \r |
| 202 | Status = gBS->AllocatePages (AllocateAnyPages, MemoryType, RealPages, &Memory);\r |
| 203 | if (EFI_ERROR (Status)) {\r |
| 204 | return NULL;\r |
| 205 | }\r |
| 206 | AlignedMemory = ((UINTN) Memory + AlignmentMask) & ~AlignmentMask;\r |
| e111752c |
207 | UnalignedPages = EFI_SIZE_TO_PAGES (AlignedMemory - (UINTN) Memory);\r |
| e386b444 |
208 | if (UnalignedPages > 0) {\r |
| 209 | //\r |
| 210 | // Free first unaligned page(s).\r |
| 211 | //\r |
| 212 | Status = gBS->FreePages (Memory, UnalignedPages);\r |
| 213 | ASSERT_EFI_ERROR (Status);\r |
| 214 | }\r |
| 215 | Memory = (EFI_PHYSICAL_ADDRESS) (AlignedMemory + EFI_PAGES_TO_SIZE (Pages));\r |
| 216 | UnalignedPages = RealPages - Pages - UnalignedPages;\r |
| 217 | if (UnalignedPages > 0) {\r |
| 218 | //\r |
| 219 | // Free last unaligned page(s).\r |
| 220 | //\r |
| 221 | Status = gBS->FreePages (Memory, UnalignedPages);\r |
| 222 | ASSERT_EFI_ERROR (Status);\r |
| 223 | }\r |
| 224 | } else {\r |
| 225 | //\r |
| 226 | // Do not over-allocate pages in this case.\r |
| 227 | //\r |
| 228 | Status = gBS->AllocatePages (AllocateAnyPages, MemoryType, Pages, &Memory);\r |
| 229 | if (EFI_ERROR (Status)) {\r |
| 230 | return NULL;\r |
| 231 | }\r |
| 232 | AlignedMemory = (UINTN) Memory;\r |
| 233 | }\r |
| 234 | return (VOID *) AlignedMemory;\r |
| 235 | }\r |
| 236 | \r |
| 237 | /**\r |
| 238 | Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.\r |
| 239 | \r |
| 240 | Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an\r |
| 241 | alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is\r |
| 242 | returned. If there is not enough memory at the specified alignment remaining to satisfy the\r |
| 243 | request, then NULL is returned.\r |
| 244 | If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r |
| 245 | \r |
| 246 | @param Pages The number of 4 KB pages to allocate.\r |
| 247 | @param Alignment The requested alignment of the allocation. Must be a power of two.\r |
| 248 | If Alignment is zero, then byte alignment is used.\r |
| 249 | \r |
| 250 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 251 | \r |
| 252 | **/\r |
| 253 | VOID *\r |
| 254 | EFIAPI\r |
| 255 | AllocateAlignedPages (\r |
| 256 | IN UINTN Pages,\r |
| 257 | IN UINTN Alignment\r |
| 258 | )\r |
| 259 | {\r |
| 260 | return InternalAllocateAlignedPages (EfiBootServicesData, Pages, Alignment);\r |
| 261 | }\r |
| 262 | \r |
| 263 | /**\r |
| 264 | Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.\r |
| 265 | \r |
| 266 | Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an\r |
| 267 | alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is\r |
| 268 | returned. If there is not enough memory at the specified alignment remaining to satisfy the\r |
| 269 | request, then NULL is returned.\r |
| 270 | If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r |
| 271 | \r |
| 272 | @param Pages The number of 4 KB pages to allocate.\r |
| 273 | @param Alignment The requested alignment of the allocation. Must be a power of two.\r |
| 274 | If Alignment is zero, then byte alignment is used.\r |
| 275 | \r |
| 276 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 277 | \r |
| 278 | **/\r |
| 279 | VOID *\r |
| 280 | EFIAPI\r |
| 281 | AllocateAlignedRuntimePages (\r |
| 282 | IN UINTN Pages,\r |
| 283 | IN UINTN Alignment\r |
| 284 | )\r |
| 285 | {\r |
| 286 | return InternalAllocateAlignedPages (EfiRuntimeServicesData, Pages, Alignment);\r |
| 287 | }\r |
| 288 | \r |
| 289 | /**\r |
| 290 | Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.\r |
| 291 | \r |
| 292 | Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an\r |
| 293 | alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is\r |
| 294 | returned. If there is not enough memory at the specified alignment remaining to satisfy the\r |
| 295 | request, then NULL is returned.\r |
| 296 | If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r |
| 297 | \r |
| 298 | @param Pages The number of 4 KB pages to allocate.\r |
| 299 | @param Alignment The requested alignment of the allocation. Must be a power of two.\r |
| 300 | If Alignment is zero, then byte alignment is used.\r |
| 301 | \r |
| 302 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 303 | \r |
| 304 | **/\r |
| 305 | VOID *\r |
| 306 | EFIAPI\r |
| 307 | AllocateAlignedReservedPages (\r |
| 308 | IN UINTN Pages,\r |
| 309 | IN UINTN Alignment\r |
| 310 | )\r |
| 311 | {\r |
| 312 | return InternalAllocateAlignedPages (EfiReservedMemoryType, Pages, Alignment);\r |
| 313 | }\r |
| 314 | \r |
| 315 | /**\r |
| 316 | Frees one or more 4KB pages that were previously allocated with one of the aligned page\r |
| 317 | allocation functions in the Memory Allocation Library.\r |
| 318 | \r |
| 319 | Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer\r |
| 320 | must have been allocated on a previous call to the aligned page allocation services of the Memory\r |
| 321 | Allocation Library.\r |
| 322 | If Buffer was not allocated with an aligned page allocation function in the Memory Allocation\r |
| 323 | Library, then ASSERT().\r |
| 324 | If Pages is zero, then ASSERT().\r |
| 325 | \r |
| 326 | @param Buffer Pointer to the buffer of pages to free.\r |
| 327 | @param Pages The number of 4 KB pages to free.\r |
| 328 | \r |
| 329 | **/\r |
| 330 | VOID\r |
| 331 | EFIAPI\r |
| 332 | FreeAlignedPages (\r |
| 333 | IN VOID *Buffer,\r |
| 334 | IN UINTN Pages\r |
| 335 | )\r |
| 336 | {\r |
| 337 | EFI_STATUS Status;\r |
| 338 | \r |
| 339 | ASSERT (Pages != 0);\r |
| 340 | Status = gBS->FreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) Buffer, Pages);\r |
| 341 | ASSERT_EFI_ERROR (Status);\r |
| 342 | }\r |
| 343 | \r |
| 344 | /**\r |
| 345 | Allocates a buffer of a certain pool type.\r |
| 346 | \r |
| 347 | Allocates the number bytes specified by AllocationSize of a certain pool type and returns a\r |
| 348 | pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r |
| 349 | returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 350 | \r |
| 351 | @param MemoryType The type of memory to allocate.\r |
| 352 | @param AllocationSize The number of bytes to allocate.\r |
| 353 | \r |
| 354 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 355 | \r |
| 356 | **/\r |
| 357 | VOID *\r |
| 358 | InternalAllocatePool (\r |
| 359 | IN EFI_MEMORY_TYPE MemoryType, \r |
| 360 | IN UINTN AllocationSize\r |
| 361 | )\r |
| 362 | {\r |
| 363 | EFI_STATUS Status;\r |
| 364 | VOID *Memory;\r |
| 365 | \r |
| 366 | Status = gBS->AllocatePool (MemoryType, AllocationSize, &Memory);\r |
| 367 | if (EFI_ERROR (Status)) {\r |
| 368 | Memory = NULL;\r |
| 369 | }\r |
| 370 | return Memory;\r |
| 371 | }\r |
| 372 | \r |
| 373 | /**\r |
| 374 | Allocates a buffer of type EfiBootServicesData.\r |
| 375 | \r |
| 376 | Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a\r |
| 377 | pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r |
| 378 | returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 379 | \r |
| 380 | @param AllocationSize The number of bytes to allocate.\r |
| 381 | \r |
| 382 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 383 | \r |
| 384 | **/\r |
| 385 | VOID *\r |
| 386 | EFIAPI\r |
| 387 | AllocatePool (\r |
| 388 | IN UINTN AllocationSize\r |
| 389 | )\r |
| 390 | {\r |
| 391 | return InternalAllocatePool (EfiBootServicesData, AllocationSize);\r |
| 392 | }\r |
| 393 | \r |
| 394 | /**\r |
| 395 | Allocates a buffer of type EfiRuntimeServicesData.\r |
| 396 | \r |
| 397 | Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns\r |
| 398 | a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r |
| 399 | returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 400 | \r |
| 401 | @param AllocationSize The number of bytes to allocate.\r |
| 402 | \r |
| 403 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 404 | \r |
| 405 | **/\r |
| 406 | VOID *\r |
| 407 | EFIAPI\r |
| 408 | AllocateRuntimePool (\r |
| 409 | IN UINTN AllocationSize\r |
| 410 | )\r |
| 411 | {\r |
| 412 | return InternalAllocatePool (EfiRuntimeServicesData, AllocationSize);\r |
| 413 | }\r |
| 414 | \r |
| 415 | /**\r |
| 416 | Allocates a buffer of type EfieservedMemoryType.\r |
| 417 | \r |
| 418 | Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns\r |
| 419 | a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r |
| 420 | returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 421 | \r |
| 422 | @param AllocationSize The number of bytes to allocate.\r |
| 423 | \r |
| 424 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 425 | \r |
| 426 | **/\r |
| 427 | VOID *\r |
| 428 | EFIAPI\r |
| 429 | AllocateReservedPool (\r |
| 430 | IN UINTN AllocationSize\r |
| 431 | )\r |
| 432 | {\r |
| 433 | return InternalAllocatePool (EfiReservedMemoryType, AllocationSize);\r |
| 434 | }\r |
| 435 | \r |
| 436 | /**\r |
| 437 | Allocates and zeros a buffer of a certian pool type.\r |
| 438 | \r |
| 439 | Allocates the number bytes specified by AllocationSize of a certian pool type, clears the buffer\r |
| 440 | with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid\r |
| 441 | buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request,\r |
| 442 | then NULL is returned.\r |
| 443 | \r |
| 444 | @param PoolType The type of memory to allocate.\r |
| 445 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 446 | \r |
| 447 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 448 | \r |
| 449 | **/\r |
| 450 | VOID *\r |
| 451 | InternalAllocateZeroPool (\r |
| 452 | IN EFI_MEMORY_TYPE PoolType, \r |
| 453 | IN UINTN AllocationSize\r |
| 454 | ) \r |
| 455 | {\r |
| 456 | VOID *Memory;\r |
| 457 | \r |
| 458 | Memory = InternalAllocatePool (PoolType, AllocationSize);\r |
| 459 | if (Memory != NULL) {\r |
| 460 | Memory = ZeroMem (Memory, AllocationSize);\r |
| 461 | }\r |
| 462 | return Memory;\r |
| 463 | }\r |
| 464 | \r |
| 465 | /**\r |
| 466 | Allocates and zeros a buffer of type EfiBootServicesData.\r |
| 467 | \r |
| 468 | Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the\r |
| 469 | buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r |
| 470 | valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r |
| 471 | request, then NULL is returned.\r |
| 472 | \r |
| 473 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 474 | \r |
| 475 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 476 | \r |
| 477 | **/\r |
| 478 | VOID *\r |
| 479 | EFIAPI\r |
| 480 | AllocateZeroPool (\r |
| 481 | IN UINTN AllocationSize\r |
| 482 | )\r |
| 483 | {\r |
| 484 | return InternalAllocateZeroPool (EfiBootServicesData, AllocationSize);\r |
| 485 | }\r |
| 486 | \r |
| 487 | /**\r |
| 488 | Allocates and zeros a buffer of type EfiRuntimeServicesData.\r |
| 489 | \r |
| 490 | Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the\r |
| 491 | buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r |
| 492 | valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r |
| 493 | request, then NULL is returned.\r |
| 494 | \r |
| 495 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 496 | \r |
| 497 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 498 | \r |
| 499 | **/\r |
| 500 | VOID *\r |
| 501 | EFIAPI\r |
| 502 | AllocateRuntimeZeroPool (\r |
| 503 | IN UINTN AllocationSize\r |
| 504 | )\r |
| 505 | {\r |
| 506 | return InternalAllocateZeroPool (EfiRuntimeServicesData, AllocationSize);\r |
| 507 | }\r |
| 508 | \r |
| 509 | /**\r |
| 510 | Allocates and zeros a buffer of type EfiReservedMemoryType.\r |
| 511 | \r |
| 512 | Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the\r |
| 513 | buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r |
| 514 | valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r |
| 515 | request, then NULL is returned.\r |
| 516 | \r |
| 517 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 518 | \r |
| 519 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 520 | \r |
| 521 | **/\r |
| 522 | VOID *\r |
| 523 | EFIAPI\r |
| 524 | AllocateReservedZeroPool (\r |
| 525 | IN UINTN AllocationSize\r |
| 526 | )\r |
| 527 | {\r |
| 528 | return InternalAllocateZeroPool (EfiReservedMemoryType, AllocationSize);\r |
| 529 | }\r |
| 530 | \r |
| 531 | /**\r |
| 532 | Copies a buffer to an allocated buffer of a certian pool type.\r |
| 533 | \r |
| 534 | Allocates the number bytes specified by AllocationSize of a certian pool type, copies\r |
| 535 | AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r |
| 536 | allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r |
| 537 | is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 538 | If Buffer is NULL, then ASSERT().\r |
| 539 | If AllocationSize is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT(). \r |
| 540 | \r |
| 541 | @param PoolType The type of pool to allocate.\r |
| 542 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 543 | @param Buffer The buffer to copy to the allocated buffer.\r |
| 544 | \r |
| 545 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 546 | \r |
| 547 | **/\r |
| 548 | VOID *\r |
| 549 | InternalAllocateCopyPool (\r |
| 550 | IN EFI_MEMORY_TYPE PoolType, \r |
| 551 | IN UINTN AllocationSize,\r |
| 552 | IN CONST VOID *Buffer\r |
| 553 | ) \r |
| 554 | {\r |
| 555 | VOID *Memory;\r |
| 556 | \r |
| 557 | ASSERT (Buffer != NULL);\r |
| 558 | ASSERT (AllocationSize <= (MAX_ADDRESS - (UINTN) Buffer + 1));\r |
| 559 | \r |
| 560 | Memory = InternalAllocatePool (PoolType, AllocationSize);\r |
| 561 | if (Memory != NULL) {\r |
| 562 | Memory = CopyMem (Memory, Buffer, AllocationSize);\r |
| 563 | }\r |
| 564 | return Memory;\r |
| 565 | } \r |
| 566 | \r |
| 567 | /**\r |
| 568 | Copies a buffer to an allocated buffer of type EfiBootServicesData.\r |
| 569 | \r |
| 570 | Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies\r |
| 571 | AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r |
| 572 | allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r |
| 573 | is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 574 | If Buffer is NULL, then ASSERT().\r |
| 575 | If AllocationSize is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT(). \r |
| 576 | \r |
| 577 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 578 | @param Buffer The buffer to copy to the allocated buffer.\r |
| 579 | \r |
| 580 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 581 | \r |
| 582 | **/\r |
| 583 | VOID *\r |
| 584 | EFIAPI\r |
| 585 | AllocateCopyPool (\r |
| 586 | IN UINTN AllocationSize,\r |
| 587 | IN CONST VOID *Buffer\r |
| 588 | )\r |
| 589 | {\r |
| 590 | return InternalAllocateCopyPool (EfiBootServicesData, AllocationSize, Buffer);\r |
| 591 | }\r |
| 592 | \r |
| 593 | /**\r |
| 594 | Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.\r |
| 595 | \r |
| 596 | Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies\r |
| 597 | AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r |
| 598 | allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r |
| 599 | is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 600 | If Buffer is NULL, then ASSERT().\r |
| 601 | If AllocationSize is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT(). \r |
| 602 | \r |
| 603 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 604 | @param Buffer The buffer to copy to the allocated buffer.\r |
| 605 | \r |
| 606 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 607 | \r |
| 608 | **/\r |
| 609 | VOID *\r |
| 610 | EFIAPI\r |
| 611 | AllocateRuntimeCopyPool (\r |
| 612 | IN UINTN AllocationSize,\r |
| 613 | IN CONST VOID *Buffer\r |
| 614 | )\r |
| 615 | {\r |
| 616 | return InternalAllocateCopyPool (EfiRuntimeServicesData, AllocationSize, Buffer);\r |
| 617 | }\r |
| 618 | \r |
| 619 | /**\r |
| 620 | Copies a buffer to an allocated buffer of type EfiReservedMemoryType.\r |
| 621 | \r |
| 622 | Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies\r |
| 623 | AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r |
| 624 | allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r |
| 625 | is not enough memory remaining to satisfy the request, then NULL is returned.\r |
| 626 | If Buffer is NULL, then ASSERT().\r |
| 627 | If AllocationSize is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT(). \r |
| 628 | \r |
| 629 | @param AllocationSize The number of bytes to allocate and zero.\r |
| 630 | @param Buffer The buffer to copy to the allocated buffer.\r |
| 631 | \r |
| 632 | @return A pointer to the allocated buffer or NULL if allocation fails.\r |
| 633 | \r |
| 634 | **/\r |
| 635 | VOID *\r |
| 636 | EFIAPI\r |
| 637 | AllocateReservedCopyPool (\r |
| 638 | IN UINTN AllocationSize,\r |
| 639 | IN CONST VOID *Buffer\r |
| 640 | )\r |
| 641 | {\r |
| 642 | return InternalAllocateCopyPool (EfiReservedMemoryType, AllocationSize, Buffer);\r |
| 643 | }\r |
| 644 | \r |
| 645 | /**\r |
| 646 | Frees a buffer that was previously allocated with one of the pool allocation functions in the\r |
| 647 | Memory Allocation Library.\r |
| 648 | \r |
| 649 | Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the\r |
| 650 | pool allocation services of the Memory Allocation Library.\r |
| 651 | If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,\r |
| 652 | then ASSERT().\r |
| 653 | \r |
| 654 | @param Buffer Pointer to the buffer to free.\r |
| 655 | \r |
| 656 | **/\r |
| 657 | VOID\r |
| 658 | EFIAPI\r |
| 659 | FreePool (\r |
| 660 | IN VOID *Buffer\r |
| 661 | )\r |
| 662 | {\r |
| 663 | EFI_STATUS Status;\r |
| 664 | \r |
| 665 | Status = gBS->FreePool (Buffer);\r |
| 666 | ASSERT_EFI_ERROR (Status);\r |
| 667 | }\r |
| 668 | \r |
| 7d582d6b |
669 | \r |
| 42eedea9 |
670 | /**\r |
| 671 | Frees buffer that were previously allocated with one of the\r |
| 672 | memory allocation functions in the Memory Allocation Library.\r |
| 673 | \r |
| 674 | @param Buffer Pointer to the buffer of pages\r |
| 675 | to free.\r |
| 7d582d6b |
676 | \r |
| 42eedea9 |
677 | **/\r |
| 7d582d6b |
678 | VOID\r |
| 679 | EFIAPI\r |
| 680 | SafeFreePool (\r |
| 681 | IN VOID *Buffer\r |
| 682 | )\r |
| 683 | {\r |
| 684 | if (Buffer != NULL) {\r |
| 685 | FreePool (Buffer);\r |
| 7d582d6b |
686 | }\r |
| 687 | }\r |
| 688 | \r |
projects / mirror_edk2.git / blame