lib/efi_loader/efi_image_loader.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  EFI image loader
   4  *
   5  *  based partly on wine code
   6  *
   7  *  Copyright (c) 2016 Alexander Graf
   8  */
   9
  10 #include <common.h>
  11 #include <efi_loader.h>
  12 #include <pe.h>
  13 #include <asm/global_data.h>
  14
  15 const efi_guid_t efi_global_variable_guid = EFI_GLOBAL_VARIABLE_GUID;
  16 const efi_guid_t efi_guid_device_path = DEVICE_PATH_GUID;
  17 const efi_guid_t efi_guid_loaded_image = LOADED_IMAGE_GUID;
  18 const efi_guid_t efi_simple_file_system_protocol_guid =
  19                 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID;
  20 const efi_guid_t efi_file_info_guid = EFI_FILE_INFO_GUID;
  21
  22 static int machines[] = {
  23 #if defined(CONFIG_ARM64)
  24         IMAGE_FILE_MACHINE_ARM64,
  25 #elif defined(CONFIG_ARM)
  26         IMAGE_FILE_MACHINE_ARM,
  27         IMAGE_FILE_MACHINE_THUMB,
  28         IMAGE_FILE_MACHINE_ARMNT,
  29 #endif
  30
  31 #if defined(CONFIG_X86_64)
  32         IMAGE_FILE_MACHINE_AMD64,
  33 #elif defined(CONFIG_X86)
  34         IMAGE_FILE_MACHINE_I386,
  35 #endif
  36
  37 #if defined(CONFIG_CPU_RISCV_32)
  38         IMAGE_FILE_MACHINE_RISCV32,
  39 #endif
  40
  41 #if defined(CONFIG_CPU_RISCV_64)
  42         IMAGE_FILE_MACHINE_RISCV64,
  43 #endif
  44         0 };
  45
  46 /*
  47  * Print information about a loaded image.
  48  *
  49  * If the program counter is located within the image the offset to the base
  50  * address is shown.
  51  *
  52  * @image:      loaded image
  53  * @pc:         program counter (use NULL to suppress offset output)
  54  * @return:     status code
  55  */
  56 efi_status_t efi_print_image_info(struct efi_loaded_image *image, void *pc)
  57 {
  58         if (!image)
  59                 return EFI_INVALID_PARAMETER;
  60         printf("UEFI image");
  61         printf(" [0x%p:0x%p]",
  62                image->reloc_base, image->reloc_base + image->reloc_size - 1);
  63         if (pc && pc >= image->reloc_base &&
  64             pc < image->reloc_base + image->reloc_size)
  65                 printf(" pc=0x%zx", pc - image->reloc_base);
  66         if (image->file_path)
  67                 printf(" '%pD'", image->file_path);
  68         printf("\n");
  69         return EFI_SUCCESS;
  70 }
  71
  72 /*
  73  * Print information about all loaded images.
  74  *
  75  * @pc:         program counter (use NULL to suppress offset output)
  76  */
  77 void efi_print_image_infos(void *pc)
  78 {
  79         struct efi_object *efiobj;
  80         struct efi_handler *handler;
  81
  82         list_for_each_entry(efiobj, &efi_obj_list, link) {
  83                 list_for_each_entry(handler, &efiobj->protocols, link) {
  84                         if (!guidcmp(handler->guid, &efi_guid_loaded_image)) {
  85                                 efi_print_image_info(
  86                                         handler->protocol_interface, pc);
  87                         }
  88                 }
  89         }
  90 }
  91
  92 static efi_status_t efi_loader_relocate(const IMAGE_BASE_RELOCATION *rel,
  93                         unsigned long rel_size, void *efi_reloc,
  94                         unsigned long pref_address)
  95 {
  96         unsigned long delta = (unsigned long)efi_reloc - pref_address;
  97         const IMAGE_BASE_RELOCATION *end;
  98         int i;
  99
 100         if (delta == 0)
 101                 return EFI_SUCCESS;
 102
 103         end = (const IMAGE_BASE_RELOCATION *)((const char *)rel + rel_size);
 104         while (rel < end - 1 && rel->SizeOfBlock) {
 105                 const uint16_t *relocs = (const uint16_t *)(rel + 1);
 106                 i = (rel->SizeOfBlock - sizeof(*rel)) / sizeof(uint16_t);
 107                 while (i--) {
 108                         uint32_t offset = (uint32_t)(*relocs & 0xfff) +
 109                                           rel->VirtualAddress;
 110                         int type = *relocs >> EFI_PAGE_SHIFT;
 111                         uint64_t *x64 = efi_reloc + offset;
 112                         uint32_t *x32 = efi_reloc + offset;
 113                         uint16_t *x16 = efi_reloc + offset;
 114
 115                         switch (type) {
 116                         case IMAGE_REL_BASED_ABSOLUTE:
 117                                 break;
 118                         case IMAGE_REL_BASED_HIGH:
 119                                 *x16 += ((uint32_t)delta) >> 16;
 120                                 break;
 121                         case IMAGE_REL_BASED_LOW:
 122                                 *x16 += (uint16_t)delta;
 123                                 break;
 124                         case IMAGE_REL_BASED_HIGHLOW:
 125                                 *x32 += (uint32_t)delta;
 126                                 break;
 127                         case IMAGE_REL_BASED_DIR64:
 128                                 *x64 += (uint64_t)delta;
 129                                 break;
 130                         default:
 131                                 printf("Unknown Relocation off %x type %x\n",
 132                                        offset, type);
 133                                 return EFI_LOAD_ERROR;
 134                         }
 135                         relocs++;
 136                 }
 137                 rel = (const IMAGE_BASE_RELOCATION *)relocs;
 138         }
 139         return EFI_SUCCESS;
 140 }
 141
 142 void __weak invalidate_icache_all(void)
 143 {
 144         /* If the system doesn't support icache_all flush, cross our fingers */
 145 }
 146
 147 /*
 148  * Determine the memory types to be used for code and data.
 149  *
 150  * @loaded_image_info   image descriptor
 151  * @image_type          field Subsystem of the optional header for
 152  *                      Windows specific field
 153  */
 154 static void efi_set_code_and_data_type(
 155                         struct efi_loaded_image *loaded_image_info,
 156                         uint16_t image_type)
 157 {
 158         switch (image_type) {
 159         case IMAGE_SUBSYSTEM_EFI_APPLICATION:
 160                 loaded_image_info->image_code_type = EFI_LOADER_CODE;
 161                 loaded_image_info->image_data_type = EFI_LOADER_DATA;
 162                 break;
 163         case IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER:
 164                 loaded_image_info->image_code_type = EFI_BOOT_SERVICES_CODE;
 165                 loaded_image_info->image_data_type = EFI_BOOT_SERVICES_DATA;
 166                 break;
 167         case IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER:
 168         case IMAGE_SUBSYSTEM_EFI_ROM:
 169                 loaded_image_info->image_code_type = EFI_RUNTIME_SERVICES_CODE;
 170                 loaded_image_info->image_data_type = EFI_RUNTIME_SERVICES_DATA;
 171                 break;
 172         default:
 173                 printf("%s: invalid image type: %u\n", __func__, image_type);
 174                 /* Let's assume it is an application */
 175                 loaded_image_info->image_code_type = EFI_LOADER_CODE;
 176                 loaded_image_info->image_data_type = EFI_LOADER_DATA;
 177                 break;
 178         }
 179 }
 180
 181 /*
 182  * This function loads all sections from a PE binary into a newly reserved
 183  * piece of memory. On successful load it then returns the entry point for
 184  * the binary. Otherwise NULL.
 185  */
 186 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info)
 187 {
 188         IMAGE_NT_HEADERS32 *nt;
 189         IMAGE_DOS_HEADER *dos;
 190         IMAGE_SECTION_HEADER *sections;
 191         int num_sections;
 192         void *efi_reloc;
 193         int i;
 194         const IMAGE_BASE_RELOCATION *rel;
 195         unsigned long rel_size;
 196         int rel_idx = IMAGE_DIRECTORY_ENTRY_BASERELOC;
 197         void *entry;
 198         uint64_t image_base;
 199         uint64_t image_size;
 200         unsigned long virt_size = 0;
 201         int supported = 0;
 202
 203         dos = efi;
 204         if (dos->e_magic != IMAGE_DOS_SIGNATURE) {
 205                 printf("%s: Invalid DOS Signature\n", __func__);
 206                 return NULL;
 207         }
 208
 209         nt = (void *) ((char *)efi + dos->e_lfanew);
 210         if (nt->Signature != IMAGE_NT_SIGNATURE) {
 211                 printf("%s: Invalid NT Signature\n", __func__);
 212                 return NULL;
 213         }
 214
 215         for (i = 0; machines[i]; i++)
 216                 if (machines[i] == nt->FileHeader.Machine) {
 217                         supported = 1;
 218                         break;
 219                 }
 220
 221         if (!supported) {
 222                 printf("%s: Machine type 0x%04x is not supported\n",
 223                        __func__, nt->FileHeader.Machine);
 224                 return NULL;
 225         }
 226
 227         /* Calculate upper virtual address boundary */
 228         num_sections = nt->FileHeader.NumberOfSections;
 229         sections = (void *)&nt->OptionalHeader +
 230                             nt->FileHeader.SizeOfOptionalHeader;
 231
 232         for (i = num_sections - 1; i >= 0; i--) {
 233                 IMAGE_SECTION_HEADER *sec = &sections[i];
 234                 virt_size = max_t(unsigned long, virt_size,
 235                                   sec->VirtualAddress + sec->Misc.VirtualSize);
 236         }
 237
 238         /* Read 32/64bit specific header bits */
 239         if (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC) {
 240                 IMAGE_NT_HEADERS64 *nt64 = (void *)nt;
 241                 IMAGE_OPTIONAL_HEADER64 *opt = &nt64->OptionalHeader;
 242                 image_base = opt->ImageBase;
 243                 image_size = opt->SizeOfImage;
 244                 efi_set_code_and_data_type(loaded_image_info, opt->Subsystem);
 245                 efi_reloc = efi_alloc(virt_size,
 246                                       loaded_image_info->image_code_type);
 247                 if (!efi_reloc) {
 248                         printf("%s: Could not allocate %lu bytes\n",
 249                                __func__, virt_size);
 250                         return NULL;
 251                 }
 252                 entry = efi_reloc + opt->AddressOfEntryPoint;
 253                 rel_size = opt->DataDirectory[rel_idx].Size;
 254                 rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
 255                 virt_size = ALIGN(virt_size, opt->SectionAlignment);
 256         } else if (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
 257                 IMAGE_OPTIONAL_HEADER32 *opt = &nt->OptionalHeader;
 258                 image_base = opt->ImageBase;
 259                 image_size = opt->SizeOfImage;
 260                 efi_set_code_and_data_type(loaded_image_info, opt->Subsystem);
 261                 efi_reloc = efi_alloc(virt_size,
 262                                       loaded_image_info->image_code_type);
 263                 if (!efi_reloc) {
 264                         printf("%s: Could not allocate %lu bytes\n",
 265                                __func__, virt_size);
 266                         return NULL;
 267                 }
 268                 entry = efi_reloc + opt->AddressOfEntryPoint;
 269                 rel_size = opt->DataDirectory[rel_idx].Size;
 270                 rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
 271                 virt_size = ALIGN(virt_size, opt->SectionAlignment);
 272         } else {
 273                 printf("%s: Invalid optional header magic %x\n", __func__,
 274                        nt->OptionalHeader.Magic);
 275                 return NULL;
 276         }
 277
 278         /* Load sections into RAM */
 279         for (i = num_sections - 1; i >= 0; i--) {
 280                 IMAGE_SECTION_HEADER *sec = &sections[i];
 281                 memset(efi_reloc + sec->VirtualAddress, 0,
 282                        sec->Misc.VirtualSize);
 283                 memcpy(efi_reloc + sec->VirtualAddress,
 284                        efi + sec->PointerToRawData,
 285                        sec->SizeOfRawData);
 286         }
 287
 288         /* Run through relocations */
 289         if (efi_loader_relocate(rel, rel_size, efi_reloc,
 290                                 (unsigned long)image_base) != EFI_SUCCESS) {
 291                 efi_free_pages((uintptr_t) efi_reloc,
 292                                (virt_size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT);
 293                 return NULL;
 294         }
 295
 296         /* Flush cache */
 297         flush_cache((ulong)efi_reloc,
 298                     ALIGN(virt_size, EFI_CACHELINE_SIZE));
 299         invalidate_icache_all();
 300
 301         /* Populate the loaded image interface bits */
 302         loaded_image_info->image_base = efi;
 303         loaded_image_info->image_size = image_size;
 304         loaded_image_info->reloc_base = efi_reloc;
 305         loaded_image_info->reloc_size = virt_size;
 306
 307         return entry;
 308 }