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