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