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