]> 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
Add some ASSERT()s to avoid NULL reference.
[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 == EFI_IMAGE_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 address to be converted to the loaded address.
461
462 @return The converted address or NULL if the address can not be converted.
463
464 **/
465 VOID *
466 PeCoffLoaderImageAddress (
467 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext,
468 IN UINTN Address
469 )
470 {
471 //
472 // @bug Check to make sure ImageSize is correct for the relocated image.
473 // it may only work for the file we start with and not the relocated image
474 //
475 if (Address >= ImageContext->ImageSize) {
476 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;
477 return NULL;
478 }
479
480 return (CHAR8 *)((UINTN) ImageContext->ImageAddress + Address);
481 }
482
483 /**
484 Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().
485
486 If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of
487 ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
488 of ImageContext as the relocation base address. The caller must allocate the relocation
489 fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
490
491 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
492 ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
493 DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
494 the ImageContext structure must be valid prior to invoking this service.
495
496 If ImageContext is NULL, then ASSERT().
497
498 @param ImageContext Pointer to the image context structure that describes the PE/COFF
499 image that is being relocated.
500
501 @retval RETURN_SUCCESS The PE/COFF image was relocated.
502 Extended status information is in the ImageError field of ImageContext.
503 @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.
504 Extended status information is in the ImageError field of ImageContext.
505 @retval RETURN_UNSUPPORTED A relocation record type is not supported.
506 Extended status information is in the ImageError field of ImageContext.
507
508 **/
509 RETURN_STATUS
510 EFIAPI
511 PeCoffLoaderRelocateImage (
512 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
513 )
514 {
515 RETURN_STATUS Status;
516 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
517 EFI_IMAGE_DATA_DIRECTORY *RelocDir;
518 UINT64 Adjust;
519 EFI_IMAGE_BASE_RELOCATION *RelocBase;
520 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;
521 UINT16 *Reloc;
522 UINT16 *RelocEnd;
523 CHAR8 *Fixup;
524 CHAR8 *FixupBase;
525 UINT16 *Fixup16;
526 UINT32 *Fixup32;
527 UINT64 *Fixup64;
528 CHAR8 *FixupData;
529 PHYSICAL_ADDRESS BaseAddress;
530 UINT32 NumberOfRvaAndSizes;
531 UINT16 Magic;
532
533 ASSERT (ImageContext != NULL);
534
535 //
536 // Assume success
537 //
538 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;
539
540 //
541 // If there are no relocation entries, then we are done
542 //
543 if (ImageContext->RelocationsStripped) {
544 return RETURN_SUCCESS;
545 }
546
547 //
548 // If the destination address is not 0, use that rather than the
549 // image address as the relocation target.
550 //
551 if (ImageContext->DestinationAddress != 0) {
552 BaseAddress = ImageContext->DestinationAddress;
553 } else {
554 BaseAddress = ImageContext->ImageAddress;
555 }
556
557 if (!(ImageContext->IsTeImage)) {
558 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);
559
560 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
561
562 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
563 //
564 // Use PE32 offset
565 //
566 Adjust = (UINT64)BaseAddress - Hdr.Pe32->OptionalHeader.ImageBase;
567 Hdr.Pe32->OptionalHeader.ImageBase = (UINT32)BaseAddress;
568
569 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;
570 RelocDir = &Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
571 } else {
572 //
573 // Use PE32+ offset
574 //
575 Adjust = (UINT64) BaseAddress - Hdr.Pe32Plus->OptionalHeader.ImageBase;
576 Hdr.Pe32Plus->OptionalHeader.ImageBase = (UINT64)BaseAddress;
577
578 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;
579 RelocDir = &Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
580 }
581
582 //
583 // Find the relocation block
584 // Per the PE/COFF spec, you can't assume that a given data directory
585 // is present in the image. You have to check the NumberOfRvaAndSizes in
586 // the optional header to verify a desired directory entry is there.
587 //
588
589 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {
590 RelocBase = PeCoffLoaderImageAddress (ImageContext, RelocDir->VirtualAddress);
591 ASSERT(RelocBase != NULL);
592 RelocBaseEnd = PeCoffLoaderImageAddress (
593 ImageContext,
594 RelocDir->VirtualAddress + RelocDir->Size - 1
595 );
596 ASSERT(RelocBaseEnd !=NULL);
597 } else {
598 //
599 // Set base and end to bypass processing below.
600 //
601 RelocBase = RelocBaseEnd = 0;
602 }
603 } else {
604 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);
605 Adjust = (UINT64) (BaseAddress - Hdr.Te->StrippedSize + sizeof (EFI_TE_IMAGE_HEADER) - Hdr.Te->ImageBase);
606 Hdr.Te->ImageBase = (UINT64) (BaseAddress - Hdr.Te->StrippedSize + sizeof (EFI_TE_IMAGE_HEADER));
607
608 //
609 // Find the relocation block
610 //
611 RelocDir = &Hdr.Te->DataDirectory[0];
612 RelocBase = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(
613 ImageContext->ImageAddress +
614 RelocDir->VirtualAddress +
615 sizeof(EFI_TE_IMAGE_HEADER) -
616 Hdr.Te->StrippedSize
617 );
618 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *) ((UINTN) RelocBase + (UINTN) RelocDir->Size - 1);
619 }
620
621 //
622 // Run the relocation information and apply the fixups
623 //
624 FixupData = ImageContext->FixupData;
625 while (RelocBase < RelocBaseEnd) {
626
627 Reloc = (UINT16 *) ((CHAR8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));
628 RelocEnd = (UINT16 *) ((CHAR8 *) RelocBase + RelocBase->SizeOfBlock);
629 if (!(ImageContext->IsTeImage)) {
630 FixupBase = PeCoffLoaderImageAddress (ImageContext, RelocBase->VirtualAddress);
631 ASSERT(FixupBase != NULL);
632 } else {
633 FixupBase = (CHAR8 *)(UINTN)(ImageContext->ImageAddress +
634 RelocBase->VirtualAddress +
635 sizeof(EFI_TE_IMAGE_HEADER) -
636 Hdr.Te->StrippedSize
637 );
638 }
639
640 if ((CHAR8 *) RelocEnd < (CHAR8 *) ((UINTN) ImageContext->ImageAddress) ||
641 (CHAR8 *) RelocEnd > (CHAR8 *)((UINTN)ImageContext->ImageAddress +
642 (UINTN)ImageContext->ImageSize)) {
643 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;
644 return RETURN_LOAD_ERROR;
645 }
646
647 //
648 // Run this relocation record
649 //
650 while (Reloc < RelocEnd) {
651
652 Fixup = FixupBase + (*Reloc & 0xFFF);
653 switch ((*Reloc) >> 12) {
654 case EFI_IMAGE_REL_BASED_ABSOLUTE:
655 break;
656
657 case EFI_IMAGE_REL_BASED_HIGH:
658 Fixup16 = (UINT16 *) Fixup;
659 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));
660 if (FixupData != NULL) {
661 *(UINT16 *) FixupData = *Fixup16;
662 FixupData = FixupData + sizeof (UINT16);
663 }
664 break;
665
666 case EFI_IMAGE_REL_BASED_LOW:
667 Fixup16 = (UINT16 *) Fixup;
668 *Fixup16 = (UINT16) (*Fixup16 + (UINT16) Adjust);
669 if (FixupData != NULL) {
670 *(UINT16 *) FixupData = *Fixup16;
671 FixupData = FixupData + sizeof (UINT16);
672 }
673 break;
674
675 case EFI_IMAGE_REL_BASED_HIGHLOW:
676 Fixup32 = (UINT32 *) Fixup;
677 *Fixup32 = *Fixup32 + (UINT32) Adjust;
678 if (FixupData != NULL) {
679 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));
680 *(UINT32 *)FixupData = *Fixup32;
681 FixupData = FixupData + sizeof (UINT32);
682 }
683 break;
684
685 case EFI_IMAGE_REL_BASED_DIR64:
686 Fixup64 = (UINT64 *) Fixup;
687 *Fixup64 = *Fixup64 + (UINT64) Adjust;
688 if (FixupData != NULL) {
689 FixupData = ALIGN_POINTER (FixupData, sizeof(UINT64));
690 *(UINT64 *)(FixupData) = *Fixup64;
691 FixupData = FixupData + sizeof(UINT64);
692 }
693 break;
694
695 default:
696 //
697 // The common code does not handle some of the stranger IPF relocations
698 // PeCoffLoaderRelocateImageEx () addes support for these complex fixups
699 // on IPF and is a No-Op on other archtiectures.
700 //
701 Status = PeCoffLoaderRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);
702 if (RETURN_ERROR (Status)) {
703 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;
704 return Status;
705 }
706 }
707
708 //
709 // Next relocation record
710 //
711 Reloc += 1;
712 }
713
714 //
715 // Next reloc block
716 //
717 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;
718 }
719
720 //
721 // Adjust the EntryPoint to match the linked-to address
722 //
723 if (ImageContext->DestinationAddress != 0) {
724 ImageContext->EntryPoint -= (UINT64) ImageContext->ImageAddress;
725 ImageContext->EntryPoint += (UINT64) ImageContext->DestinationAddress;
726 }
727 return RETURN_SUCCESS;
728 }
729
730 /**
731 Loads a PE/COFF image into memory.
732
733 Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer
734 specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
735 the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
736 The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.
737 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
738 DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
739 fields of the ImageContext structure must be valid prior to invoking this service.
740
741 If ImageContext is NULL, then ASSERT().
742
743 @param ImageContext Pointer to the image context structure that describes the PE/COFF
744 image that is being loaded.
745
746 @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by
747 the ImageAddress and ImageSize fields of ImageContext.
748 Extended status information is in the ImageError field of ImageContext.
749 @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.
750 Extended status information is in the ImageError field of ImageContext.
751 @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.
752 Extended status information is in the ImageError field of ImageContext.
753 @retval RETURN_INVALID_PARAMETER The image address is invalid.
754 Extended status information is in the ImageError field of ImageContext.
755
756 **/
757 RETURN_STATUS
758 EFIAPI
759 PeCoffLoaderLoadImage (
760 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
761 )
762 {
763 RETURN_STATUS Status;
764 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
765 PE_COFF_LOADER_IMAGE_CONTEXT CheckContext;
766 EFI_IMAGE_SECTION_HEADER *FirstSection;
767 EFI_IMAGE_SECTION_HEADER *Section;
768 UINTN NumberOfSections;
769 UINTN Index;
770 CHAR8 *Base;
771 CHAR8 *End;
772 CHAR8 *MaxEnd;
773 EFI_IMAGE_DATA_DIRECTORY *DirectoryEntry;
774 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *DebugEntry;
775 UINTN Size;
776 UINT32 TempDebugEntryRva;
777 UINT32 NumberOfRvaAndSizes;
778 UINT16 Magic;
779
780 ASSERT (ImageContext != NULL);
781
782 //
783 // Assume success
784 //
785 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;
786
787 //
788 // Copy the provided context info into our local version, get what we
789 // can from the original image, and then use that to make sure everything
790 // is legit.
791 //
792 CopyMem (&CheckContext, ImageContext, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT));
793
794 Status = PeCoffLoaderGetImageInfo (&CheckContext);
795 if (RETURN_ERROR (Status)) {
796 return Status;
797 }
798
799 //
800 // Make sure there is enough allocated space for the image being loaded
801 //
802 if (ImageContext->ImageSize < CheckContext.ImageSize) {
803 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_SIZE;
804 return RETURN_BUFFER_TOO_SMALL;
805 }
806 if (ImageContext->ImageAddress == 0) {
807 //
808 // Image cannot be loaded into 0 address.
809 //
810 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;
811 return RETURN_INVALID_PARAMETER;
812 }
813 //
814 // If there's no relocations, then make sure it's not a runtime driver,
815 // and that it's being loaded at the linked address.
816 //
817 if (CheckContext.RelocationsStripped) {
818 //
819 // If the image does not contain relocations and it is a runtime driver
820 // then return an error.
821 //
822 if (CheckContext.ImageType == EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER) {
823 ImageContext->ImageError = IMAGE_ERROR_INVALID_SUBSYSTEM;
824 return RETURN_LOAD_ERROR;
825 }
826 //
827 // If the image does not contain relocations, and the requested load address
828 // is not the linked address, then return an error.
829 //
830 if (CheckContext.ImageAddress != ImageContext->ImageAddress) {
831 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;
832 return RETURN_INVALID_PARAMETER;
833 }
834 }
835 //
836 // Make sure the allocated space has the proper section alignment
837 //
838 if (!(ImageContext->IsTeImage)) {
839 if ((ImageContext->ImageAddress & (CheckContext.SectionAlignment - 1)) != 0) {
840 ImageContext->ImageError = IMAGE_ERROR_INVALID_SECTION_ALIGNMENT;
841 return RETURN_INVALID_PARAMETER;
842 }
843 }
844 //
845 // Read the entire PE/COFF or TE header into memory
846 //
847 if (!(ImageContext->IsTeImage)) {
848 Status = ImageContext->ImageRead (
849 ImageContext->Handle,
850 0,
851 &ImageContext->SizeOfHeaders,
852 (VOID *) (UINTN) ImageContext->ImageAddress
853 );
854
855 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);
856
857 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (
858 (UINTN)ImageContext->ImageAddress +
859 ImageContext->PeCoffHeaderOffset +
860 sizeof(UINT32) +
861 sizeof(EFI_IMAGE_FILE_HEADER) +
862 Hdr.Pe32->FileHeader.SizeOfOptionalHeader
863 );
864 NumberOfSections = (UINTN) (Hdr.Pe32->FileHeader.NumberOfSections);
865 } else {
866 Status = ImageContext->ImageRead (
867 ImageContext->Handle,
868 0,
869 &ImageContext->SizeOfHeaders,
870 (void *)(UINTN)ImageContext->ImageAddress
871 );
872
873 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);
874
875 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (
876 (UINTN)ImageContext->ImageAddress +
877 sizeof(EFI_TE_IMAGE_HEADER)
878 );
879 NumberOfSections = (UINTN) (Hdr.Te->NumberOfSections);
880
881 }
882
883 if (RETURN_ERROR (Status)) {
884 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
885 return RETURN_LOAD_ERROR;
886 }
887
888 //
889 // Load each section of the image
890 //
891 Section = FirstSection;
892 for (Index = 0, MaxEnd = NULL; Index < NumberOfSections; Index++) {
893
894 //
895 // Compute sections address
896 //
897 Base = PeCoffLoaderImageAddress (ImageContext, Section->VirtualAddress);
898 End = PeCoffLoaderImageAddress (
899 ImageContext,
900 Section->VirtualAddress + Section->Misc.VirtualSize - 1
901 );
902 if (ImageContext->IsTeImage) {
903 Base = (CHAR8 *)((UINTN) Base + sizeof (EFI_TE_IMAGE_HEADER) - (UINTN)Hdr.Te->StrippedSize);
904 End = (CHAR8 *)((UINTN) End + sizeof (EFI_TE_IMAGE_HEADER) - (UINTN)Hdr.Te->StrippedSize);
905 }
906
907 if (End > MaxEnd) {
908 MaxEnd = End;
909 }
910 //
911 // If the base start or end address resolved to 0, then fail.
912 //
913 if ((Base == NULL) || (End == NULL)) {
914 ImageContext->ImageError = IMAGE_ERROR_SECTION_NOT_LOADED;
915 return RETURN_LOAD_ERROR;
916 }
917
918 //
919 // Read the section
920 //
921 Size = (UINTN) Section->Misc.VirtualSize;
922 if ((Size == 0) || (Size > Section->SizeOfRawData)) {
923 Size = (UINTN) Section->SizeOfRawData;
924 }
925
926 if (Section->SizeOfRawData > 0) {
927 if (!(ImageContext->IsTeImage)) {
928 Status = ImageContext->ImageRead (
929 ImageContext->Handle,
930 Section->PointerToRawData,
931 &Size,
932 Base
933 );
934 } else {
935 Status = ImageContext->ImageRead (
936 ImageContext->Handle,
937 Section->PointerToRawData + sizeof (EFI_TE_IMAGE_HEADER) - (UINTN)Hdr.Te->StrippedSize,
938 &Size,
939 Base
940 );
941 }
942
943 if (RETURN_ERROR (Status)) {
944 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
945 return Status;
946 }
947 }
948
949 //
950 // If raw size is less then virt size, zero fill the remaining
951 //
952
953 if (Size < Section->Misc.VirtualSize) {
954 ZeroMem (Base + Size, Section->Misc.VirtualSize - Size);
955 }
956
957 //
958 // Next Section
959 //
960 Section += 1;
961 }
962
963 //
964 // Get image's entry point
965 //
966 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
967 if (!(ImageContext->IsTeImage)) {
968 //
969 // Sizes of AddressOfEntryPoint are different so we need to do this safely
970 //
971 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
972 //
973 // Use PE32 offset
974 //
975 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (
976 ImageContext,
977 (UINTN)Hdr.Pe32->OptionalHeader.AddressOfEntryPoint
978 );
979 } else {
980 //
981 // Use PE32+ offset
982 //
983 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (
984 ImageContext,
985 (UINTN)Hdr.Pe32Plus->OptionalHeader.AddressOfEntryPoint
986 );
987 }
988 } else {
989 ImageContext->EntryPoint = (PHYSICAL_ADDRESS) (
990 (UINTN)ImageContext->ImageAddress +
991 (UINTN)Hdr.Te->AddressOfEntryPoint +
992 (UINTN)sizeof(EFI_TE_IMAGE_HEADER) -
993 (UINTN)Hdr.Te->StrippedSize
994 );
995 }
996
997 //
998 // Determine the size of the fixup data
999 //
1000 // Per the PE/COFF spec, you can't assume that a given data directory
1001 // is present in the image. You have to check the NumberOfRvaAndSizes in
1002 // the optional header to verify a desired directory entry is there.
1003 //
1004 if (!(ImageContext->IsTeImage)) {
1005 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1006 //
1007 // Use PE32 offset
1008 //
1009 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;
1010 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
1011 } else {
1012 //
1013 // Use PE32+ offset
1014 //
1015 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;
1016 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];
1017 }
1018
1019 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {
1020 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINTN);
1021 } else {
1022 ImageContext->FixupDataSize = 0;
1023 }
1024 } else {
1025 DirectoryEntry = &Hdr.Te->DataDirectory[0];
1026 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINTN);
1027 }
1028 //
1029 // Consumer must allocate a buffer for the relocation fixup log.
1030 // Only used for runtime drivers.
1031 //
1032 ImageContext->FixupData = NULL;
1033
1034 //
1035 // Load the Codeview info if present
1036 //
1037 if (ImageContext->DebugDirectoryEntryRva != 0) {
1038 if (!(ImageContext->IsTeImage)) {
1039 DebugEntry = PeCoffLoaderImageAddress (
1040 ImageContext,
1041 ImageContext->DebugDirectoryEntryRva
1042 );
1043 } else {
1044 DebugEntry = (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *)(UINTN)(
1045 ImageContext->ImageAddress +
1046 ImageContext->DebugDirectoryEntryRva +
1047 sizeof(EFI_TE_IMAGE_HEADER) -
1048 Hdr.Te->StrippedSize
1049 );
1050 }
1051
1052 if (DebugEntry != NULL) {
1053 TempDebugEntryRva = DebugEntry->RVA;
1054 if (DebugEntry->RVA == 0 && DebugEntry->FileOffset != 0) {
1055 Section--;
1056 if ((UINTN)Section->SizeOfRawData < Section->Misc.VirtualSize) {
1057 TempDebugEntryRva = Section->VirtualAddress + Section->Misc.VirtualSize;
1058 } else {
1059 TempDebugEntryRva = Section->VirtualAddress + Section->SizeOfRawData;
1060 }
1061 }
1062
1063 if (TempDebugEntryRva != 0) {
1064 if (!(ImageContext->IsTeImage)) {
1065 ImageContext->CodeView = PeCoffLoaderImageAddress (ImageContext, TempDebugEntryRva);
1066 } else {
1067 ImageContext->CodeView = (VOID *)(
1068 (UINTN)ImageContext->ImageAddress +
1069 (UINTN)TempDebugEntryRva +
1070 (UINTN)sizeof (EFI_TE_IMAGE_HEADER) -
1071 (UINTN) Hdr.Te->StrippedSize
1072 );
1073 }
1074
1075 if (ImageContext->CodeView == NULL) {
1076 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
1077 return RETURN_LOAD_ERROR;
1078 }
1079
1080 if (DebugEntry->RVA == 0) {
1081 Size = DebugEntry->SizeOfData;
1082 if (!(ImageContext->IsTeImage)) {
1083 Status = ImageContext->ImageRead (
1084 ImageContext->Handle,
1085 DebugEntry->FileOffset,
1086 &Size,
1087 ImageContext->CodeView
1088 );
1089 } else {
1090 Status = ImageContext->ImageRead (
1091 ImageContext->Handle,
1092 DebugEntry->FileOffset + sizeof (EFI_TE_IMAGE_HEADER) - Hdr.Te->StrippedSize,
1093 &Size,
1094 ImageContext->CodeView
1095 );
1096 //
1097 // Should we apply fix up to this field according to the size difference between PE and TE?
1098 // Because now we maintain TE header fields unfixed, this field will also remain as they are
1099 // in original PE image.
1100 //
1101 }
1102
1103 if (RETURN_ERROR (Status)) {
1104 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;
1105 return RETURN_LOAD_ERROR;
1106 }
1107
1108 DebugEntry->RVA = TempDebugEntryRva;
1109 }
1110
1111 switch (*(UINT32 *) ImageContext->CodeView) {
1112 case CODEVIEW_SIGNATURE_NB10:
1113 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);
1114 break;
1115
1116 case CODEVIEW_SIGNATURE_RSDS:
1117 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);
1118 break;
1119
1120 default:
1121 break;
1122 }
1123 }
1124 }
1125 }
1126
1127 return Status;
1128 }
1129
1130
1131 /**
1132 Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
1133 runtime.
1134
1135 PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply
1136 the fixups with a virtual mapping.
1137
1138
1139 @param ImageBase Base address of a PE/COFF image that has been loaded
1140 and relocated into system memory.
1141 @param VirtImageBase The request virtual address that the PE/COFF image is to
1142 be fixed up for.
1143 @param ImageSize The size, in bytes, of the PE/COFF image.
1144 @param RelocationData A pointer to the relocation data that was collected when the PE/COFF
1145 image was relocated using PeCoffLoaderRelocateImage().
1146
1147 **/
1148 VOID
1149 EFIAPI
1150 PeCoffLoaderRelocateImageForRuntime (
1151 IN PHYSICAL_ADDRESS ImageBase,
1152 IN PHYSICAL_ADDRESS VirtImageBase,
1153 IN UINTN ImageSize,
1154 IN VOID *RelocationData
1155 )
1156 {
1157 CHAR8 *OldBase;
1158 CHAR8 *NewBase;
1159 EFI_IMAGE_DOS_HEADER *DosHdr;
1160 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;
1161 UINT32 NumberOfRvaAndSizes;
1162 EFI_IMAGE_DATA_DIRECTORY *DataDirectory;
1163 EFI_IMAGE_DATA_DIRECTORY *RelocDir;
1164 EFI_IMAGE_BASE_RELOCATION *RelocBase;
1165 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;
1166 UINT16 *Reloc;
1167 UINT16 *RelocEnd;
1168 CHAR8 *Fixup;
1169 CHAR8 *FixupBase;
1170 UINT16 *Fixup16;
1171 UINT32 *Fixup32;
1172 UINT64 *Fixup64;
1173 CHAR8 *FixupData;
1174 UINTN Adjust;
1175 RETURN_STATUS Status;
1176 UINT16 Magic;
1177
1178 OldBase = (CHAR8 *)((UINTN)ImageBase);
1179 NewBase = (CHAR8 *)((UINTN)VirtImageBase);
1180 Adjust = (UINTN) NewBase - (UINTN) OldBase;
1181
1182 //
1183 // Find the image's relocate dir info
1184 //
1185 DosHdr = (EFI_IMAGE_DOS_HEADER *)OldBase;
1186 if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {
1187 //
1188 // Valid DOS header so get address of PE header
1189 //
1190 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)(((CHAR8 *)DosHdr) + DosHdr->e_lfanew);
1191 } else {
1192 //
1193 // No Dos header so assume image starts with PE header.
1194 //
1195 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)OldBase;
1196 }
1197
1198 if (Hdr.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {
1199 //
1200 // Not a valid PE image so Exit
1201 //
1202 return ;
1203 }
1204
1205 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);
1206
1207 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1208 //
1209 // Use PE32 offset
1210 //
1211 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;
1212 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32->OptionalHeader.DataDirectory[0]);
1213 } else {
1214 //
1215 // Use PE32+ offset
1216 //
1217 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;
1218 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32Plus->OptionalHeader.DataDirectory[0]);
1219 }
1220
1221 //
1222 // Find the relocation block
1223 //
1224 // Per the PE/COFF spec, you can't assume that a given data directory
1225 // is present in the image. You have to check the NumberOfRvaAndSizes in
1226 // the optional header to verify a desired directory entry is there.
1227 //
1228 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {
1229 RelocDir = DataDirectory + EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC;
1230 RelocBase = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress);
1231 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress + RelocDir->Size);
1232 } else {
1233 //
1234 // Cannot find relocations, cannot continue to relocate the image, ASSERT for this invalid image.
1235 //
1236 ASSERT (FALSE);
1237 return ;
1238 }
1239
1240 //
1241 // ASSERT for the invalid image when RelocBase and RelocBaseEnd are both NULL.
1242 //
1243 ASSERT (RelocBase != NULL && RelocBaseEnd != NULL);
1244
1245 //
1246 // Run the whole relocation block. And re-fixup data that has not been
1247 // modified. The FixupData is used to see if the image has been modified
1248 // since it was relocated. This is so data sections that have been updated
1249 // by code will not be fixed up, since that would set them back to
1250 // defaults.
1251 //
1252 FixupData = RelocationData;
1253 while (RelocBase < RelocBaseEnd) {
1254
1255 Reloc = (UINT16 *) ((UINT8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));
1256 RelocEnd = (UINT16 *) ((UINT8 *) RelocBase + RelocBase->SizeOfBlock);
1257 FixupBase = (CHAR8 *) ((UINTN)ImageBase) + RelocBase->VirtualAddress;
1258
1259 //
1260 // Run this relocation record
1261 //
1262 while (Reloc < RelocEnd) {
1263
1264 Fixup = FixupBase + (*Reloc & 0xFFF);
1265 switch ((*Reloc) >> 12) {
1266
1267 case EFI_IMAGE_REL_BASED_ABSOLUTE:
1268 break;
1269
1270 case EFI_IMAGE_REL_BASED_HIGH:
1271 Fixup16 = (UINT16 *) Fixup;
1272 if (*(UINT16 *) FixupData == *Fixup16) {
1273 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));
1274 }
1275
1276 FixupData = FixupData + sizeof (UINT16);
1277 break;
1278
1279 case EFI_IMAGE_REL_BASED_LOW:
1280 Fixup16 = (UINT16 *) Fixup;
1281 if (*(UINT16 *) FixupData == *Fixup16) {
1282 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) Adjust & 0xffff));
1283 }
1284
1285 FixupData = FixupData + sizeof (UINT16);
1286 break;
1287
1288 case EFI_IMAGE_REL_BASED_HIGHLOW:
1289 Fixup32 = (UINT32 *) Fixup;
1290 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));
1291 if (*(UINT32 *) FixupData == *Fixup32) {
1292 *Fixup32 = *Fixup32 + (UINT32) Adjust;
1293 }
1294
1295 FixupData = FixupData + sizeof (UINT32);
1296 break;
1297
1298 case EFI_IMAGE_REL_BASED_DIR64:
1299 Fixup64 = (UINT64 *)Fixup;
1300 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT64));
1301 if (*(UINT64 *) FixupData == *Fixup64) {
1302 *Fixup64 = *Fixup64 + (UINT64)Adjust;
1303 }
1304
1305 FixupData = FixupData + sizeof (UINT64);
1306 break;
1307
1308 case EFI_IMAGE_REL_BASED_HIGHADJ:
1309 //
1310 // Not valid Relocation type for UEFI image, ASSERT
1311 //
1312 ASSERT (FALSE);
1313 break;
1314
1315 default:
1316 //
1317 // Only Itanium requires ConvertPeImage_Ex
1318 //
1319 Status = PeHotRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);
1320 if (RETURN_ERROR (Status)) {
1321 return ;
1322 }
1323 }
1324 //
1325 // Next relocation record
1326 //
1327 Reloc += 1;
1328 }
1329 //
1330 // next reloc block
1331 //
1332 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;
1333 }
1334 }
1335
1336
1337 /**
1338 Reads contents of a PE/COFF image from a buffer in system memory.
1339
1340 This is the default implementation of a PE_COFF_LOADER_READ_FILE function
1341 that assumes FileHandle pointer to the beginning of a PE/COFF image.
1342 This function reads contents of the PE/COFF image that starts at the system memory
1343 address specified by FileHandle. The read operation copies ReadSize bytes from the
1344 PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
1345 The size of the buffer actually read is returned in ReadSize.
1346
1347 If FileHandle is NULL, then ASSERT().
1348 If ReadSize is NULL, then ASSERT().
1349 If Buffer is NULL, then ASSERT().
1350
1351 @param FileHandle Pointer to base of the input stream
1352 @param FileOffset Offset into the PE/COFF image to begin the read operation.
1353 @param ReadSize On input, the size in bytes of the requested read operation.
1354 On output, the number of bytes actually read.
1355 @param Buffer Output buffer that contains the data read from the PE/COFF image.
1356
1357 @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into
1358 the buffer.
1359 **/
1360 RETURN_STATUS
1361 EFIAPI
1362 PeCoffLoaderImageReadFromMemory (
1363 IN VOID *FileHandle,
1364 IN UINTN FileOffset,
1365 IN OUT UINTN *ReadSize,
1366 OUT VOID *Buffer
1367 )
1368 {
1369 ASSERT (ReadSize != NULL);
1370 ASSERT (FileHandle != NULL);
1371 ASSERT (Buffer != NULL);
1372
1373 CopyMem (Buffer, ((UINT8 *)FileHandle) + FileOffset, *ReadSize);
1374 return RETURN_SUCCESS;
1375 }
1376
1377 /**
1378 Unloads a loaded PE/COFF image from memory and releases its taken resource.
1379 Releases any environment specific resources that were allocated when the image
1380 specified by ImageContext was loaded using PeCoffLoaderLoadImage().
1381
1382 For NT32 emulator, the PE/COFF image loaded by system needs to release.
1383 For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
1384 this function can simply return RETURN_SUCCESS.
1385
1386 If ImageContext is NULL, then ASSERT().
1387
1388 @param ImageContext Pointer to the image context structure that describes the PE/COFF
1389 image to be unloaded.
1390
1391 @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.
1392 **/
1393 RETURN_STATUS
1394 EFIAPI
1395 PeCoffLoaderUnloadImage (
1396 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
1397 )
1398 {
1399 return RETURN_SUCCESS;
1400 }
EFI Development Kit II mirror for PVE