2N/A/* mm.c - generic EFI memory management */
2N/A/*
2N/A * GRUB -- GRand Unified Bootloader
2N/A * Copyright (C) 2006,2007,2008,2009 Free Software Foundation, Inc.
2N/A *
2N/A * GRUB is free software: you can redistribute it and/or modify
2N/A * it under the terms of the GNU General Public License as published by
2N/A * the Free Software Foundation, either version 3 of the License, or
2N/A * (at your option) any later version.
2N/A *
2N/A * GRUB is distributed in the hope that it will be useful,
2N/A * but WITHOUT ANY WARRANTY; without even the implied warranty of
2N/A * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2N/A * GNU General Public License for more details.
2N/A *
2N/A * You should have received a copy of the GNU General Public License
2N/A * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
2N/A */
2N/A
2N/A#include <grub/misc.h>
2N/A#include <grub/mm.h>
2N/A#include <grub/efi/api.h>
2N/A#include <grub/efi/efi.h>
2N/A
2N/A#define NEXT_MEMORY_DESCRIPTOR(desc, size) \
2N/A ((grub_efi_memory_descriptor_t *) ((char *) (desc) + (size)))
2N/A
2N/A#define BYTES_TO_PAGES(bytes) (((bytes) + 0xfff) >> 12)
2N/A#define PAGES_TO_BYTES(pages) ((pages) << 12)
2N/A
2N/A/* The size of a memory map obtained from the firmware. This must be
2N/A a multiplier of 4KB. */
2N/A#define MEMORY_MAP_SIZE 0x3000
2N/A
2N/A/* The minimum and maximum heap size for GRUB itself. */
2N/A#define MIN_HEAP_SIZE 0x100000
2N/A#define MAX_HEAP_SIZE (1600 * 0x100000)
2N/A
2N/Astatic void *finish_mmap_buf = 0;
2N/Astatic grub_efi_uintn_t finish_mmap_size = 0;
2N/Astatic grub_efi_uintn_t finish_key = 0;
2N/Astatic grub_efi_uintn_t finish_desc_size;
2N/Astatic grub_efi_uint32_t finish_desc_version;
2N/Aint grub_efi_is_finished = 0;
2N/A
2N/A/* Allocate pages. Return the pointer to the first of allocated pages. */
2N/Avoid *
2N/Agrub_efi_allocate_pages (grub_efi_physical_address_t address,
2N/A grub_efi_uintn_t pages)
2N/A{
2N/A grub_efi_allocate_type_t type;
2N/A grub_efi_status_t status;
2N/A grub_efi_boot_services_t *b;
2N/A
2N/A#if 1
2N/A /* Limit the memory access to less than 4GB for 32-bit platforms. */
2N/A if (address > 0xffffffff)
2N/A return 0;
2N/A#endif
2N/A
2N/A#if 1
2N/A if (address == 0)
2N/A {
2N/A type = GRUB_EFI_ALLOCATE_MAX_ADDRESS;
2N/A address = 0xffffffff;
2N/A }
2N/A else
2N/A type = GRUB_EFI_ALLOCATE_ADDRESS;
2N/A#else
2N/A if (address == 0)
2N/A type = GRUB_EFI_ALLOCATE_ANY_PAGES;
2N/A else
2N/A type = GRUB_EFI_ALLOCATE_ADDRESS;
2N/A#endif
2N/A
2N/A b = grub_efi_system_table->boot_services;
2N/A status = efi_call_4 (b->allocate_pages, type, GRUB_EFI_LOADER_DATA, pages, &address);
2N/A if (status != GRUB_EFI_SUCCESS)
2N/A return 0;
2N/A
2N/A if (address == 0)
2N/A {
2N/A /* Uggh, the address 0 was allocated... This is too annoying,
2N/A so reallocate another one. */
2N/A address = 0xffffffff;
2N/A status = efi_call_4 (b->allocate_pages, type, GRUB_EFI_LOADER_DATA, pages, &address);
2N/A grub_efi_free_pages (0, pages);
2N/A if (status != GRUB_EFI_SUCCESS)
2N/A return 0;
2N/A }
2N/A
2N/A return (void *) ((grub_addr_t) address);
2N/A}
2N/A
2N/A/* Free pages starting from ADDRESS. */
2N/Avoid
2N/Agrub_efi_free_pages (grub_efi_physical_address_t address,
2N/A grub_efi_uintn_t pages)
2N/A{
2N/A grub_efi_boot_services_t *b;
2N/A
2N/A b = grub_efi_system_table->boot_services;
2N/A efi_call_2 (b->free_pages, address, pages);
2N/A}
2N/A
2N/Agrub_err_t
2N/Agrub_efi_finish_boot_services (grub_efi_uintn_t *outbuf_size, void *outbuf,
2N/A grub_efi_uintn_t *map_key,
2N/A grub_efi_uintn_t *efi_desc_size,
2N/A grub_efi_uint32_t *efi_desc_version)
2N/A{
2N/A grub_efi_boot_services_t *b;
2N/A grub_efi_status_t status;
2N/A
2N/A if (grub_efi_get_memory_map (&finish_mmap_size, finish_mmap_buf, &finish_key,
2N/A &finish_desc_size, &finish_desc_version) < 0)
2N/A return grub_error (GRUB_ERR_IO, "couldn't retrieve memory map");
2N/A
2N/A if (outbuf && *outbuf_size < finish_mmap_size)
2N/A return grub_error (GRUB_ERR_IO, "memory map buffer is too small");
2N/A
2N/A finish_mmap_buf = grub_malloc (finish_mmap_size);
2N/A if (!finish_mmap_buf)
2N/A return grub_errno;
2N/A
2N/A if (grub_efi_get_memory_map (&finish_mmap_size, finish_mmap_buf, &finish_key,
2N/A &finish_desc_size, &finish_desc_version) <= 0)
2N/A return grub_error (GRUB_ERR_IO, "couldn't retrieve memory map");
2N/A
2N/A b = grub_efi_system_table->boot_services;
2N/A status = efi_call_2 (b->exit_boot_services, grub_efi_image_handle,
2N/A finish_key);
2N/A if (status != GRUB_EFI_SUCCESS)
2N/A return grub_error (GRUB_ERR_IO, "couldn't terminate EFI services");
2N/A
2N/A grub_efi_is_finished = 1;
2N/A if (outbuf_size)
2N/A *outbuf_size = finish_mmap_size;
2N/A if (outbuf)
2N/A grub_memcpy (outbuf, finish_mmap_buf, finish_mmap_size);
2N/A if (map_key)
2N/A *map_key = finish_key;
2N/A if (efi_desc_size)
2N/A *efi_desc_size = finish_desc_size;
2N/A if (efi_desc_version)
2N/A *efi_desc_version = finish_desc_version;
2N/A
2N/A return GRUB_ERR_NONE;
2N/A}
2N/A
2N/A/* Get the memory map as defined in the EFI spec. Return 1 if successful,
2N/A return 0 if partial, or return -1 if an error occurs. */
2N/Aint
2N/Agrub_efi_get_memory_map (grub_efi_uintn_t *memory_map_size,
2N/A grub_efi_memory_descriptor_t *memory_map,
2N/A grub_efi_uintn_t *map_key,
2N/A grub_efi_uintn_t *descriptor_size,
2N/A grub_efi_uint32_t *descriptor_version)
2N/A{
2N/A grub_efi_status_t status;
2N/A grub_efi_boot_services_t *b;
2N/A grub_efi_uintn_t key;
2N/A grub_efi_uint32_t version;
2N/A
2N/A if (grub_efi_is_finished)
2N/A {
2N/A int ret = 1;
2N/A if (*memory_map_size < finish_mmap_size)
2N/A {
2N/A grub_memcpy (memory_map, finish_mmap_buf, *memory_map_size);
2N/A ret = 0;
2N/A }
2N/A else
2N/A {
2N/A grub_memcpy (memory_map, finish_mmap_buf, finish_mmap_size);
2N/A ret = 1;
2N/A }
2N/A *memory_map_size = finish_mmap_size;
2N/A if (map_key)
2N/A *map_key = finish_key;
2N/A if (descriptor_size)
2N/A *descriptor_size = finish_desc_size;
2N/A if (descriptor_version)
2N/A *descriptor_version = finish_desc_version;
2N/A return ret;
2N/A }
2N/A
2N/A /* Allow some parameters to be missing. */
2N/A if (! map_key)
2N/A map_key = &key;
2N/A if (! descriptor_version)
2N/A descriptor_version = &version;
2N/A
2N/A b = grub_efi_system_table->boot_services;
2N/A status = efi_call_5 (b->get_memory_map, memory_map_size, memory_map, map_key,
2N/A descriptor_size, descriptor_version);
2N/A if (status == GRUB_EFI_SUCCESS)
2N/A return 1;
2N/A else if (status == GRUB_EFI_BUFFER_TOO_SMALL)
2N/A return 0;
2N/A else
2N/A return -1;
2N/A}
2N/A
2N/A/* Sort the memory map in place. */
2N/Astatic void
2N/Asort_memory_map (grub_efi_memory_descriptor_t *memory_map,
2N/A grub_efi_uintn_t desc_size,
2N/A grub_efi_memory_descriptor_t *memory_map_end)
2N/A{
2N/A grub_efi_memory_descriptor_t *d1;
2N/A grub_efi_memory_descriptor_t *d2;
2N/A
2N/A for (d1 = memory_map;
2N/A d1 < memory_map_end;
2N/A d1 = NEXT_MEMORY_DESCRIPTOR (d1, desc_size))
2N/A {
2N/A grub_efi_memory_descriptor_t *max_desc = d1;
2N/A
2N/A for (d2 = NEXT_MEMORY_DESCRIPTOR (d1, desc_size);
2N/A d2 < memory_map_end;
2N/A d2 = NEXT_MEMORY_DESCRIPTOR (d2, desc_size))
2N/A {
2N/A if (max_desc->num_pages < d2->num_pages)
2N/A max_desc = d2;
2N/A }
2N/A
2N/A if (max_desc != d1)
2N/A {
2N/A grub_efi_memory_descriptor_t tmp;
2N/A
2N/A tmp = *d1;
2N/A *d1 = *max_desc;
2N/A *max_desc = tmp;
2N/A }
2N/A }
2N/A}
2N/A
2N/A/* Filter the descriptors. GRUB needs only available memory. */
2N/Astatic grub_efi_memory_descriptor_t *
2N/Afilter_memory_map (grub_efi_memory_descriptor_t *memory_map,
2N/A grub_efi_memory_descriptor_t *filtered_memory_map,
2N/A grub_efi_uintn_t desc_size,
2N/A grub_efi_memory_descriptor_t *memory_map_end)
2N/A{
2N/A grub_efi_memory_descriptor_t *desc;
2N/A grub_efi_memory_descriptor_t *filtered_desc;
2N/A
2N/A for (desc = memory_map, filtered_desc = filtered_memory_map;
2N/A desc < memory_map_end;
2N/A desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size))
2N/A {
2N/A if (desc->type == GRUB_EFI_CONVENTIONAL_MEMORY
2N/A#if 1
2N/A && desc->physical_start <= 0xffffffff
2N/A#endif
2N/A && desc->physical_start + PAGES_TO_BYTES (desc->num_pages) > 0x100000
2N/A && desc->num_pages != 0)
2N/A {
2N/A grub_memcpy (filtered_desc, desc, desc_size);
2N/A
2N/A /* Avoid less than 1MB, because some loaders seem to be confused. */
2N/A if (desc->physical_start < 0x100000)
2N/A {
2N/A desc->num_pages -= BYTES_TO_PAGES (0x100000
2N/A - desc->physical_start);
2N/A desc->physical_start = 0x100000;
2N/A }
2N/A
2N/A#if 1
2N/A if (BYTES_TO_PAGES (filtered_desc->physical_start)
2N/A + filtered_desc->num_pages
2N/A > BYTES_TO_PAGES (0x100000000LL))
2N/A filtered_desc->num_pages
2N/A = (BYTES_TO_PAGES (0x100000000LL)
2N/A - BYTES_TO_PAGES (filtered_desc->physical_start));
2N/A#endif
2N/A
2N/A if (filtered_desc->num_pages == 0)
2N/A continue;
2N/A
2N/A filtered_desc = NEXT_MEMORY_DESCRIPTOR (filtered_desc, desc_size);
2N/A }
2N/A }
2N/A
2N/A return filtered_desc;
2N/A}
2N/A
2N/A/* Return the total number of pages. */
2N/Astatic grub_efi_uint64_t
2N/Aget_total_pages (grub_efi_memory_descriptor_t *memory_map,
2N/A grub_efi_uintn_t desc_size,
2N/A grub_efi_memory_descriptor_t *memory_map_end)
2N/A{
2N/A grub_efi_memory_descriptor_t *desc;
2N/A grub_efi_uint64_t total = 0;
2N/A
2N/A for (desc = memory_map;
2N/A desc < memory_map_end;
2N/A desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size))
2N/A total += desc->num_pages;
2N/A
2N/A return total;
2N/A}
2N/A
2N/A/* Add memory regions. */
2N/Astatic void
2N/Aadd_memory_regions (grub_efi_memory_descriptor_t *memory_map,
2N/A grub_efi_uintn_t desc_size,
2N/A grub_efi_memory_descriptor_t *memory_map_end,
2N/A grub_efi_uint64_t required_pages)
2N/A{
2N/A grub_efi_memory_descriptor_t *desc;
2N/A
2N/A for (desc = memory_map;
2N/A desc < memory_map_end;
2N/A desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size))
2N/A {
2N/A grub_efi_uint64_t pages;
2N/A grub_efi_physical_address_t start;
2N/A void *addr;
2N/A
2N/A start = desc->physical_start;
2N/A pages = desc->num_pages;
2N/A if (pages > required_pages)
2N/A {
2N/A start += PAGES_TO_BYTES (pages - required_pages);
2N/A pages = required_pages;
2N/A }
2N/A
2N/A addr = grub_efi_allocate_pages (start, pages);
2N/A if (! addr)
2N/A grub_fatal ("cannot allocate conventional memory %p with %u pages",
2N/A (void *) ((grub_addr_t) start),
2N/A (unsigned) pages);
2N/A
2N/A grub_mm_init_region (addr, PAGES_TO_BYTES (pages));
2N/A
2N/A required_pages -= pages;
2N/A if (required_pages == 0)
2N/A break;
2N/A }
2N/A
2N/A if (required_pages > 0)
2N/A grub_fatal ("too little memory");
2N/A}
2N/A
2N/A#if 0
2N/A/* Print the memory map. */
2N/Astatic void
2N/Aprint_memory_map (grub_efi_memory_descriptor_t *memory_map,
2N/A grub_efi_uintn_t desc_size,
2N/A grub_efi_memory_descriptor_t *memory_map_end)
2N/A{
2N/A grub_efi_memory_descriptor_t *desc;
2N/A int i;
2N/A
2N/A for (desc = memory_map, i = 0;
2N/A desc < memory_map_end;
2N/A desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size), i++)
2N/A {
2N/A grub_printf ("MD: t=%x, p=%llx, v=%llx, n=%llx, a=%llx\n",
2N/A desc->type, desc->physical_start, desc->virtual_start,
2N/A desc->num_pages, desc->attribute);
2N/A }
2N/A}
2N/A#endif
2N/A
2N/Avoid
2N/Agrub_efi_mm_init (void)
2N/A{
2N/A grub_efi_memory_descriptor_t *memory_map;
2N/A grub_efi_memory_descriptor_t *memory_map_end;
2N/A grub_efi_memory_descriptor_t *filtered_memory_map;
2N/A grub_efi_memory_descriptor_t *filtered_memory_map_end;
2N/A grub_efi_uintn_t map_size;
2N/A grub_efi_uintn_t desc_size;
2N/A grub_efi_uint64_t total_pages;
2N/A grub_efi_uint64_t required_pages;
2N/A int mm_status;
2N/A
2N/A /* Prepare a memory region to store two memory maps. */
2N/A memory_map = grub_efi_allocate_pages (0,
2N/A 2 * BYTES_TO_PAGES (MEMORY_MAP_SIZE));
2N/A if (! memory_map)
2N/A grub_fatal ("cannot allocate memory");
2N/A
2N/A /* Obtain descriptors for available memory. */
2N/A map_size = MEMORY_MAP_SIZE;
2N/A
2N/A mm_status = grub_efi_get_memory_map (&map_size, memory_map, 0, &desc_size, 0);
2N/A
2N/A if (mm_status == 0)
2N/A {
2N/A grub_efi_free_pages
2N/A ((grub_efi_physical_address_t) ((grub_addr_t) memory_map),
2N/A 2 * BYTES_TO_PAGES (MEMORY_MAP_SIZE));
2N/A
2N/A /* Freeing/allocating operations may increase memory map size. */
2N/A map_size += desc_size * 32;
2N/A
2N/A memory_map = grub_efi_allocate_pages (0, 2 * BYTES_TO_PAGES (map_size));
2N/A if (! memory_map)
2N/A grub_fatal ("cannot allocate memory");
2N/A
2N/A mm_status = grub_efi_get_memory_map (&map_size, memory_map, 0,
2N/A &desc_size, 0);
2N/A }
2N/A
2N/A if (mm_status < 0)
2N/A grub_fatal ("cannot get memory map");
2N/A
2N/A memory_map_end = NEXT_MEMORY_DESCRIPTOR (memory_map, map_size);
2N/A
2N/A filtered_memory_map = memory_map_end;
2N/A
2N/A filtered_memory_map_end = filter_memory_map (memory_map, filtered_memory_map,
2N/A desc_size, memory_map_end);
2N/A
2N/A /* By default, request a quarter of the available memory. */
2N/A total_pages = get_total_pages (filtered_memory_map, desc_size,
2N/A filtered_memory_map_end);
2N/A required_pages = (total_pages >> 2);
2N/A if (required_pages < BYTES_TO_PAGES (MIN_HEAP_SIZE))
2N/A required_pages = BYTES_TO_PAGES (MIN_HEAP_SIZE);
2N/A else if (required_pages > BYTES_TO_PAGES (MAX_HEAP_SIZE))
2N/A required_pages = BYTES_TO_PAGES (MAX_HEAP_SIZE);
2N/A
2N/A /* Sort the filtered descriptors, so that GRUB can allocate pages
2N/A from smaller regions. */
2N/A sort_memory_map (filtered_memory_map, desc_size, filtered_memory_map_end);
2N/A
2N/A /* Allocate memory regions for GRUB's memory management. */
2N/A add_memory_regions (filtered_memory_map, desc_size,
2N/A filtered_memory_map_end, required_pages);
2N/A
2N/A#if 0
2N/A /* For debug. */
2N/A map_size = MEMORY_MAP_SIZE;
2N/A
2N/A if (grub_efi_get_memory_map (&map_size, memory_map, 0, &desc_size, 0) < 0)
2N/A grub_fatal ("cannot get memory map");
2N/A
2N/A grub_printf ("printing memory map\n");
2N/A print_memory_map (memory_map, desc_size,
2N/A NEXT_MEMORY_DESCRIPTOR (memory_map, map_size));
2N/A grub_abort ();
2N/A#endif
2N/A
2N/A /* Release the memory maps. */
2N/A grub_efi_free_pages ((grub_addr_t) memory_map,
2N/A 2 * BYTES_TO_PAGES (MEMORY_MAP_SIZE));
2N/A}
2N/A
2N/A#ifdef GRUB_MACHINE_EFI
2N/A/* Find the optimal number of pages for the memory map. */
2N/Agrub_efi_uintn_t
2N/Agrub_efi_find_mmap_size (void)
2N/A{
2N/A static grub_efi_uintn_t mmap_size = 0;
2N/A
2N/A if (mmap_size != 0)
2N/A return mmap_size;
2N/A
2N/A mmap_size = (1 << 12);
2N/A while (1)
2N/A {
2N/A int ret;
2N/A grub_efi_uintn_t desc_size;
2N/A grub_efi_memory_descriptor_t *mmap;
2N/A
2N/A mmap = grub_malloc (mmap_size);
2N/A if (! mmap)
2N/A return 0;
2N/A
2N/A ret = grub_efi_get_memory_map (&mmap_size, mmap, 0, &desc_size, 0);
2N/A grub_free (mmap);
2N/A
2N/A if (ret < 0)
2N/A {
2N/A grub_error (GRUB_ERR_IO, "cannot get memory map");
2N/A return 0;
2N/A }
2N/A else if (ret > 0)
2N/A break;
2N/A
2N/A mmap_size += (1 << 12);
2N/A }
2N/A
2N/A /* Increase the size a bit for safety, because GRUB allocates more on
2N/A later, and EFI itself may allocate more. */
2N/A mmap_size += (1 << 12);
2N/A
2N/A mmap_size = grub_page_align (mmap_size);
2N/A return mmap_size;
2N/A}
2N/A
2N/A#endif
2N/A