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