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