]> git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BasePeCoffLib/BasePeCoff.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Correctly skip debug entry.
[mirror_edk2.git] / MdePkg / Library / BasePeCoffLib / BasePeCoff.c
1 /** @file
2 Tiano PE/COFF loader.
3
4 This PE/COFF loader supports loading any PE32 or PE32+ image type, but
5 only supports relocating IA32, X64, IPF, and EBC images.
6
7 Copyright (c) 2006, Intel Corporation
8 All rights reserved. This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
12
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15
16 Module Name: PeCoffLoader.c
17
18 **/
19
20
21 /**
22 Performs an Itanium-based specific relocation fixup and is a no-op on other
23 instruction sets.
24
25 @param Reloc Pointer to the relocation record.
26 @param Fixup Pointer to the address to fix up.
27 @param FixupData Pointer to a buffer to log the fixups.
28 @param Adjust The offset to adjust the fixup.
29
30 @return Status code.
31
32 **/
33 RETURN_STATUS
34 PeCoffLoaderRelocateImageEx (
35 IN UINT16 *Reloc,
36 IN OUT CHAR8 *Fixup,
37 IN OUT CHAR8 **FixupData,
38 IN UINT64 Adjust
39 );
40
41
42 /**
43 Performs an Itanium-based specific re-relocation fixup and is a no-op on other
44 instruction sets. This is used to re-relocated the image into the EFI virtual
45 space for runtime calls.
46
47 @param Reloc Pointer to the relocation record.
48 @param Fixup Pointer to the address to fix up.
49 @param FixupData Pointer to a buffer to log the fixups.
50 @param Adjust The offset to adjust the fixup.
51
52 @return Status code.
53
54 **/
55 RETURN_STATUS
56 PeHotRelocateImageEx (
57 IN UINT16 *Reloc,
58 IN OUT CHAR8 *Fixup,
59 IN OUT CHAR8 **FixupData,
60 IN UINT64 Adjust
61 );
62
63
64 /**
65 Returns TRUE if the machine type of PE/COFF image is supported. Supported
66 does not mean the image can be executed it means the PE/COFF loader supports
67 loading and relocating of the image type. It's up to the caller to support
68 the entry point.
69
70 @param Machine Machine type from the PE Header.
71
72 @return TRUE if this PE/COFF loader can load the image
73
74 **/
75 BOOLEAN
76 PeCoffLoaderImageFormatSupported (
77 IN UINT16 Machine
78 );
79
80
81 /**
82 Retrieves the magic value from the PE/COFF header.
83
84 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
85
86 @return EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC - Image is PE32
87 @return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC - Image is PE32+
88
89 **/
90 UINT16
91 PeCoffLoaderGetPeHeaderMagicValue (
92 IN EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
93 )
94 {
95 //
96 // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value
97 // in the PE/COFF Header. If the MachineType is Itanium(IA64) and the
98 // Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
99 // then override the returned value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
100 //
101 if (Hdr.Pe32->FileHeader.Machine == EFI_IMAGE_MACHINE_IA64 && Hdr.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
102 return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
103 }
104 //
105 // Return the magic value from the PC/COFF Optional Header
106 //
107 return Hdr.Pe32->OptionalHeader.Magic;
108 }
109
110
111 /**
112 Retrieves the PE or TE Header from a PE/COFF or TE image.
113
114 @param ImageContext The context of the image being loaded.
115 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
116
117 @retval RETURN_SUCCESS The PE or TE Header is read.
118 @retval Other The error status from reading the PE/COFF or TE image using the ImageRead function.
119
120 **/
121 RETURN_STATUS
122 PeCoffLoaderGetPeHeader (
123 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext,
124 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
125 )
126 {
127 RETURN_STATUS Status;
128 EFI_IMAGE_DOS_HEADER DosHdr;
129 UINTN Size;
130 UINT16 Magic;
131
132 //
133 // Read the DOS image header to check for it's existance
134 //
135 Size = sizeof (EFI_IMAGE_DOS_HEADER);
136 Status = ImageContext->ImageRead (
137 ImageContext->Handle,
138 0,
139 &Size,
140 &DosHdr
141 );
142 if (RETURN_ERROR (Status)) {
143 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
144 return Status;
145 }
146
147 ImageContext->PeCoffHeaderOffset = 0;
148 if (DosHdr.e_magic == EFI_IMAGE_DOS_SIGNATURE) {
149 //
150 // DOS image header is present, so read the PE header after the DOS image
151 // header
152 //
153 ImageContext->PeCoffHeaderOffset = DosHdr.e_lfanew;
154 }
155
156 //
157 // Read the PE/COFF Header. For PE32 (32-bit) this will read in too much
158 // data, but that should not hurt anythine. Hdr.Pe32->OptionalHeader.Magic
159 // determins if this is a PE32 or PE32+ image. The magic is in the same
160 // location in both images.
161 //
162 Size = sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION);
163 Status = ImageContext->ImageRead (
164 ImageContext->Handle,
165 ImageContext->PeCoffHeaderOffset,
166 &Size,
167 Hdr.Pe32
168 );
169 if (RETURN_ERROR (Status)) {
170 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
171 return Status;
172 }
173
174 //
175 // Use Signature to figure out if we understand the image format
176 //
177 if (Hdr.Te->Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {
178 ImageContext->IsTeImage = TRUE;
179 ImageContext->Machine = Hdr.Te->Machine;
180 ImageContext->ImageType = (UINT16)(Hdr.Te->Subsystem);
181 ImageContext->ImageSize = 0;
182 ImageContext->SectionAlignment = 4096;
183 ImageContext->SizeOfHeaders = sizeof (EFI_TE_IMAGE_HEADER) + (UINTN)Hdr.Te->BaseOfCode - (UINTN)Hdr.Te->StrippedSize;
184
185 } else if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE) {
186 ImageContext->IsTeImage = FALSE;
187 ImageContext->Machine = Hdr.Pe32->FileHeader.Machine;
188
189 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
190
191 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
192 //
193 // Use PE32 offset
194 //
195 ImageContext->ImageType = Hdr.Pe32->OptionalHeader.Subsystem;
196 ImageContext->ImageSize = (UINT64)Hdr.Pe32->OptionalHeader.SizeOfImage;
197 ImageContext->SectionAlignment = Hdr.Pe32->OptionalHeader.SectionAlignment;
198 ImageContext->SizeOfHeaders = Hdr.Pe32->OptionalHeader.SizeOfHeaders;
199
200 } else if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {
201 //
202 // Use PE32+ offset
203 //
204 ImageContext->ImageType = Hdr.Pe32Plus->OptionalHeader.Subsystem;
205 ImageContext->ImageSize = (UINT64) Hdr.Pe32Plus->OptionalHeader.SizeOfImage;
206 ImageContext->SectionAlignment = Hdr.Pe32Plus->OptionalHeader.SectionAlignment;
207 ImageContext->SizeOfHeaders = Hdr.Pe32Plus->OptionalHeader.SizeOfHeaders;
208 } else {
209 ImageContext->ImageError = IMAGE_ERROR_INVALID_MACHINE_TYPE;
210 return RETURN_UNSUPPORTED;
211 }
212 } else {
213 ImageContext->ImageError = IMAGE_ERROR_INVALID_MACHINE_TYPE;
214 return RETURN_UNSUPPORTED;
215 }
216
217 if (!PeCoffLoaderImageFormatSupported (ImageContext->Machine)) {
218 //
219 // If the PE/COFF loader does not support the image type return
220 // unsupported. This library can suport lots of types of images
221 // this does not mean the user of this library can call the entry
222 // point of the image.
223 //
224 return RETURN_UNSUPPORTED;
225 }
226
227 return RETURN_SUCCESS;
228 }
229
230
231 /**
232 Retrieves information about a PE/COFF image.
233
234 Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,
235 PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
236 fields of the ImageContext structure. If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
237 If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not
238 a supported PE/COFF image type, then return RETURN_UNSUPPORTED. If any errors occur while
239 computing the fields of ImageContext, then the error status is returned in the ImageError field of
240 ImageContext.
241
242 @param ImageContext Pointer to the image context structure that describes the PE/COFF
243 image that needs to be examined by this function.
244
245 @retval RETURN_SUCCESS The information on the PE/COFF image was collected.
246 @retval RETURN_INVALID_PARAMETER ImageContext is NULL.
247 @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.
248
249 **/
250 RETURN_STATUS
251 EFIAPI
252 PeCoffLoaderGetImageInfo (
253 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
254 )
255 {
256 RETURN_STATUS Status;
257 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData;
258 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
259 EFI_IMAGE_DATA_DIRECTORY *DebugDirectoryEntry;
260 UINTN Size;
261 UINTN Index;
262 UINTN DebugDirectoryEntryRva;
263 UINTN DebugDirectoryEntryFileOffset;
264 UINTN SectionHeaderOffset;
265 EFI_IMAGE_SECTION_HEADER SectionHeader;
266 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY DebugEntry;
267 UINT32 NumberOfRvaAndSizes;
268 UINT16 Magic;
269
270 if (NULL == ImageContext) {
271 return RETURN_INVALID_PARAMETER;
272 }
273 //
274 // Assume success
275 //
276 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;
277
278 Hdr.Union = &HdrData;
279 Status = PeCoffLoaderGetPeHeader (ImageContext, Hdr);
280 if (RETURN_ERROR (Status)) {
281 return Status;
282 }
283
284 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
285
286 //
287 // Retrieve the base address of the image
288 //
289 if (!(ImageContext->IsTeImage)) {
290 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
291 //
292 // Use PE32 offset
293 //
294 ImageContext->ImageAddress = Hdr.Pe32->OptionalHeader.ImageBase;
295 } else {
296 //
297 // Use PE32+ offset
298 //
299 ImageContext->ImageAddress = Hdr.Pe32Plus->OptionalHeader.ImageBase;
300 }
301 } else {
302 ImageContext->ImageAddress = (PHYSICAL_ADDRESS)(Hdr.Te->ImageBase);
303 }
304
305 //
306 // Initialize the alternate destination address to 0 indicating that it
307 // should not be used.
308 //
309 ImageContext->DestinationAddress = 0;
310
311 //
312 // Initialize the codeview pointer.
313 //
314 ImageContext->CodeView = NULL;
315 ImageContext->PdbPointer = NULL;
316
317 //
318 // Three cases with regards to relocations:
319 // - Image has base relocs, RELOCS_STRIPPED==0 => image is relocatable
320 // - Image has no base relocs, RELOCS_STRIPPED==1 => Image is not relocatable
321 // - Image has no base relocs, RELOCS_STRIPPED==0 => Image is relocatable but
322 // has no base relocs to apply
323 // Obviously having base relocations with RELOCS_STRIPPED==1 is invalid.
324 //
325 // Look at the file header to determine if relocations have been stripped, and
326 // save this info in the image context for later use.
327 //
328 if ((!(ImageContext->IsTeImage)) && ((Hdr.Pe32->FileHeader.Characteristics & EFI_IMAGE_FILE_RELOCS_STRIPPED) != 0)) {
329 ImageContext->RelocationsStripped = TRUE;
330 } else {
331 ImageContext->RelocationsStripped = FALSE;
332 }
333
334 if (!(ImageContext->IsTeImage)) {
335 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
336 //
337 // Use PE32 offset
338 //
339 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;
340 DebugDirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);
341 } else {
342 //
343 // Use PE32+ offset
344 //
345 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;
346 DebugDirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);
347 }
348
349 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_DEBUG) {
350
351 DebugDirectoryEntryRva = DebugDirectoryEntry->VirtualAddress;
352
353 //
354 // Determine the file offset of the debug directory... This means we walk
355 // the sections to find which section contains the RVA of the debug
356 // directory
357 //
358 DebugDirectoryEntryFileOffset = 0;
359
360 SectionHeaderOffset = (UINTN)(
361 ImageContext->PeCoffHeaderOffset +
362 sizeof (UINT32) +
363 sizeof (EFI_IMAGE_FILE_HEADER) +
364 Hdr.Pe32->FileHeader.SizeOfOptionalHeader
365 );
366
367 for (Index = 0; Index < Hdr.Pe32->FileHeader.NumberOfSections; Index++) {
368 //
369 // Read section header from file
370 //
371 Size = sizeof (EFI_IMAGE_SECTION_HEADER);
372 Status = ImageContext->ImageRead (
373 ImageContext->Handle,
374 SectionHeaderOffset,
375 &Size,
376 &SectionHeader
377 );
378 if (RETURN_ERROR (Status)) {
379 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
380 return Status;
381 }
382
383 if (DebugDirectoryEntryRva >= SectionHeader.VirtualAddress &&
384 DebugDirectoryEntryRva < SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) {
385
386 DebugDirectoryEntryFileOffset = DebugDirectoryEntryRva - SectionHeader.VirtualAddress + SectionHeader.PointerToRawData;
387 break;
388 }
389
390 SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);
391 }
392
393 if (DebugDirectoryEntryFileOffset != 0) {
394 for (Index = 0; Index < DebugDirectoryEntry->Size; Index += Size) {
395 //
396 // Read next debug directory entry
397 //
398 Size = sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);
399 Status = ImageContext->ImageRead (
400 ImageContext->Handle,
401 DebugDirectoryEntryFileOffset,
402 &Size,
403 &DebugEntry
404 );
405 if (RETURN_ERROR (Status)) {
406 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
407 return Status;
408 }
409 if (DebugEntry.Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {
410 ImageContext->DebugDirectoryEntryRva = (UINT32) (DebugDirectoryEntryRva + Index);
411 if (DebugEntry.RVA == 0 && DebugEntry.FileOffset != 0) {
412 ImageContext->ImageSize += DebugEntry.SizeOfData;
413 }
414
415 return RETURN_SUCCESS;
416 }
417 }
418 }
419 }
420 } else {
421
422 DebugDirectoryEntry = &Hdr.Te->DataDirectory[1];
423 DebugDirectoryEntryRva = DebugDirectoryEntry->VirtualAddress;
424 SectionHeaderOffset = (UINTN)(sizeof (EFI_TE_IMAGE_HEADER));
425
426 DebugDirectoryEntryFileOffset = 0;
427
428 for (Index = 0; Index < Hdr.Te->NumberOfSections;) {
429 //
430 // Read section header from file
431 //
432 Size = sizeof (EFI_IMAGE_SECTION_HEADER);
433 Status = ImageContext->ImageRead (
434 ImageContext->Handle,
435 SectionHeaderOffset,
436 &Size,
437 &SectionHeader
438 );
439 if (RETURN_ERROR (Status)) {
440 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
441 return Status;
442 }
443
444 if (DebugDirectoryEntryRva >= SectionHeader.VirtualAddress &&
445 DebugDirectoryEntryRva < SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) {
446 DebugDirectoryEntryFileOffset = DebugDirectoryEntryRva -
447 SectionHeader.VirtualAddress +
448 SectionHeader.PointerToRawData +
449 sizeof (EFI_TE_IMAGE_HEADER) -
450 Hdr.Te->StrippedSize;
451
452 //
453 // File offset of the debug directory was found, if this is not the last
454 // section, then skip to the last section for calculating the image size.
455 //
456 if (Index < (UINTN) Hdr.Te->NumberOfSections - 1) {
457 SectionHeaderOffset += (Hdr.Te->NumberOfSections - 1 - Index) * sizeof (EFI_IMAGE_SECTION_HEADER);
458 Index = Hdr.Te->NumberOfSections - 1;
459 continue;
460 }
461 }
462
463 //
464 // In Te image header there is not a field to describe the ImageSize.
465 // Actually, the ImageSize equals the RVA plus the VirtualSize of
466 // the last section mapped into memory (Must be rounded up to
467 // a mulitple of Section Alignment). Per the PE/COFF specification, the
468 // section headers in the Section Table must appear in order of the RVA
469 // values for the corresponding sections. So the ImageSize can be determined
470 // by the RVA and the VirtualSize of the last section header in the
471 // Section Table.
472 //
473 if ((++Index) == (UINTN)Hdr.Te->NumberOfSections) {
474 ImageContext->ImageSize = (SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize +
475 ImageContext->SectionAlignment - 1) & ~(ImageContext->SectionAlignment - 1);
476 }
477
478 SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);
479 }
480
481 if (DebugDirectoryEntryFileOffset != 0) {
482 for (Index = 0; Index < DebugDirectoryEntry->Size; Index += Size) {
483 //
484 // Read next debug directory entry
485 //
486 Size = sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);
487 Status = ImageContext->ImageRead (
488 ImageContext->Handle,
489 DebugDirectoryEntryFileOffset,
490 &Size,
491 &DebugEntry
492 );
493 if (RETURN_ERROR (Status)) {
494 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
495 return Status;
496 }
497
498 if (DebugEntry.Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {
499 ImageContext->DebugDirectoryEntryRva = (UINT32) (DebugDirectoryEntryRva + Index);
500 return RETURN_SUCCESS;
501 }
502 }
503 }
504 }
505
506 return RETURN_SUCCESS;
507 }
508
509
510 /**
511 Converts an image address to the loaded address.
512
513 @param ImageContext The context of the image being loaded.
514 @param Address The address to be converted to the loaded address.
515
516 @return The converted address or NULL if the address can not be converted.
517
518 **/
519 VOID *
520 PeCoffLoaderImageAddress (
521 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext,
522 IN UINTN Address
523 )
524 {
525 //
526 // @bug Check to make sure ImageSize is correct for the relocated image.
527 // it may only work for the file we start with and not the relocated image
528 //
529 if (Address >= ImageContext->ImageSize) {
530 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;
531 return NULL;
532 }
533
534 return (CHAR8 *)((UINTN) ImageContext->ImageAddress + Address);
535 }
536
537 /**
538 Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
539
540 If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
541 ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
542 of ImageContext as the relocation base address. The caller must allocate the relocation
543 fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
544 If ImageContext is NULL, then ASSERT().
545
546 @param ImageContext Pointer to the image context structure that describes the PE/COFF
547 image that is being relocated.
548
549 @retval RETURN_SUCCESS The PE/COFF image was relocated.
550 Extended status information is in the ImageError field of ImageContext.
551 @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.
552 Extended status information is in the ImageError field of ImageContext.
553 @retval RETURN_UNSUPPORTED A relocation record type is not supported.
554 Extended status information is in the ImageError field of ImageContext.
555
556 **/
557 RETURN_STATUS
558 EFIAPI
559 PeCoffLoaderRelocateImage (
560 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
561 )
562 {
563 RETURN_STATUS Status;
564 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
565 EFI_IMAGE_DATA_DIRECTORY *RelocDir;
566 UINT64 Adjust;
567 EFI_IMAGE_BASE_RELOCATION *RelocBase;
568 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;
569 UINT16 *Reloc;
570 UINT16 *RelocEnd;
571 CHAR8 *Fixup;
572 CHAR8 *FixupBase;
573 UINT16 *F16;
574 UINT32 *F32;
575 UINT64 *F64;
576 CHAR8 *FixupData;
577 PHYSICAL_ADDRESS BaseAddress;
578 UINT32 NumberOfRvaAndSizes;
579 UINT16 Magic;
580
581 ASSERT (ImageContext != NULL);
582
583 //
584 // Assume success
585 //
586 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;
587
588 //
589 // If there are no relocation entries, then we are done
590 //
591 if (ImageContext->RelocationsStripped) {
592 return RETURN_SUCCESS;
593 }
594
595 //
596 // If the destination address is not 0, use that rather than the
597 // image address as the relocation target.
598 //
599 if (ImageContext->DestinationAddress != 0) {
600 BaseAddress = ImageContext->DestinationAddress;
601 } else {
602 BaseAddress = ImageContext->ImageAddress;
603 }
604
605 if (!(ImageContext->IsTeImage)) {
606 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);
607
608 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
609
610 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
611 //
612 // Use PE32 offset
613 //
614 Adjust = (UINT64)BaseAddress - Hdr.Pe32->OptionalHeader.ImageBase;
615 Hdr.Pe32->OptionalHeader.ImageBase = (UINT32)BaseAddress;
616
617 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;
618 RelocDir = &Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
619 } else {
620 //
621 // Use PE32+ offset
622 //
623 Adjust = (UINT64) BaseAddress - Hdr.Pe32Plus->OptionalHeader.ImageBase;
624 Hdr.Pe32Plus->OptionalHeader.ImageBase = (UINT64)BaseAddress;
625
626 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;
627 RelocDir = &Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
628 }
629
630 //
631 // Find the relocation block
632 // Per the PE/COFF spec, you can't assume that a given data directory
633 // is present in the image. You have to check the NumberOfRvaAndSizes in
634 // the optional header to verify a desired directory entry is there.
635 //
636
637 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {
638 RelocBase = PeCoffLoaderImageAddress (ImageContext, RelocDir->VirtualAddress);
639 RelocBaseEnd = PeCoffLoaderImageAddress (
640 ImageContext,
641 RelocDir->VirtualAddress + RelocDir->Size - 1
642 );
643 } else {
644 //
645 // Set base and end to bypass processing below.
646 //
647 RelocBase = RelocBaseEnd = 0;
648 }
649 } else {
650 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);
651 Adjust = (UINT64) (BaseAddress - Hdr.Te->ImageBase);
652 Hdr.Te->ImageBase = (UINT64) (BaseAddress);
653
654 //
655 // Find the relocation block
656 //
657 RelocDir = &Hdr.Te->DataDirectory[0];
658 RelocBase = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(
659 ImageContext->ImageAddress +
660 RelocDir->VirtualAddress +
661 sizeof(EFI_TE_IMAGE_HEADER) -
662 Hdr.Te->StrippedSize
663 );
664 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *) ((UINTN) RelocBase + (UINTN) RelocDir->Size - 1);
665 }
666
667 //
668 // Run the relocation information and apply the fixups
669 //
670 FixupData = ImageContext->FixupData;
671 while (RelocBase < RelocBaseEnd) {
672
673 Reloc = (UINT16 *) ((CHAR8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));
674 RelocEnd = (UINT16 *) ((CHAR8 *) RelocBase + RelocBase->SizeOfBlock);
675 if (!(ImageContext->IsTeImage)) {
676 FixupBase = PeCoffLoaderImageAddress (ImageContext, RelocBase->VirtualAddress);
677 } else {
678 FixupBase = (CHAR8 *)(UINTN)(ImageContext->ImageAddress +
679 RelocBase->VirtualAddress +
680 sizeof(EFI_TE_IMAGE_HEADER) -
681 Hdr.Te->StrippedSize
682 );
683 }
684
685 if ((CHAR8 *) RelocEnd < (CHAR8 *) ((UINTN) ImageContext->ImageAddress) ||
686 (CHAR8 *) RelocEnd > (CHAR8 *)((UINTN)ImageContext->ImageAddress +
687 (UINTN)ImageContext->ImageSize)) {
688 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;
689 return RETURN_LOAD_ERROR;
690 }
691
692 //
693 // Run this relocation record
694 //
695 while (Reloc < RelocEnd) {
696
697 Fixup = FixupBase + (*Reloc & 0xFFF);
698 switch ((*Reloc) >> 12) {
699 case EFI_IMAGE_REL_BASED_ABSOLUTE:
700 break;
701
702 case EFI_IMAGE_REL_BASED_HIGH:
703 F16 = (UINT16 *) Fixup;
704 *F16 = (UINT16) (*F16 + ((UINT16) ((UINT32) Adjust >> 16)));
705 if (FixupData != NULL) {
706 *(UINT16 *) FixupData = *F16;
707 FixupData = FixupData + sizeof (UINT16);
708 }
709 break;
710
711 case EFI_IMAGE_REL_BASED_LOW:
712 F16 = (UINT16 *) Fixup;
713 *F16 = (UINT16) (*F16 + (UINT16) Adjust);
714 if (FixupData != NULL) {
715 *(UINT16 *) FixupData = *F16;
716 FixupData = FixupData + sizeof (UINT16);
717 }
718 break;
719
720 case EFI_IMAGE_REL_BASED_HIGHLOW:
721 F32 = (UINT32 *) Fixup;
722 *F32 = *F32 + (UINT32) Adjust;
723 if (FixupData != NULL) {
724 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));
725 *(UINT32 *)FixupData = *F32;
726 FixupData = FixupData + sizeof (UINT32);
727 }
728 break;
729
730 case EFI_IMAGE_REL_BASED_DIR64:
731 F64 = (UINT64 *) Fixup;
732 *F64 = *F64 + (UINT64) Adjust;
733 if (FixupData != NULL) {
734 FixupData = ALIGN_POINTER (FixupData, sizeof(UINT64));
735 *(UINT64 *)(FixupData) = *F64;
736 FixupData = FixupData + sizeof(UINT64);
737 }
738 break;
739
740 default:
741 //
742 // The common code does not handle some of the stranger IPF relocations
743 // PeCoffLoaderRelocateImageEx () addes support for these complex fixups
744 // on IPF and is a No-Op on other archtiectures.
745 //
746 Status = PeCoffLoaderRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);
747 if (RETURN_ERROR (Status)) {
748 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;
749 return Status;
750 }
751 }
752
753 //
754 // Next relocation record
755 //
756 Reloc += 1;
757 }
758
759 //
760 // Next reloc block
761 //
762 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;
763 }
764
765 return RETURN_SUCCESS;
766 }
767
768 /**
769 Loads a PE/COFF image into memory.
770
771 Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
772 specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
773 the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
774 The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.
775 If ImageContext is NULL, then ASSERT().
776
777 @param ImageContext Pointer to the image context structure that describes the PE/COFF
778 image that is being loaded.
779
780 @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by
781 the ImageAddress and ImageSize fields of ImageContext.
782 Extended status information is in the ImageError field of ImageContext.
783 @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.
784 Extended status information is in the ImageError field of ImageContext.
785 @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.
786 Extended status information is in the ImageError field of ImageContext.
787 @retval RETURN_INVALID_PARAMETER The image address is invalid.
788 Extended status information is in the ImageError field of ImageContext.
789
790 **/
791 RETURN_STATUS
792 EFIAPI
793 PeCoffLoaderLoadImage (
794 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
795 )
796 {
797 RETURN_STATUS Status;
798 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
799 PE_COFF_LOADER_IMAGE_CONTEXT CheckContext;
800 EFI_IMAGE_SECTION_HEADER *FirstSection;
801 EFI_IMAGE_SECTION_HEADER *Section;
802 UINTN NumberOfSections;
803 UINTN Index;
804 CHAR8 *Base;
805 CHAR8 *End;
806 CHAR8 *MaxEnd;
807 EFI_IMAGE_DATA_DIRECTORY *DirectoryEntry;
808 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *DebugEntry;
809 UINTN Size;
810 UINT32 TempDebugEntryRva;
811 UINT32 NumberOfRvaAndSizes;
812 UINT16 Magic;
813
814 ASSERT (ImageContext != NULL);
815
816 //
817 // Assume success
818 //
819 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;
820
821 //
822 // Copy the provided context info into our local version, get what we
823 // can from the original image, and then use that to make sure everything
824 // is legit.
825 //
826 CopyMem (&CheckContext, ImageContext, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT));
827
828 Status = PeCoffLoaderGetImageInfo (&CheckContext);
829 if (RETURN_ERROR (Status)) {
830 return Status;
831 }
832
833 //
834 // Make sure there is enough allocated space for the image being loaded
835 //
836 if (ImageContext->ImageSize < CheckContext.ImageSize) {
837 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_SIZE;
838 return RETURN_BUFFER_TOO_SMALL;
839 }
840 if (ImageContext->ImageAddress == 0) {
841 //
842 // Image cannot be loaded into 0 address.
843 //
844 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;
845 return RETURN_INVALID_PARAMETER;
846 }
847 //
848 // If there's no relocations, then make sure it's not a runtime driver,
849 // and that it's being loaded at the linked address.
850 //
851 if (CheckContext.RelocationsStripped) {
852 //
853 // If the image does not contain relocations and it is a runtime driver
854 // then return an error.
855 //
856 if (CheckContext.ImageType == EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER) {
857 ImageContext->ImageError = IMAGE_ERROR_INVALID_SUBSYSTEM;
858 return RETURN_LOAD_ERROR;
859 }
860 //
861 // If the image does not contain relocations, and the requested load address
862 // is not the linked address, then return an error.
863 //
864 if (CheckContext.ImageAddress != ImageContext->ImageAddress) {
865 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;
866 return RETURN_INVALID_PARAMETER;
867 }
868 }
869 //
870 // Make sure the allocated space has the proper section alignment
871 //
872 if (!(ImageContext->IsTeImage)) {
873 if ((ImageContext->ImageAddress & (CheckContext.SectionAlignment - 1)) != 0) {
874 ImageContext->ImageError = IMAGE_ERROR_INVALID_SECTION_ALIGNMENT;
875 return RETURN_INVALID_PARAMETER;
876 }
877 }
878 //
879 // Read the entire PE/COFF or TE header into memory
880 //
881 if (!(ImageContext->IsTeImage)) {
882 Status = ImageContext->ImageRead (
883 ImageContext->Handle,
884 0,
885 &ImageContext->SizeOfHeaders,
886 (VOID *) (UINTN) ImageContext->ImageAddress
887 );
888
889 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);
890
891 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (
892 (UINTN)ImageContext->ImageAddress +
893 ImageContext->PeCoffHeaderOffset +
894 sizeof(UINT32) +
895 sizeof(EFI_IMAGE_FILE_HEADER) +
896 Hdr.Pe32->FileHeader.SizeOfOptionalHeader
897 );
898 NumberOfSections = (UINTN) (Hdr.Pe32->FileHeader.NumberOfSections);
899 } else {
900 Status = ImageContext->ImageRead (
901 ImageContext->Handle,
902 0,
903 &ImageContext->SizeOfHeaders,
904 (void *)(UINTN)ImageContext->ImageAddress
905 );
906
907 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);
908
909 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (
910 (UINTN)ImageContext->ImageAddress +
911 sizeof(EFI_TE_IMAGE_HEADER)
912 );
913 NumberOfSections = (UINTN) (Hdr.Te->NumberOfSections);
914
915 }
916
917 if (RETURN_ERROR (Status)) {
918 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
919 return RETURN_LOAD_ERROR;
920 }
921
922 //
923 // Load each section of the image
924 //
925 Section = FirstSection;
926 for (Index = 0, MaxEnd = NULL; Index < NumberOfSections; Index++) {
927
928 //
929 // Compute sections address
930 //
931 Base = PeCoffLoaderImageAddress (ImageContext, Section->VirtualAddress);
932 End = PeCoffLoaderImageAddress (
933 ImageContext,
934 Section->VirtualAddress + Section->Misc.VirtualSize - 1
935 );
936 if (ImageContext->IsTeImage) {
937 Base = (CHAR8 *)((UINTN) Base + sizeof (EFI_TE_IMAGE_HEADER) - (UINTN)Hdr.Te->StrippedSize);
938 End = (CHAR8 *)((UINTN) End + sizeof (EFI_TE_IMAGE_HEADER) - (UINTN)Hdr.Te->StrippedSize);
939 }
940
941 if (End > MaxEnd) {
942 MaxEnd = End;
943 }
944 //
945 // If the base start or end address resolved to 0, then fail.
946 //
947 if ((Base == NULL) || (End == NULL)) {
948 ImageContext->ImageError = IMAGE_ERROR_SECTION_NOT_LOADED;
949 return RETURN_LOAD_ERROR;
950 }
951
952 //
953 // Read the section
954 //
955 Size = (UINTN) Section->Misc.VirtualSize;
956 if ((Size == 0) || (Size > Section->SizeOfRawData)) {
957 Size = (UINTN) Section->SizeOfRawData;
958 }
959
960 if (Section->SizeOfRawData) {
961 if (!(ImageContext->IsTeImage)) {
962 Status = ImageContext->ImageRead (
963 ImageContext->Handle,
964 Section->PointerToRawData,
965 &Size,
966 Base
967 );
968 } else {
969 Status = ImageContext->ImageRead (
970 ImageContext->Handle,
971 Section->PointerToRawData + sizeof (EFI_TE_IMAGE_HEADER) - (UINTN)Hdr.Te->StrippedSize,
972 &Size,
973 Base
974 );
975 }
976
977 if (RETURN_ERROR (Status)) {
978 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
979 return Status;
980 }
981 }
982
983 //
984 // If raw size is less then virt size, zero fill the remaining
985 //
986
987 if (Size < Section->Misc.VirtualSize) {
988 ZeroMem (Base + Size, Section->Misc.VirtualSize - Size);
989 }
990
991 //
992 // Next Section
993 //
994 Section += 1;
995 }
996
997 //
998 // Get image's entry point
999 //
1000 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
1001 if (!(ImageContext->IsTeImage)) {
1002 //
1003 // Sizes of AddressOfEntryPoint are different so we need to do this safely
1004 //
1005 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1006 //
1007 // Use PE32 offset
1008 //
1009 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (
1010 ImageContext,
1011 (UINTN)Hdr.Pe32->OptionalHeader.AddressOfEntryPoint
1012 );
1013 } else {
1014 //
1015 // Use PE32+ offset
1016 //
1017 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (
1018 ImageContext,
1019 (UINTN)Hdr.Pe32Plus->OptionalHeader.AddressOfEntryPoint
1020 );
1021 }
1022 } else {
1023 ImageContext->EntryPoint = (PHYSICAL_ADDRESS) (
1024 (UINTN)ImageContext->ImageAddress +
1025 (UINTN)Hdr.Te->AddressOfEntryPoint +
1026 (UINTN)sizeof(EFI_TE_IMAGE_HEADER) -
1027 (UINTN)Hdr.Te->StrippedSize
1028 );
1029 }
1030
1031 //
1032 // Determine the size of the fixup data
1033 //
1034 // Per the PE/COFF spec, you can't assume that a given data directory
1035 // is present in the image. You have to check the NumberOfRvaAndSizes in
1036 // the optional header to verify a desired directory entry is there.
1037 //
1038 if (!(ImageContext->IsTeImage)) {
1039 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1040 //
1041 // Use PE32 offset
1042 //
1043 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;
1044 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
1045 } else {
1046 //
1047 // Use PE32+ offset
1048 //
1049 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;
1050 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
1051 }
1052
1053 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {
1054 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINTN);
1055 } else {
1056 ImageContext->FixupDataSize = 0;
1057 }
1058 } else {
1059 DirectoryEntry = &Hdr.Te->DataDirectory[0];
1060 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINTN);
1061 }
1062 //
1063 // Consumer must allocate a buffer for the relocation fixup log.
1064 // Only used for runtime drivers.
1065 //
1066 ImageContext->FixupData = NULL;
1067
1068 //
1069 // Load the Codeview info if present
1070 //
1071 if (ImageContext->DebugDirectoryEntryRva != 0) {
1072 if (!(ImageContext->IsTeImage)) {
1073 DebugEntry = PeCoffLoaderImageAddress (
1074 ImageContext,
1075 ImageContext->DebugDirectoryEntryRva
1076 );
1077 } else {
1078 DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *)(UINTN)(
1079 ImageContext->ImageAddress +
1080 ImageContext->DebugDirectoryEntryRva +
1081 sizeof(EFI_TE_IMAGE_HEADER) -
1082 Hdr.Te->StrippedSize
1083 );
1084 }
1085
1086 if (DebugEntry != NULL) {
1087 TempDebugEntryRva = DebugEntry->RVA;
1088 if (DebugEntry->RVA == 0 && DebugEntry->FileOffset != 0) {
1089 Section--;
1090 if ((UINTN)Section->SizeOfRawData < Section->Misc.VirtualSize) {
1091 TempDebugEntryRva = Section->VirtualAddress + Section->Misc.VirtualSize;
1092 } else {
1093 TempDebugEntryRva = Section->VirtualAddress + Section->SizeOfRawData;
1094 }
1095 }
1096
1097 if (TempDebugEntryRva != 0) {
1098 if (!(ImageContext->IsTeImage)) {
1099 ImageContext->CodeView = PeCoffLoaderImageAddress (ImageContext, TempDebugEntryRva);
1100 } else {
1101 ImageContext->CodeView = (VOID *)(
1102 (UINTN)ImageContext->ImageAddress +
1103 (UINTN)TempDebugEntryRva +
1104 (UINTN)sizeof (EFI_TE_IMAGE_HEADER) -
1105 (UINTN) Hdr.Te->StrippedSize
1106 );
1107 }
1108
1109 if (ImageContext->CodeView == NULL) {
1110 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
1111 return RETURN_LOAD_ERROR;
1112 }
1113
1114 if (DebugEntry->RVA == 0) {
1115 Size = DebugEntry->SizeOfData;
1116 if (!(ImageContext->IsTeImage)) {
1117 Status = ImageContext->ImageRead (
1118 ImageContext->Handle,
1119 DebugEntry->FileOffset,
1120 &Size,
1121 ImageContext->CodeView
1122 );
1123 } else {
1124 Status = ImageContext->ImageRead (
1125 ImageContext->Handle,
1126 DebugEntry->FileOffset + sizeof (EFI_TE_IMAGE_HEADER) - Hdr.Te->StrippedSize,
1127 &Size,
1128 ImageContext->CodeView
1129 );
1130 //
1131 // Should we apply fix up to this field according to the size difference between PE and TE?
1132 // Because now we maintain TE header fields unfixed, this field will also remain as they are
1133 // in original PE image.
1134 //
1135 }
1136
1137 if (RETURN_ERROR (Status)) {
1138 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
1139 return RETURN_LOAD_ERROR;
1140 }
1141
1142 DebugEntry->RVA = TempDebugEntryRva;
1143 }
1144
1145 switch (*(UINT32 *) ImageContext->CodeView) {
1146 case CODEVIEW_SIGNATURE_NB10:
1147 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);
1148 break;
1149
1150 case CODEVIEW_SIGNATURE_RSDS:
1151 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);
1152 break;
1153
1154 default:
1155 break;
1156 }
1157 }
1158 }
1159 }
1160
1161 return Status;
1162 }
1163
1164
1165 /**
1166 Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
1167 runtime.
1168
1169 PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply
1170 the fixups with a virtual mapping.
1171
1172
1173 @param ImageBase Base address of relocated image
1174 @param VirtImageBase Virtual mapping for ImageBase
1175 @param ImageSize Size of the image to relocate
1176 @param RelocationData Location to place results of read
1177
1178 **/
1179 VOID
1180 EFIAPI
1181 PeCoffLoaderRelocateImageForRuntime (
1182 IN PHYSICAL_ADDRESS ImageBase,
1183 IN PHYSICAL_ADDRESS VirtImageBase,
1184 IN UINTN ImageSize,
1185 IN VOID *RelocationData
1186 )
1187 {
1188 CHAR8 *OldBase;
1189 CHAR8 *NewBase;
1190 EFI_IMAGE_DOS_HEADER *DosHdr;
1191 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
1192 UINT32 NumberOfRvaAndSizes;
1193 EFI_IMAGE_DATA_DIRECTORY *DataDirectory;
1194 EFI_IMAGE_DATA_DIRECTORY *RelocDir;
1195 EFI_IMAGE_BASE_RELOCATION *RelocBase;
1196 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;
1197 UINT16 *Reloc;
1198 UINT16 *RelocEnd;
1199 CHAR8 *Fixup;
1200 CHAR8 *FixupBase;
1201 UINT16 *F16;
1202 UINT32 *F32;
1203 UINT64 *F64;
1204 CHAR8 *FixupData;
1205 UINTN Adjust;
1206 RETURN_STATUS Status;
1207 UINT16 Magic;
1208
1209 OldBase = (CHAR8 *)((UINTN)ImageBase);
1210 NewBase = (CHAR8 *)((UINTN)VirtImageBase);
1211 Adjust = (UINTN) NewBase - (UINTN) OldBase;
1212
1213 //
1214 // Find the image's relocate dir info
1215 //
1216 DosHdr = (EFI_IMAGE_DOS_HEADER *)OldBase;
1217 if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {
1218 //
1219 // Valid DOS header so get address of PE header
1220 //
1221 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)(((CHAR8 *)DosHdr) + DosHdr->e_lfanew);
1222 } else {
1223 //
1224 // No Dos header so assume image starts with PE header.
1225 //
1226 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)OldBase;
1227 }
1228
1229 if (Hdr.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {
1230 //
1231 // Not a valid PE image so Exit
1232 //
1233 return ;
1234 }
1235
1236 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
1237
1238 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1239 //
1240 // Use PE32 offset
1241 //
1242 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;
1243 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32->OptionalHeader.DataDirectory[0]);
1244 } else {
1245 //
1246 // Use PE32+ offset
1247 //
1248 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;
1249 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32Plus->OptionalHeader.DataDirectory[0]);
1250 }
1251
1252 //
1253 // Find the relocation block
1254 //
1255 // Per the PE/COFF spec, you can't assume that a given data directory
1256 // is present in the image. You have to check the NumberOfRvaAndSizes in
1257 // the optional header to verify a desired directory entry is there.
1258 //
1259 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {
1260 RelocDir = DataDirectory + EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC;
1261 RelocBase = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress);
1262 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress + RelocDir->Size);
1263 } else {
1264 //
1265 // Cannot find relocations, cannot continue
1266 //
1267 ASSERT (FALSE);
1268 return ;
1269 }
1270
1271 ASSERT (RelocBase != NULL && RelocBaseEnd != NULL);
1272
1273 //
1274 // Run the whole relocation block. And re-fixup data that has not been
1275 // modified. The FixupData is used to see if the image has been modified
1276 // since it was relocated. This is so data sections that have been updated
1277 // by code will not be fixed up, since that would set them back to
1278 // defaults.
1279 //
1280 FixupData = RelocationData;
1281 while (RelocBase < RelocBaseEnd) {
1282
1283 Reloc = (UINT16 *) ((UINT8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));
1284 RelocEnd = (UINT16 *) ((UINT8 *) RelocBase + RelocBase->SizeOfBlock);
1285 FixupBase = (CHAR8 *) ((UINTN)ImageBase) + RelocBase->VirtualAddress;
1286
1287 //
1288 // Run this relocation record
1289 //
1290 while (Reloc < RelocEnd) {
1291
1292 Fixup = FixupBase + (*Reloc & 0xFFF);
1293 switch ((*Reloc) >> 12) {
1294
1295 case EFI_IMAGE_REL_BASED_ABSOLUTE:
1296 break;
1297
1298 case EFI_IMAGE_REL_BASED_HIGH:
1299 F16 = (UINT16 *) Fixup;
1300 if (*(UINT16 *) FixupData == *F16) {
1301 *F16 = (UINT16) (*F16 + ((UINT16) ((UINT32) Adjust >> 16)));
1302 }
1303
1304 FixupData = FixupData + sizeof (UINT16);
1305 break;
1306
1307 case EFI_IMAGE_REL_BASED_LOW:
1308 F16 = (UINT16 *) Fixup;
1309 if (*(UINT16 *) FixupData == *F16) {
1310 *F16 = (UINT16) (*F16 + ((UINT16) Adjust & 0xffff));
1311 }
1312
1313 FixupData = FixupData + sizeof (UINT16);
1314 break;
1315
1316 case EFI_IMAGE_REL_BASED_HIGHLOW:
1317 F32 = (UINT32 *) Fixup;
1318 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));
1319 if (*(UINT32 *) FixupData == *F32) {
1320 *F32 = *F32 + (UINT32) Adjust;
1321 }
1322
1323 FixupData = FixupData + sizeof (UINT32);
1324 break;
1325
1326 case EFI_IMAGE_REL_BASED_DIR64:
1327 F64 = (UINT64 *)Fixup;
1328 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT64));
1329 if (*(UINT64 *) FixupData == *F64) {
1330 *F64 = *F64 + (UINT64)Adjust;
1331 }
1332
1333 FixupData = FixupData + sizeof (UINT64);
1334 break;
1335
1336 case EFI_IMAGE_REL_BASED_HIGHADJ:
1337 //
1338 // Not implemented, but not used in EFI 1.0
1339 //
1340 ASSERT (FALSE);
1341 break;
1342
1343 default:
1344 //
1345 // Only Itanium requires ConvertPeImage_Ex
1346 //
1347 Status = PeHotRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);
1348 if (RETURN_ERROR (Status)) {
1349 return ;
1350 }
1351 }
1352 //
1353 // Next relocation record
1354 //
1355 Reloc += 1;
1356 }
1357 //
1358 // next reloc block
1359 //
1360 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;
1361 }
1362 }
1363
1364
1365 /**
1366 ImageRead function that operates on a memory buffer whos base is passed into
1367 FileHandle.
1368
1369 @param FileHandle Ponter to baes of the input stream
1370 @param FileOffset Offset to the start of the buffer
1371 @param ReadSize Number of bytes to copy into the buffer
1372 @param Buffer Location to place results of read
1373
1374 @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into
1375 the buffer.
1376 **/
1377 RETURN_STATUS
1378 EFIAPI
1379 PeCoffLoaderImageReadFromMemory (
1380 IN VOID *FileHandle,
1381 IN UINTN FileOffset,
1382 IN OUT UINTN *ReadSize,
1383 OUT VOID *Buffer
1384 )
1385 {
1386 CopyMem (Buffer, ((UINT8 *)FileHandle) + FileOffset, *ReadSize);
1387 return RETURN_SUCCESS;
1388 }
1389
EFI Development Kit II mirror for PVE