grub-core/kern/efi/mm.c

   1 /* mm.c - generic EFI memory management */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2006,2007,2008,2009  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <grub/misc.h>
  21 #include <grub/mm.h>
  22 #include <grub/efi/api.h>
  23 #include <grub/efi/efi.h>
  24 #include <grub/cpu/efi/memory.h>
  25
  26 #if defined (__i386__) || defined (__x86_64__)
  27 #include <grub/pci.h>
  28 #endif
  29
  30 #define NEXT_MEMORY_DESCRIPTOR(desc, size)      \
  31   ((grub_efi_memory_descriptor_t *) ((char *) (desc) + (size)))
  32
  33 #define BYTES_TO_PAGES(bytes)   (((bytes) + 0xfff) >> 12)
  34 #define BYTES_TO_PAGES_DOWN(bytes)      ((bytes) >> 12)
  35 #define PAGES_TO_BYTES(pages)   ((pages) << 12)
  36
  37 /* The size of a memory map obtained from the firmware. This must be
  38    a multiplier of 4KB.  */
  39 #define MEMORY_MAP_SIZE 0x3000
  40
  41 /* The minimum and maximum heap size for GRUB itself.  */
  42 #define MIN_HEAP_SIZE   0x100000
  43 #define MAX_HEAP_SIZE   (1600 * 0x100000)
  44
  45 static void *finish_mmap_buf = 0;
  46 static grub_efi_uintn_t finish_mmap_size = 0;
  47 static grub_efi_uintn_t finish_key = 0;
  48 static grub_efi_uintn_t finish_desc_size;
  49 static grub_efi_uint32_t finish_desc_version;
  50 int grub_efi_is_finished = 0;
  51
  52 /* Allocate pages. Return the pointer to the first of allocated pages.  */
  53 void *
  54 grub_efi_allocate_pages (grub_efi_physical_address_t address,
  55                          grub_efi_uintn_t pages)
  56 {
  57   grub_efi_allocate_type_t type;
  58   grub_efi_status_t status;
  59   grub_efi_boot_services_t *b;
  60
  61 #if 1
  62   /* Limit the memory access to less than 4GB for 32-bit platforms.  */
  63   if (address > GRUB_EFI_MAX_USABLE_ADDRESS)
  64     return 0;
  65 #endif
  66
  67 #if 1
  68   if (address == 0)
  69     {
  70       type = GRUB_EFI_ALLOCATE_MAX_ADDRESS;
  71       address = GRUB_EFI_MAX_USABLE_ADDRESS;
  72     }
  73   else
  74     type = GRUB_EFI_ALLOCATE_ADDRESS;
  75 #else
  76   if (address == 0)
  77     type = GRUB_EFI_ALLOCATE_ANY_PAGES;
  78   else
  79     type = GRUB_EFI_ALLOCATE_ADDRESS;
  80 #endif
  81
  82   b = grub_efi_system_table->boot_services;
  83   status = efi_call_4 (b->allocate_pages, type, GRUB_EFI_LOADER_DATA, pages, &address);
  84   if (status != GRUB_EFI_SUCCESS)
  85     return 0;
  86
  87   if (address == 0)
  88     {
  89       /* Uggh, the address 0 was allocated... This is too annoying,
  90          so reallocate another one.  */
  91       address = GRUB_EFI_MAX_USABLE_ADDRESS;
  92       status = efi_call_4 (b->allocate_pages, type, GRUB_EFI_LOADER_DATA, pages, &address);
  93       grub_efi_free_pages (0, pages);
  94       if (status != GRUB_EFI_SUCCESS)
  95         return 0;
  96     }
  97
  98   return (void *) ((grub_addr_t) address);
  99 }
 100
 101 /* Free pages starting from ADDRESS.  */
 102 void
 103 grub_efi_free_pages (grub_efi_physical_address_t address,
 104                      grub_efi_uintn_t pages)
 105 {
 106   grub_efi_boot_services_t *b;
 107
 108   b = grub_efi_system_table->boot_services;
 109   efi_call_2 (b->free_pages, address, pages);
 110 }
 111
 112 #if defined (__i386__) || defined (__x86_64__)
 113
 114 /* Helper for stop_broadcom.  */
 115 static int
 116 find_card (grub_pci_device_t dev, grub_pci_id_t pciid,
 117            void *data __attribute__ ((unused)))
 118 {
 119   grub_pci_address_t addr;
 120   grub_uint8_t cap;
 121   grub_uint16_t pm_state;
 122
 123   if ((pciid & 0xffff) != GRUB_PCI_VENDOR_BROADCOM)
 124     return 0;
 125
 126   addr = grub_pci_make_address (dev, GRUB_PCI_REG_CLASS);
 127   if (grub_pci_read (addr) >> 24 != GRUB_PCI_CLASS_NETWORK)
 128     return 0;
 129   cap = grub_pci_find_capability (dev, GRUB_PCI_CAP_POWER_MANAGEMENT);
 130   if (!cap)
 131     return 0;
 132   addr = grub_pci_make_address (dev, cap + 4);
 133   pm_state = grub_pci_read_word (addr);
 134   pm_state = pm_state | 0x03;
 135   grub_pci_write_word (addr, pm_state);
 136   grub_pci_read_word (addr);
 137   return 0;
 138 }
 139
 140 static void
 141 stop_broadcom (void)
 142 {
 143   grub_pci_iterate (find_card, NULL);
 144 }
 145
 146 #endif
 147
 148 grub_err_t
 149 grub_efi_finish_boot_services (grub_efi_uintn_t *outbuf_size, void *outbuf,
 150                                grub_efi_uintn_t *map_key,
 151                                grub_efi_uintn_t *efi_desc_size,
 152                                grub_efi_uint32_t *efi_desc_version)
 153 {
 154   grub_efi_boot_services_t *b;
 155   grub_efi_status_t status;
 156
 157 #if defined (__i386__) || defined (__x86_64__)
 158   const grub_uint16_t apple[] = { 'A', 'p', 'p', 'l', 'e' };
 159   int is_apple;
 160
 161   is_apple = (grub_memcmp (grub_efi_system_table->firmware_vendor,
 162                            apple, sizeof (apple)) == 0);
 163 #endif
 164
 165   while (1)
 166     {
 167       if (grub_efi_get_memory_map (&finish_mmap_size, finish_mmap_buf, &finish_key,
 168                                    &finish_desc_size, &finish_desc_version) < 0)
 169         return grub_error (GRUB_ERR_IO, "couldn't retrieve memory map");
 170
 171       if (outbuf && *outbuf_size < finish_mmap_size)
 172         return grub_error (GRUB_ERR_IO, "memory map buffer is too small");
 173
 174       finish_mmap_buf = grub_malloc (finish_mmap_size);
 175       if (!finish_mmap_buf)
 176         return grub_errno;
 177
 178       if (grub_efi_get_memory_map (&finish_mmap_size, finish_mmap_buf, &finish_key,
 179                                    &finish_desc_size, &finish_desc_version) <= 0)
 180         {
 181           grub_free (finish_mmap_buf);
 182           return grub_error (GRUB_ERR_IO, "couldn't retrieve memory map");
 183         }
 184
 185       b = grub_efi_system_table->boot_services;
 186       status = efi_call_2 (b->exit_boot_services, grub_efi_image_handle,
 187                            finish_key);
 188       if (status == GRUB_EFI_SUCCESS)
 189         break;
 190
 191       if (status != GRUB_EFI_INVALID_PARAMETER)
 192         {
 193           grub_free (finish_mmap_buf);
 194           return grub_error (GRUB_ERR_IO, "couldn't terminate EFI services");
 195         }
 196
 197       grub_free (finish_mmap_buf);
 198       grub_printf ("Trying to terminate EFI services again\n");
 199     }
 200   grub_efi_is_finished = 1;
 201   if (outbuf_size)
 202     *outbuf_size = finish_mmap_size;
 203   if (outbuf)
 204     grub_memcpy (outbuf, finish_mmap_buf, finish_mmap_size);
 205   if (map_key)
 206     *map_key = finish_key;
 207   if (efi_desc_size)
 208     *efi_desc_size = finish_desc_size;
 209   if (efi_desc_version)
 210     *efi_desc_version = finish_desc_version;
 211
 212 #if defined (__i386__) || defined (__x86_64__)
 213   if (is_apple)
 214     stop_broadcom ();
 215 #endif
 216
 217   return GRUB_ERR_NONE;
 218 }
 219
 220 /* Get the memory map as defined in the EFI spec. Return 1 if successful,
 221    return 0 if partial, or return -1 if an error occurs.  */
 222 int
 223 grub_efi_get_memory_map (grub_efi_uintn_t *memory_map_size,
 224                          grub_efi_memory_descriptor_t *memory_map,
 225                          grub_efi_uintn_t *map_key,
 226                          grub_efi_uintn_t *descriptor_size,
 227                          grub_efi_uint32_t *descriptor_version)
 228 {
 229   grub_efi_status_t status;
 230   grub_efi_boot_services_t *b;
 231   grub_efi_uintn_t key;
 232   grub_efi_uint32_t version;
 233   grub_efi_uintn_t size;
 234
 235   if (grub_efi_is_finished)
 236     {
 237       int ret = 1;
 238       if (*memory_map_size < finish_mmap_size)
 239         {
 240           grub_memcpy (memory_map, finish_mmap_buf, *memory_map_size);
 241           ret = 0;
 242         }
 243       else
 244         {
 245           grub_memcpy (memory_map, finish_mmap_buf, finish_mmap_size);
 246           ret = 1;
 247         }
 248       *memory_map_size = finish_mmap_size;
 249       if (map_key)
 250         *map_key = finish_key;
 251       if (descriptor_size)
 252         *descriptor_size = finish_desc_size;
 253       if (descriptor_version)
 254         *descriptor_version = finish_desc_version;
 255       return ret;
 256     }
 257
 258   /* Allow some parameters to be missing.  */
 259   if (! map_key)
 260     map_key = &key;
 261   if (! descriptor_version)
 262     descriptor_version = &version;
 263   if (! descriptor_size)
 264     descriptor_size = &size;
 265
 266   b = grub_efi_system_table->boot_services;
 267   status = efi_call_5 (b->get_memory_map, memory_map_size, memory_map, map_key,
 268                               descriptor_size, descriptor_version);
 269   if (*descriptor_size == 0)
 270     *descriptor_size = sizeof (grub_efi_memory_descriptor_t);
 271   if (status == GRUB_EFI_SUCCESS)
 272     return 1;
 273   else if (status == GRUB_EFI_BUFFER_TOO_SMALL)
 274     return 0;
 275   else
 276     return -1;
 277 }
 278
 279 /* Sort the memory map in place.  */
 280 static void
 281 sort_memory_map (grub_efi_memory_descriptor_t *memory_map,
 282                  grub_efi_uintn_t desc_size,
 283                  grub_efi_memory_descriptor_t *memory_map_end)
 284 {
 285   grub_efi_memory_descriptor_t *d1;
 286   grub_efi_memory_descriptor_t *d2;
 287
 288   for (d1 = memory_map;
 289        d1 < memory_map_end;
 290        d1 = NEXT_MEMORY_DESCRIPTOR (d1, desc_size))
 291     {
 292       grub_efi_memory_descriptor_t *max_desc = d1;
 293
 294       for (d2 = NEXT_MEMORY_DESCRIPTOR (d1, desc_size);
 295            d2 < memory_map_end;
 296            d2 = NEXT_MEMORY_DESCRIPTOR (d2, desc_size))
 297         {
 298           if (max_desc->num_pages < d2->num_pages)
 299             max_desc = d2;
 300         }
 301
 302       if (max_desc != d1)
 303         {
 304           grub_efi_memory_descriptor_t tmp;
 305
 306           tmp = *d1;
 307           *d1 = *max_desc;
 308           *max_desc = tmp;
 309         }
 310     }
 311 }
 312
 313 /* Filter the descriptors. GRUB needs only available memory.  */
 314 static grub_efi_memory_descriptor_t *
 315 filter_memory_map (grub_efi_memory_descriptor_t *memory_map,
 316                    grub_efi_memory_descriptor_t *filtered_memory_map,
 317                    grub_efi_uintn_t desc_size,
 318                    grub_efi_memory_descriptor_t *memory_map_end)
 319 {
 320   grub_efi_memory_descriptor_t *desc;
 321   grub_efi_memory_descriptor_t *filtered_desc;
 322
 323   for (desc = memory_map, filtered_desc = filtered_memory_map;
 324        desc < memory_map_end;
 325        desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size))
 326     {
 327       if (desc->type == GRUB_EFI_CONVENTIONAL_MEMORY
 328 #if 1
 329           && desc->physical_start <= GRUB_EFI_MAX_USABLE_ADDRESS
 330 #endif
 331           && desc->physical_start + PAGES_TO_BYTES (desc->num_pages) > 0x100000
 332           && desc->num_pages != 0)
 333         {
 334           grub_memcpy (filtered_desc, desc, desc_size);
 335
 336           /* Avoid less than 1MB, because some loaders seem to be confused.  */
 337           if (desc->physical_start < 0x100000)
 338             {
 339               desc->num_pages -= BYTES_TO_PAGES (0x100000
 340                                                  - desc->physical_start);
 341               desc->physical_start = 0x100000;
 342             }
 343
 344 #if 1
 345           if (BYTES_TO_PAGES (filtered_desc->physical_start)
 346               + filtered_desc->num_pages
 347               > BYTES_TO_PAGES_DOWN (GRUB_EFI_MAX_USABLE_ADDRESS))
 348             filtered_desc->num_pages
 349               = (BYTES_TO_PAGES_DOWN (GRUB_EFI_MAX_USABLE_ADDRESS)
 350                  - BYTES_TO_PAGES (filtered_desc->physical_start));
 351 #endif
 352
 353           if (filtered_desc->num_pages == 0)
 354             continue;
 355
 356           filtered_desc = NEXT_MEMORY_DESCRIPTOR (filtered_desc, desc_size);
 357         }
 358     }
 359
 360   return filtered_desc;
 361 }
 362
 363 /* Return the total number of pages.  */
 364 static grub_efi_uint64_t
 365 get_total_pages (grub_efi_memory_descriptor_t *memory_map,
 366                  grub_efi_uintn_t desc_size,
 367                  grub_efi_memory_descriptor_t *memory_map_end)
 368 {
 369   grub_efi_memory_descriptor_t *desc;
 370   grub_efi_uint64_t total = 0;
 371
 372   for (desc = memory_map;
 373        desc < memory_map_end;
 374        desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size))
 375     total += desc->num_pages;
 376
 377   return total;
 378 }
 379
 380 /* Add memory regions.  */
 381 static void
 382 add_memory_regions (grub_efi_memory_descriptor_t *memory_map,
 383                     grub_efi_uintn_t desc_size,
 384                     grub_efi_memory_descriptor_t *memory_map_end,
 385                     grub_efi_uint64_t required_pages)
 386 {
 387   grub_efi_memory_descriptor_t *desc;
 388
 389   for (desc = memory_map;
 390        desc < memory_map_end;
 391        desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size))
 392     {
 393       grub_efi_uint64_t pages;
 394       grub_efi_physical_address_t start;
 395       void *addr;
 396
 397       start = desc->physical_start;
 398       pages = desc->num_pages;
 399       if (pages > required_pages)
 400         {
 401           start += PAGES_TO_BYTES (pages - required_pages);
 402           pages = required_pages;
 403         }
 404
 405       addr = grub_efi_allocate_pages (start, pages);
 406       if (! addr)
 407         grub_fatal ("cannot allocate conventional memory %p with %u pages",
 408                     (void *) ((grub_addr_t) start),
 409                     (unsigned) pages);
 410
 411       grub_mm_init_region (addr, PAGES_TO_BYTES (pages));
 412
 413       required_pages -= pages;
 414       if (required_pages == 0)
 415         break;
 416     }
 417
 418   if (required_pages > 0)
 419     grub_fatal ("too little memory");
 420 }
 421
 422 #if 0
 423 /* Print the memory map.  */
 424 static void
 425 print_memory_map (grub_efi_memory_descriptor_t *memory_map,
 426                   grub_efi_uintn_t desc_size,
 427                   grub_efi_memory_descriptor_t *memory_map_end)
 428 {
 429   grub_efi_memory_descriptor_t *desc;
 430   int i;
 431
 432   for (desc = memory_map, i = 0;
 433        desc < memory_map_end;
 434        desc = NEXT_MEMORY_DESCRIPTOR (desc, desc_size), i++)
 435     {
 436       grub_printf ("MD: t=%x, p=%llx, v=%llx, n=%llx, a=%llx\n",
 437                    desc->type, desc->physical_start, desc->virtual_start,
 438                    desc->num_pages, desc->attribute);
 439     }
 440 }
 441 #endif
 442
 443 void
 444 grub_efi_mm_init (void)
 445 {
 446   grub_efi_memory_descriptor_t *memory_map;
 447   grub_efi_memory_descriptor_t *memory_map_end;
 448   grub_efi_memory_descriptor_t *filtered_memory_map;
 449   grub_efi_memory_descriptor_t *filtered_memory_map_end;
 450   grub_efi_uintn_t map_size;
 451   grub_efi_uintn_t desc_size;
 452   grub_efi_uint64_t total_pages;
 453   grub_efi_uint64_t required_pages;
 454   int mm_status;
 455
 456   /* Prepare a memory region to store two memory maps.  */
 457   memory_map = grub_efi_allocate_pages (0,
 458                                         2 * BYTES_TO_PAGES (MEMORY_MAP_SIZE));
 459   if (! memory_map)
 460     grub_fatal ("cannot allocate memory");
 461
 462   /* Obtain descriptors for available memory.  */
 463   map_size = MEMORY_MAP_SIZE;
 464
 465   mm_status = grub_efi_get_memory_map (&map_size, memory_map, 0, &desc_size, 0);
 466
 467   if (mm_status == 0)
 468     {
 469       grub_efi_free_pages
 470         ((grub_efi_physical_address_t) ((grub_addr_t) memory_map),
 471          2 * BYTES_TO_PAGES (MEMORY_MAP_SIZE));
 472
 473       /* Freeing/allocating operations may increase memory map size.  */
 474       map_size += desc_size * 32;
 475
 476       memory_map = grub_efi_allocate_pages (0, 2 * BYTES_TO_PAGES (map_size));
 477       if (! memory_map)
 478         grub_fatal ("cannot allocate memory");
 479
 480       mm_status = grub_efi_get_memory_map (&map_size, memory_map, 0,
 481                                            &desc_size, 0);
 482     }
 483
 484   if (mm_status < 0)
 485     grub_fatal ("cannot get memory map");
 486
 487   memory_map_end = NEXT_MEMORY_DESCRIPTOR (memory_map, map_size);
 488
 489   filtered_memory_map = memory_map_end;
 490
 491   filtered_memory_map_end = filter_memory_map (memory_map, filtered_memory_map,
 492                                                desc_size, memory_map_end);
 493
 494   /* By default, request a quarter of the available memory.  */
 495   total_pages = get_total_pages (filtered_memory_map, desc_size,
 496                                  filtered_memory_map_end);
 497   required_pages = (total_pages >> 2);
 498   if (required_pages < BYTES_TO_PAGES (MIN_HEAP_SIZE))
 499     required_pages = BYTES_TO_PAGES (MIN_HEAP_SIZE);
 500   else if (required_pages > BYTES_TO_PAGES (MAX_HEAP_SIZE))
 501     required_pages = BYTES_TO_PAGES (MAX_HEAP_SIZE);
 502
 503   /* Sort the filtered descriptors, so that GRUB can allocate pages
 504      from smaller regions.  */
 505   sort_memory_map (filtered_memory_map, desc_size, filtered_memory_map_end);
 506
 507   /* Allocate memory regions for GRUB's memory management.  */
 508   add_memory_regions (filtered_memory_map, desc_size,
 509                       filtered_memory_map_end, required_pages);
 510
 511 #if 0
 512   /* For debug.  */
 513   map_size = MEMORY_MAP_SIZE;
 514
 515   if (grub_efi_get_memory_map (&map_size, memory_map, 0, &desc_size, 0) < 0)
 516     grub_fatal ("cannot get memory map");
 517
 518   grub_printf ("printing memory map\n");
 519   print_memory_map (memory_map, desc_size,
 520                     NEXT_MEMORY_DESCRIPTOR (memory_map, map_size));
 521   grub_fatal ("Debug. ");
 522 #endif
 523
 524   /* Release the memory maps.  */
 525   grub_efi_free_pages ((grub_addr_t) memory_map,
 526                        2 * BYTES_TO_PAGES (MEMORY_MAP_SIZE));
 527 }