]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Library/BasePeCoffLib/BasePeCoff.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
MdePkg: Refine casting expression result to bigger size
[mirror_edk2.git] / MdePkg / Library / BasePeCoffLib / BasePeCoff.c
CommitLineData
d071fb19 1/** @file\r
2bfb6009 2 Base PE/COFF loader supports loading any PE32/PE32+ or TE image, but\r
030cd1a2 3 only supports relocating IA32, x64, IPF, and EBC images.\r
d071fb19 4\r
dc204d5a
JY		 5 Caution: This file requires additional review when modified.\r
6 This library will have external input - PE/COFF image.\r
7 This external input must be validated carefully to avoid security issue like\r
8 buffer overflow, integer overflow.\r
9\r
10 The basic guideline is that caller need provide ImageContext->ImageRead () with the\r
11 necessary data range check, to make sure when this library reads PE/COFF image, the\r
12 PE image buffer is always in valid range.\r
13 This library will also do some additional check for PE header fields.\r
14\r
15 PeCoffLoaderGetPeHeader() routine will do basic check for PE/COFF header.\r
16 PeCoffLoaderGetImageInfo() routine will do basic check for whole PE/COFF image.\r
17\r
95ba3d92 18 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
acf57dec
HT		 19 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
20 This program and the accompanying materials\r
d071fb19 21 are licensed and made available under the terms and conditions of the BSD License\r
22 which accompanies this distribution. The full text of the license may be found at\r
2fc59a00 23 http://opensource.org/licenses/bsd-license.php.\r
d071fb19 24\r
25 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
26 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
27\r
d071fb19 28**/\r
29\r
d071fb19 30#include "BasePeCoffLibInternals.h"\r
31\r
bf29dc16
ED		 32/**\r
33 Adjust some fields in section header for TE image.\r
34\r
35 @param SectionHeader Pointer to the section header.\r
36 @param TeStrippedOffset Size adjust for the TE image.\r
37\r
38**/\r
39VOID\r
40PeCoffLoaderAdjustOffsetForTeImage (\r
41 EFI_IMAGE_SECTION_HEADER *SectionHeader,\r
42 UINT32 TeStrippedOffset\r
43 )\r
44{\r
45 SectionHeader->VirtualAddress -= TeStrippedOffset;\r
46 SectionHeader->PointerToRawData -= TeStrippedOffset;\r
47}\r
48\r
d071fb19 49/**\r
50 Retrieves the magic value from the PE/COFF header.\r
51\r
52 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.\r
53\r
54 @return EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC - Image is PE32\r
55 @return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC - Image is PE32+\r
56\r
57**/\r
58UINT16\r
59PeCoffLoaderGetPeHeaderMagicValue (\r
60 IN EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr\r
61 )\r
62{\r
63 //\r
64 // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value \r
65 // in the PE/COFF Header. If the MachineType is Itanium(IA64) and the \r
66 // Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC\r
67 // then override the returned value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC\r
68 //\r
4ab0dff3 69 if (Hdr.Pe32->FileHeader.Machine == IMAGE_FILE_MACHINE_IA64 && Hdr.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
d071fb19 70 return EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;\r
71 }\r
72 //\r
73 // Return the magic value from the PC/COFF Optional Header\r
74 //\r
75 return Hdr.Pe32->OptionalHeader.Magic;\r
76}\r
77\r
78\r
79/**\r
28186d45 80 Retrieves the PE or TE Header from a PE/COFF or TE image. \r
dc204d5a
JY		 81\r
82 Caution: This function may receive untrusted input.\r
83 PE/COFF image is external input, so this routine will \r
84 also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader, \r
28186d45 85 SizeOfHeader, Section Data Region and Security Data Region be in PE image range. \r
d071fb19 86\r
87 @param ImageContext The context of the image being loaded.\r
88 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.\r
89\r
90 @retval RETURN_SUCCESS The PE or TE Header is read.\r
91 @retval Other The error status from reading the PE/COFF or TE image using the ImageRead function.\r
92\r
93**/\r
94RETURN_STATUS\r
95PeCoffLoaderGetPeHeader (\r
96 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext,\r
97 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr\r
98 )\r
99{\r
100 RETURN_STATUS Status;\r
101 EFI_IMAGE_DOS_HEADER DosHdr;\r
102 UINTN Size;\r
3acb1985 103 UINTN ReadSize;\r
d071fb19 104 UINT16 Magic;\r
28186d45
ED		 105 UINT32 SectionHeaderOffset;\r
106 UINT32 Index;\r
9ca9935a 107 UINT32 HeaderWithoutDataDir;\r
28186d45 108 CHAR8 BufferData;\r
00b7e3e3 109 UINTN NumberOfSections;\r
28186d45 110 EFI_IMAGE_SECTION_HEADER SectionHeader;\r
d071fb19 111\r
112 //\r
50cd68df 113 // Read the DOS image header to check for its existence\r
d071fb19 114 //\r
115 Size = sizeof (EFI_IMAGE_DOS_HEADER);\r
3acb1985 116 ReadSize = Size;\r
d071fb19 117 Status = ImageContext->ImageRead (\r
118 ImageContext->Handle,\r
119 0,\r
120 &Size,\r
121 &DosHdr\r
122 );\r
3acb1985 123 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 124 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 125 if (Size != ReadSize) {\r
126 Status = RETURN_UNSUPPORTED;\r
127 }\r
d071fb19 128 return Status;\r
129 }\r
130\r
131 ImageContext->PeCoffHeaderOffset = 0;\r
132 if (DosHdr.e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
133 //\r
134 // DOS image header is present, so read the PE header after the DOS image\r
135 // header\r
136 //\r
137 ImageContext->PeCoffHeaderOffset = DosHdr.e_lfanew;\r
138 }\r
139\r
140 //\r
141 // Read the PE/COFF Header. For PE32 (32-bit) this will read in too much\r
b4500f6e 142 // data, but that should not hurt anything. Hdr.Pe32->OptionalHeader.Magic\r
143 // determines if this is a PE32 or PE32+ image. The magic is in the same\r
d071fb19 144 // location in both images.\r
145 //\r
146 Size = sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION);\r
3acb1985 147 ReadSize = Size;\r
d071fb19 148 Status = ImageContext->ImageRead (\r
149 ImageContext->Handle,\r
150 ImageContext->PeCoffHeaderOffset,\r
151 &Size,\r
152 Hdr.Pe32\r
153 );\r
3acb1985 154 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 155 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 156 if (Size != ReadSize) {\r
157 Status = RETURN_UNSUPPORTED;\r
158 }\r
d071fb19 159 return Status;\r
160 }\r
161\r
162 //\r
163 // Use Signature to figure out if we understand the image format\r
164 //\r
165 if (Hdr.Te->Signature == EFI_TE_IMAGE_HEADER_SIGNATURE) {\r
166 ImageContext->IsTeImage = TRUE;\r
167 ImageContext->Machine = Hdr.Te->Machine;\r
168 ImageContext->ImageType = (UINT16)(Hdr.Te->Subsystem);\r
2bfb6009
LG		 169 //\r
170 // For TeImage, SectionAlignment is undefined to be set to Zero\r
171 // ImageSize can be calculated.\r
172 //\r
d071fb19 173 ImageContext->ImageSize = 0;\r
2bfb6009 174 ImageContext->SectionAlignment = 0;\r
d071fb19 175 ImageContext->SizeOfHeaders = sizeof (EFI_TE_IMAGE_HEADER) + (UINTN)Hdr.Te->BaseOfCode - (UINTN)Hdr.Te->StrippedSize;\r
176\r
bf29dc16
ED		 177 //\r
178 // Check the StrippedSize.\r
179 //\r
180 if (sizeof (EFI_TE_IMAGE_HEADER) >= (UINT32)Hdr.Te->StrippedSize) {\r
181 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
182 return RETURN_UNSUPPORTED;\r
183 }\r
184\r
185 //\r
186 // Check the SizeOfHeaders field.\r
187 //\r
188 if (Hdr.Te->BaseOfCode <= Hdr.Te->StrippedSize) {\r
189 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
190 return RETURN_UNSUPPORTED;\r
191 }\r
192\r
193 //\r
194 // Read last byte of Hdr.Te->SizeOfHeaders from the file.\r
195 //\r
196 Size = 1;\r
197 ReadSize = Size;\r
198 Status = ImageContext->ImageRead (\r
199 ImageContext->Handle,\r
200 ImageContext->SizeOfHeaders - 1,\r
201 &Size,\r
202 &BufferData\r
203 );\r
204 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
205 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
206 if (Size != ReadSize) {\r
207 Status = RETURN_UNSUPPORTED;\r
208 }\r
209 return Status;\r
210 }\r
211\r
212 //\r
213 // TE Image Data Directory Entry size is non-zero, but the Data Directory Virtual Address is zero.\r
214 // This case is not a valid TE image. \r
215 //\r
216 if ((Hdr.Te->DataDirectory[0].Size != 0 && Hdr.Te->DataDirectory[0].VirtualAddress == 0) ||\r
217 (Hdr.Te->DataDirectory[1].Size != 0 && Hdr.Te->DataDirectory[1].VirtualAddress == 0)) {\r
218 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
219 return RETURN_UNSUPPORTED;\r
220 }\r
d071fb19 221 } else if (Hdr.Pe32->Signature == EFI_IMAGE_NT_SIGNATURE) {\r
222 ImageContext->IsTeImage = FALSE;\r
223 ImageContext->Machine = Hdr.Pe32->FileHeader.Machine;\r
224\r
225 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
226\r
227 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
28186d45 228 //\r
9ca9935a 229 // 1. Check OptionalHeader.NumberOfRvaAndSizes filed.\r
28186d45
ED		 230 //\r
231 if (EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES < Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes) {\r
0054ce56 232 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
28186d45
ED		 233 return RETURN_UNSUPPORTED;\r
234 }\r
235\r
28186d45 236 //\r
9ca9935a
ED		 237 // 2. Check the FileHeader.SizeOfOptionalHeader field.\r
238 // OptionalHeader.NumberOfRvaAndSizes is not bigger than 16, so \r
239 // OptionalHeader.NumberOfRvaAndSizes * sizeof (EFI_IMAGE_DATA_DIRECTORY) will not overflow.\r
28186d45 240 //\r
9ca9935a
ED		 241 HeaderWithoutDataDir = sizeof (EFI_IMAGE_OPTIONAL_HEADER32) - sizeof (EFI_IMAGE_DATA_DIRECTORY) * EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES;\r
242 if (((UINT32)Hdr.Pe32->FileHeader.SizeOfOptionalHeader - HeaderWithoutDataDir) !=\r
243 Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes * sizeof (EFI_IMAGE_DATA_DIRECTORY)) {\r
244 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
245 return RETURN_UNSUPPORTED;\r
246 }\r
247\r
248 SectionHeaderOffset = ImageContext->PeCoffHeaderOffset + sizeof (UINT32) + sizeof (EFI_IMAGE_FILE_HEADER) + Hdr.Pe32->FileHeader.SizeOfOptionalHeader;\r
249 //\r
250 // 3. Check the FileHeader.NumberOfSections field.\r
251 //\r
2080f676
JY		 252 if (Hdr.Pe32->OptionalHeader.SizeOfImage <= SectionHeaderOffset) {\r
253 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
254 return RETURN_UNSUPPORTED;\r
255 }\r
9ca9935a
ED		 256 if ((Hdr.Pe32->OptionalHeader.SizeOfImage - SectionHeaderOffset) / EFI_IMAGE_SIZEOF_SECTION_HEADER <= Hdr.Pe32->FileHeader.NumberOfSections) {\r
257 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
258 return RETURN_UNSUPPORTED;\r
28186d45
ED		 259 }\r
260\r
261 //\r
9ca9935a
ED		 262 // 4. Check the OptionalHeader.SizeOfHeaders field.\r
263 //\r
2080f676
JY		 264 if (Hdr.Pe32->OptionalHeader.SizeOfHeaders <= SectionHeaderOffset) {\r
265 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
266 return RETURN_UNSUPPORTED;\r
267 }\r
268 if (Hdr.Pe32->OptionalHeader.SizeOfHeaders >= Hdr.Pe32->OptionalHeader.SizeOfImage) {\r
269 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
270 return RETURN_UNSUPPORTED;\r
271 }\r
9ca9935a
ED		 272 if ((Hdr.Pe32->OptionalHeader.SizeOfHeaders - SectionHeaderOffset) / EFI_IMAGE_SIZEOF_SECTION_HEADER < (UINT32)Hdr.Pe32->FileHeader.NumberOfSections) {\r
273 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
274 return RETURN_UNSUPPORTED;\r
275 }\r
276\r
277 //\r
278 // 4.2 Read last byte of Hdr.Pe32.OptionalHeader.SizeOfHeaders from the file.\r
28186d45
ED		 279 //\r
280 Size = 1;\r
3acb1985 281 ReadSize = Size;\r
28186d45
ED		 282 Status = ImageContext->ImageRead (\r
283 ImageContext->Handle,\r
284 Hdr.Pe32->OptionalHeader.SizeOfHeaders - 1,\r
285 &Size,\r
286 &BufferData\r
287 );\r
3acb1985 288 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
0054ce56
ED		 289 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
290 if (Size != ReadSize) {\r
291 Status = RETURN_UNSUPPORTED;\r
292 }\r
28186d45
ED		 293 return Status;\r
294 }\r
295\r
296 //\r
297 // Check the EFI_IMAGE_DIRECTORY_ENTRY_SECURITY data.\r
298 // Read the last byte to make sure the data is in the image region.\r
299 // The DataDirectory array begin with 1, not 0, so here use < to compare not <=.\r
300 //\r
301 if (EFI_IMAGE_DIRECTORY_ENTRY_SECURITY < Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes) {\r
302 if (Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size != 0) {\r
303 //\r
304 // Check the member data to avoid overflow.\r
305 //\r
306 if ((UINT32) (~0) - Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].VirtualAddress <\r
307 Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size) {\r
0054ce56
ED		 308 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
309 return RETURN_UNSUPPORTED;\r
28186d45
ED		 310 }\r
311\r
312 //\r
3acb1985 313 // Read last byte of section header from file\r
28186d45
ED		 314 //\r
315 Size = 1;\r
3acb1985 316 ReadSize = Size;\r
28186d45
ED		 317 Status = ImageContext->ImageRead (\r
318 ImageContext->Handle,\r
319 Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].VirtualAddress +\r
320 Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size - 1,\r
321 &Size,\r
322 &BufferData\r
323 );\r
3acb1985 324 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
0054ce56
ED		 325 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
326 if (Size != ReadSize) {\r
327 Status = RETURN_UNSUPPORTED;\r
328 }\r
28186d45
ED		 329 return Status;\r
330 }\r
331 }\r
332 }\r
333\r
d071fb19 334 //\r
335 // Use PE32 offset\r
336 //\r
337 ImageContext->ImageType = Hdr.Pe32->OptionalHeader.Subsystem;\r
338 ImageContext->ImageSize = (UINT64)Hdr.Pe32->OptionalHeader.SizeOfImage;\r
339 ImageContext->SectionAlignment = Hdr.Pe32->OptionalHeader.SectionAlignment;\r
340 ImageContext->SizeOfHeaders = Hdr.Pe32->OptionalHeader.SizeOfHeaders;\r
341\r
342 } else if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {\r
28186d45 343 //\r
9ca9935a 344 // 1. Check FileHeader.NumberOfRvaAndSizes filed.\r
28186d45
ED		 345 //\r
346 if (EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES < Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes) {\r
0054ce56 347 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
28186d45
ED		 348 return RETURN_UNSUPPORTED;\r
349 }\r
9ca9935a
ED		 350 //\r
351 // 2. Check the FileHeader.SizeOfOptionalHeader field.\r
352 // OptionalHeader.NumberOfRvaAndSizes is not bigger than 16, so \r
353 // OptionalHeader.NumberOfRvaAndSizes * sizeof (EFI_IMAGE_DATA_DIRECTORY) will not overflow.\r
354 //\r
355 HeaderWithoutDataDir = sizeof (EFI_IMAGE_OPTIONAL_HEADER64) - sizeof (EFI_IMAGE_DATA_DIRECTORY) * EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES;\r
356 if (((UINT32)Hdr.Pe32Plus->FileHeader.SizeOfOptionalHeader - HeaderWithoutDataDir) !=\r
357 Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes * sizeof (EFI_IMAGE_DATA_DIRECTORY)) {\r
358 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
359 return RETURN_UNSUPPORTED;\r
360 }\r
28186d45 361\r
9ca9935a 362 SectionHeaderOffset = ImageContext->PeCoffHeaderOffset + sizeof (UINT32) + sizeof (EFI_IMAGE_FILE_HEADER) + Hdr.Pe32Plus->FileHeader.SizeOfOptionalHeader;\r
28186d45 363 //\r
9ca9935a 364 // 3. Check the FileHeader.NumberOfSections field.\r
28186d45 365 //\r
2080f676
JY		 366 if (Hdr.Pe32Plus->OptionalHeader.SizeOfImage <= SectionHeaderOffset) {\r
367 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
368 return RETURN_UNSUPPORTED;\r
369 }\r
9ca9935a
ED		 370 if ((Hdr.Pe32Plus->OptionalHeader.SizeOfImage - SectionHeaderOffset) / EFI_IMAGE_SIZEOF_SECTION_HEADER <= Hdr.Pe32Plus->FileHeader.NumberOfSections) {\r
371 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
372 return RETURN_UNSUPPORTED;\r
373 }\r
374\r
375 //\r
376 // 4. Check the OptionalHeader.SizeOfHeaders field.\r
377 //\r
2080f676
JY		 378 if (Hdr.Pe32Plus->OptionalHeader.SizeOfHeaders <= SectionHeaderOffset) {\r
379 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
380 return RETURN_UNSUPPORTED;\r
381 }\r
382 if (Hdr.Pe32Plus->OptionalHeader.SizeOfHeaders >= Hdr.Pe32Plus->OptionalHeader.SizeOfImage) {\r
383 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
384 return RETURN_UNSUPPORTED;\r
385 }\r
9ca9935a
ED		 386 if ((Hdr.Pe32Plus->OptionalHeader.SizeOfHeaders - SectionHeaderOffset) / EFI_IMAGE_SIZEOF_SECTION_HEADER < (UINT32)Hdr.Pe32Plus->FileHeader.NumberOfSections) {\r
387 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
388 return RETURN_UNSUPPORTED;\r
28186d45
ED		 389 }\r
390\r
391 //\r
9ca9935a 392 // 4.2 Read last byte of Hdr.Pe32Plus.OptionalHeader.SizeOfHeaders from the file.\r
28186d45
ED		 393 //\r
394 Size = 1;\r
3acb1985 395 ReadSize = Size;\r
28186d45
ED		 396 Status = ImageContext->ImageRead (\r
397 ImageContext->Handle,\r
398 Hdr.Pe32Plus->OptionalHeader.SizeOfHeaders - 1,\r
399 &Size,\r
400 &BufferData\r
401 );\r
3acb1985 402 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
0054ce56
ED		 403 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
404 if (Size != ReadSize) {\r
405 Status = RETURN_UNSUPPORTED;\r
406 }\r
28186d45
ED		 407 return Status;\r
408 }\r
409\r
410 //\r
411 // Check the EFI_IMAGE_DIRECTORY_ENTRY_SECURITY data.\r
412 // Read the last byte to make sure the data is in the image region.\r
413 // The DataDirectory array begin with 1, not 0, so here use < to compare not <=.\r
414 //\r
415 if (EFI_IMAGE_DIRECTORY_ENTRY_SECURITY < Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes) {\r
416 if (Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size != 0) {\r
417 //\r
418 // Check the member data to avoid overflow.\r
419 //\r
420 if ((UINT32) (~0) - Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].VirtualAddress <\r
421 Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size) {\r
0054ce56
ED		 422 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
423 return RETURN_UNSUPPORTED;\r
28186d45
ED		 424 }\r
425\r
426 //\r
3acb1985 427 // Read last byte of section header from file\r
28186d45
ED		 428 //\r
429 Size = 1;\r
3acb1985 430 ReadSize = Size;\r
28186d45
ED		 431 Status = ImageContext->ImageRead (\r
432 ImageContext->Handle,\r
433 Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].VirtualAddress +\r
434 Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size - 1,\r
435 &Size,\r
436 &BufferData\r
437 );\r
3acb1985 438 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
0054ce56
ED		 439 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
440 if (Size != ReadSize) {\r
441 Status = RETURN_UNSUPPORTED;\r
442 }\r
28186d45
ED		 443 return Status;\r
444 }\r
445 }\r
446 }\r
447\r
d071fb19 448 //\r
449 // Use PE32+ offset\r
450 //\r
451 ImageContext->ImageType = Hdr.Pe32Plus->OptionalHeader.Subsystem;\r
452 ImageContext->ImageSize = (UINT64) Hdr.Pe32Plus->OptionalHeader.SizeOfImage;\r
453 ImageContext->SectionAlignment = Hdr.Pe32Plus->OptionalHeader.SectionAlignment;\r
454 ImageContext->SizeOfHeaders = Hdr.Pe32Plus->OptionalHeader.SizeOfHeaders;\r
455 } else {\r
456 ImageContext->ImageError = IMAGE_ERROR_INVALID_MACHINE_TYPE;\r
457 return RETURN_UNSUPPORTED;\r
458 }\r
459 } else {\r
460 ImageContext->ImageError = IMAGE_ERROR_INVALID_MACHINE_TYPE;\r
461 return RETURN_UNSUPPORTED;\r
462 }\r
463\r
464 if (!PeCoffLoaderImageFormatSupported (ImageContext->Machine)) {\r
465 //\r
466 // If the PE/COFF loader does not support the image type return\r
b4500f6e 467 // unsupported. This library can support lots of types of images\r
d071fb19 468 // this does not mean the user of this library can call the entry\r
469 // point of the image.\r
470 //\r
471 return RETURN_UNSUPPORTED;\r
472 }\r
473\r
28186d45
ED		 474 //\r
475 // Check each section field.\r
476 //\r
00b7e3e3
ED		 477 if (ImageContext->IsTeImage) {\r
478 SectionHeaderOffset = sizeof(EFI_TE_IMAGE_HEADER);\r
479 NumberOfSections = (UINTN) (Hdr.Te->NumberOfSections);\r
480 } else {\r
481 SectionHeaderOffset = ImageContext->PeCoffHeaderOffset + sizeof (UINT32) + sizeof (EFI_IMAGE_FILE_HEADER) + Hdr.Pe32->FileHeader.SizeOfOptionalHeader;\r
482 NumberOfSections = (UINTN) (Hdr.Pe32->FileHeader.NumberOfSections);\r
483 }\r
484\r
485 for (Index = 0; Index < NumberOfSections; Index++) {\r
28186d45
ED		 486 //\r
487 // Read section header from file\r
488 //\r
489 Size = sizeof (EFI_IMAGE_SECTION_HEADER);\r
3acb1985 490 ReadSize = Size;\r
28186d45
ED		 491 Status = ImageContext->ImageRead (\r
492 ImageContext->Handle,\r
493 SectionHeaderOffset,\r
494 &Size,\r
495 &SectionHeader\r
496 );\r
3acb1985 497 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
0054ce56
ED		 498 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
499 if (Size != ReadSize) {\r
500 Status = RETURN_UNSUPPORTED;\r
501 }\r
28186d45
ED		 502 return Status;\r
503 }\r
504\r
bf29dc16
ED		 505 //\r
506 // Adjust some field in Section Header for TE image.\r
507 //\r
508 if (ImageContext->IsTeImage) {\r
509 PeCoffLoaderAdjustOffsetForTeImage (&SectionHeader, (UINT32)Hdr.Te->StrippedSize - sizeof (EFI_TE_IMAGE_HEADER));\r
510 }\r
511\r
28186d45 512 if (SectionHeader.SizeOfRawData > 0) {\r
9ca9935a
ED		 513 //\r
514 // Section data should bigger than the Pe header.\r
515 //\r
516 if (SectionHeader.VirtualAddress < ImageContext->SizeOfHeaders || \r
517 SectionHeader.PointerToRawData < ImageContext->SizeOfHeaders) {\r
518 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
519 return RETURN_UNSUPPORTED;\r
520 }\r
521\r
28186d45
ED		 522 //\r
523 // Check the member data to avoid overflow.\r
524 //\r
525 if ((UINT32) (~0) - SectionHeader.PointerToRawData < SectionHeader.SizeOfRawData) {\r
0054ce56
ED		 526 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
527 return RETURN_UNSUPPORTED;\r
28186d45
ED		 528 }\r
529\r
530 //\r
531 // Base on the ImageRead function to check the section data field.\r
532 // Read the last byte to make sure the data is in the image region.\r
533 //\r
534 Size = 1;\r
3acb1985 535 ReadSize = Size;\r
28186d45
ED		 536 Status = ImageContext->ImageRead (\r
537 ImageContext->Handle,\r
538 SectionHeader.PointerToRawData + SectionHeader.SizeOfRawData - 1,\r
539 &Size,\r
540 &BufferData\r
541 );\r
3acb1985 542 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
0054ce56
ED		 543 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
544 if (Size != ReadSize) {\r
545 Status = RETURN_UNSUPPORTED;\r
546 }\r
28186d45
ED		 547 return Status;\r
548 }\r
549 }\r
550\r
551 //\r
552 // Check next section.\r
553 //\r
554 SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);\r
555 }\r
556\r
d071fb19 557 return RETURN_SUCCESS;\r
558}\r
559\r
560\r
561/**\r
562 Retrieves information about a PE/COFF image.\r
563\r
3ecdcd11
LG		 564 Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, \r
565 DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and \r
566 DebugDirectoryEntryRva fields of the ImageContext structure. \r
567 If ImageContext is NULL, then return RETURN_INVALID_PARAMETER. \r
568 If the PE/COFF image accessed through the ImageRead service in the ImageContext \r
569 structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED. \r
570 If any errors occur while computing the fields of ImageContext, \r
571 then the error status is returned in the ImageError field of ImageContext. \r
572 If the image is a TE image, then SectionAlignment is set to 0.\r
122e2191 573 The ImageRead and Handle fields of ImageContext structure must be valid prior \r
574 to invoking this service.\r
d071fb19 575\r
dc204d5a
JY		 576 Caution: This function may receive untrusted input.\r
577 PE/COFF image is external input, so this routine will \r
578 also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader, \r
28186d45
ED		 579 SizeOfHeader, Section Data Region and Security Data Region be in PE image range. \r
580\r
2fc59a00 581 @param ImageContext The pointer to the image context structure that describes the PE/COFF\r
d071fb19 582 image that needs to be examined by this function.\r
583\r
584 @retval RETURN_SUCCESS The information on the PE/COFF image was collected.\r
585 @retval RETURN_INVALID_PARAMETER ImageContext is NULL.\r
586 @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.\r
587\r
588**/\r
589RETURN_STATUS\r
590EFIAPI\r
591PeCoffLoaderGetImageInfo (\r
efb23117 592 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
d071fb19 593 )\r
594{\r
595 RETURN_STATUS Status;\r
596 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData;\r
597 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
598 EFI_IMAGE_DATA_DIRECTORY *DebugDirectoryEntry;\r
599 UINTN Size;\r
3acb1985 600 UINTN ReadSize;\r
d071fb19 601 UINTN Index;\r
602 UINTN DebugDirectoryEntryRva;\r
603 UINTN DebugDirectoryEntryFileOffset;\r
604 UINTN SectionHeaderOffset;\r
605 EFI_IMAGE_SECTION_HEADER SectionHeader;\r
606 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY DebugEntry;\r
607 UINT32 NumberOfRvaAndSizes;\r
608 UINT16 Magic;\r
bf29dc16 609 UINT32 TeStrippedOffset;\r
d071fb19 610\r
2bfb6009 611 if (ImageContext == NULL) {\r
d071fb19 612 return RETURN_INVALID_PARAMETER;\r
613 }\r
614 //\r
615 // Assume success\r
616 //\r
617 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;\r
618\r
619 Hdr.Union = &HdrData;\r
620 Status = PeCoffLoaderGetPeHeader (ImageContext, Hdr);\r
621 if (RETURN_ERROR (Status)) {\r
622 return Status;\r
623 }\r
624\r
625 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
626\r
627 //\r
628 // Retrieve the base address of the image\r
629 //\r
630 if (!(ImageContext->IsTeImage)) {\r
bf29dc16 631 TeStrippedOffset = 0;\r
d071fb19 632 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
633 //\r
634 // Use PE32 offset\r
635 //\r
636 ImageContext->ImageAddress = Hdr.Pe32->OptionalHeader.ImageBase;\r
637 } else {\r
638 //\r
639 // Use PE32+ offset\r
640 //\r
641 ImageContext->ImageAddress = Hdr.Pe32Plus->OptionalHeader.ImageBase;\r
642 }\r
643 } else {\r
bf29dc16
ED		 644 TeStrippedOffset = (UINT32)Hdr.Te->StrippedSize - sizeof (EFI_TE_IMAGE_HEADER);\r
645 ImageContext->ImageAddress = (PHYSICAL_ADDRESS)(Hdr.Te->ImageBase + TeStrippedOffset);\r
d071fb19 646 }\r
647\r
648 //\r
649 // Initialize the alternate destination address to 0 indicating that it\r
650 // should not be used.\r
651 //\r
652 ImageContext->DestinationAddress = 0;\r
653\r
654 //\r
1a82ed3d 655 // Initialize the debug codeview pointer.\r
d071fb19 656 //\r
1a82ed3d
LG		 657 ImageContext->DebugDirectoryEntryRva = 0;\r
658 ImageContext->CodeView = NULL;\r
659 ImageContext->PdbPointer = NULL;\r
d071fb19 660\r
661 //\r
662 // Three cases with regards to relocations:\r
663 // - Image has base relocs, RELOCS_STRIPPED==0 => image is relocatable\r
664 // - Image has no base relocs, RELOCS_STRIPPED==1 => Image is not relocatable\r
665 // - Image has no base relocs, RELOCS_STRIPPED==0 => Image is relocatable but\r
666 // has no base relocs to apply\r
667 // Obviously having base relocations with RELOCS_STRIPPED==1 is invalid.\r
668 //\r
669 // Look at the file header to determine if relocations have been stripped, and\r
58380e9c 670 // save this information in the image context for later use.\r
d071fb19 671 //\r
672 if ((!(ImageContext->IsTeImage)) && ((Hdr.Pe32->FileHeader.Characteristics & EFI_IMAGE_FILE_RELOCS_STRIPPED) != 0)) {\r
673 ImageContext->RelocationsStripped = TRUE;\r
9626a87e
LG		 674 } else if ((ImageContext->IsTeImage) && (Hdr.Te->DataDirectory[0].Size == 0) && (Hdr.Te->DataDirectory[0].VirtualAddress == 0)) {\r
675 ImageContext->RelocationsStripped = TRUE;\r
d071fb19 676 } else {\r
677 ImageContext->RelocationsStripped = FALSE;\r
678 }\r
679\r
680 if (!(ImageContext->IsTeImage)) {\r
681 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
682 //\r
683 // Use PE32 offset\r
684 //\r
685 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
686 DebugDirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);\r
687 } else {\r
688 //\r
689 // Use PE32+ offset\r
690 //\r
691 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
692 DebugDirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG]);\r
693 }\r
694\r
695 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_DEBUG) {\r
696\r
697 DebugDirectoryEntryRva = DebugDirectoryEntry->VirtualAddress;\r
698\r
699 //\r
700 // Determine the file offset of the debug directory... This means we walk\r
701 // the sections to find which section contains the RVA of the debug\r
702 // directory\r
703 //\r
704 DebugDirectoryEntryFileOffset = 0;\r
705\r
95ba3d92
HW		 706 SectionHeaderOffset = ImageContext->PeCoffHeaderOffset +\r
707 sizeof (UINT32) +\r
708 sizeof (EFI_IMAGE_FILE_HEADER) +\r
709 Hdr.Pe32->FileHeader.SizeOfOptionalHeader;\r
d071fb19 710\r
711 for (Index = 0; Index < Hdr.Pe32->FileHeader.NumberOfSections; Index++) {\r
712 //\r
713 // Read section header from file\r
714 //\r
715 Size = sizeof (EFI_IMAGE_SECTION_HEADER);\r
3acb1985 716 ReadSize = Size;\r
d071fb19 717 Status = ImageContext->ImageRead (\r
718 ImageContext->Handle,\r
719 SectionHeaderOffset,\r
720 &Size,\r
721 &SectionHeader\r
722 );\r
3acb1985 723 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 724 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 725 if (Size != ReadSize) {\r
726 Status = RETURN_UNSUPPORTED;\r
727 }\r
d071fb19 728 return Status;\r
729 }\r
730\r
731 if (DebugDirectoryEntryRva >= SectionHeader.VirtualAddress &&\r
732 DebugDirectoryEntryRva < SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) {\r
733\r
734 DebugDirectoryEntryFileOffset = DebugDirectoryEntryRva - SectionHeader.VirtualAddress + SectionHeader.PointerToRawData;\r
735 break;\r
736 }\r
737\r
738 SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);\r
739 }\r
740\r
741 if (DebugDirectoryEntryFileOffset != 0) {\r
742 for (Index = 0; Index < DebugDirectoryEntry->Size; Index += sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY)) {\r
743 //\r
744 // Read next debug directory entry\r
745 //\r
746 Size = sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);\r
3acb1985 747 ReadSize = Size;\r
d071fb19 748 Status = ImageContext->ImageRead (\r
749 ImageContext->Handle,\r
be30ddf7 750 DebugDirectoryEntryFileOffset + Index,\r
d071fb19 751 &Size,\r
752 &DebugEntry\r
753 );\r
3acb1985 754 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 755 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 756 if (Size != ReadSize) {\r
757 Status = RETURN_UNSUPPORTED;\r
758 }\r
d071fb19 759 return Status;\r
760 }\r
36b48bf6
ED		 761\r
762 //\r
763 // From PeCoff spec, when DebugEntry.RVA == 0 means this debug info will not load into memory.\r
764 // Here we will always load EFI_IMAGE_DEBUG_TYPE_CODEVIEW type debug info. so need adjust the\r
765 // ImageContext->ImageSize when DebugEntry.RVA == 0.\r
766 //\r
d071fb19 767 if (DebugEntry.Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
768 ImageContext->DebugDirectoryEntryRva = (UINT32) (DebugDirectoryEntryRva + Index);\r
769 if (DebugEntry.RVA == 0 && DebugEntry.FileOffset != 0) {\r
770 ImageContext->ImageSize += DebugEntry.SizeOfData;\r
771 }\r
772\r
773 return RETURN_SUCCESS;\r
774 }\r
775 }\r
776 }\r
777 }\r
778 } else {\r
779\r
780 DebugDirectoryEntry = &Hdr.Te->DataDirectory[1];\r
781 DebugDirectoryEntryRva = DebugDirectoryEntry->VirtualAddress;\r
782 SectionHeaderOffset = (UINTN)(sizeof (EFI_TE_IMAGE_HEADER));\r
783\r
784 DebugDirectoryEntryFileOffset = 0;\r
785\r
786 for (Index = 0; Index < Hdr.Te->NumberOfSections;) {\r
787 //\r
788 // Read section header from file\r
789 //\r
790 Size = sizeof (EFI_IMAGE_SECTION_HEADER);\r
3acb1985 791 ReadSize = Size;\r
d071fb19 792 Status = ImageContext->ImageRead (\r
793 ImageContext->Handle,\r
794 SectionHeaderOffset,\r
795 &Size,\r
796 &SectionHeader\r
797 );\r
3acb1985 798 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 799 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 800 if (Size != ReadSize) {\r
801 Status = RETURN_UNSUPPORTED;\r
802 }\r
d071fb19 803 return Status;\r
804 }\r
805\r
806 if (DebugDirectoryEntryRva >= SectionHeader.VirtualAddress &&\r
807 DebugDirectoryEntryRva < SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) {\r
808 DebugDirectoryEntryFileOffset = DebugDirectoryEntryRva -\r
809 SectionHeader.VirtualAddress +\r
bf29dc16
ED		 810 SectionHeader.PointerToRawData -\r
811 TeStrippedOffset;\r
d071fb19 812\r
813 //\r
814 // File offset of the debug directory was found, if this is not the last\r
815 // section, then skip to the last section for calculating the image size.\r
816 //\r
817 if (Index < (UINTN) Hdr.Te->NumberOfSections - 1) {\r
818 SectionHeaderOffset += (Hdr.Te->NumberOfSections - 1 - Index) * sizeof (EFI_IMAGE_SECTION_HEADER);\r
819 Index = Hdr.Te->NumberOfSections - 1;\r
820 continue;\r
821 }\r
822 }\r
823\r
824 //\r
825 // In Te image header there is not a field to describe the ImageSize.\r
826 // Actually, the ImageSize equals the RVA plus the VirtualSize of\r
827 // the last section mapped into memory (Must be rounded up to\r
b4500f6e 828 // a multiple of Section Alignment). Per the PE/COFF specification, the\r
d071fb19 829 // section headers in the Section Table must appear in order of the RVA\r
830 // values for the corresponding sections. So the ImageSize can be determined\r
831 // by the RVA and the VirtualSize of the last section header in the\r
2bfb6009 832 // Section Table. \r
d071fb19 833 //\r
834 if ((++Index) == (UINTN)Hdr.Te->NumberOfSections) {\r
bf29dc16 835 ImageContext->ImageSize = (SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) - TeStrippedOffset;\r
d071fb19 836 }\r
837\r
838 SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);\r
839 }\r
840\r
841 if (DebugDirectoryEntryFileOffset != 0) {\r
842 for (Index = 0; Index < DebugDirectoryEntry->Size; Index += sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY)) {\r
843 //\r
844 // Read next debug directory entry\r
845 //\r
846 Size = sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);\r
3acb1985 847 ReadSize = Size;\r
d071fb19 848 Status = ImageContext->ImageRead (\r
849 ImageContext->Handle,\r
be30ddf7 850 DebugDirectoryEntryFileOffset + Index,\r
d071fb19 851 &Size,\r
852 &DebugEntry\r
853 );\r
3acb1985 854 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 855 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 856 if (Size != ReadSize) {\r
857 Status = RETURN_UNSUPPORTED;\r
858 }\r
d071fb19 859 return Status;\r
860 }\r
861\r
862 if (DebugEntry.Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
863 ImageContext->DebugDirectoryEntryRva = (UINT32) (DebugDirectoryEntryRva + Index);\r
864 return RETURN_SUCCESS;\r
865 }\r
866 }\r
867 }\r
868 }\r
869\r
870 return RETURN_SUCCESS;\r
871}\r
872\r
873\r
874/**\r
875 Converts an image address to the loaded address.\r
876\r
bf29dc16
ED		 877 @param ImageContext The context of the image being loaded.\r
878 @param Address The address to be converted to the loaded address.\r
879 @param TeStrippedOffset Stripped offset for TE image.\r
d071fb19 880\r
881 @return The converted address or NULL if the address can not be converted.\r
882\r
883**/\r
884VOID *\r
885PeCoffLoaderImageAddress (\r
886 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext,\r
bf29dc16
ED		 887 IN UINTN Address, \r
888 IN UINTN TeStrippedOffset\r
d071fb19 889 )\r
890{\r
891 //\r
9833a9bb 892 // Make sure that Address and ImageSize is correct for the loaded image.\r
d071fb19 893 //\r
bf29dc16 894 if (Address >= ImageContext->ImageSize + TeStrippedOffset) {\r
d071fb19 895 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;\r
896 return NULL;\r
897 }\r
898\r
bf29dc16 899 return (CHAR8 *)((UINTN) ImageContext->ImageAddress + Address - TeStrippedOffset);\r
d071fb19 900}\r
901\r
902/**\r
903 Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().\r
904\r
905 If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of\r
906 ImageContext as the relocation base address. Otherwise, use the DestinationAddress field\r
907 of ImageContext as the relocation base address. The caller must allocate the relocation\r
908 fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.\r
efb23117 909 \r
910 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, \r
911 ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, \r
912 DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of \r
913 the ImageContext structure must be valid prior to invoking this service.\r
914 \r
d071fb19 915 If ImageContext is NULL, then ASSERT().\r
916\r
8d579453 917 Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
918 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
919 prior to transferring control to a PE/COFF image that is loaded using this library.\r
920\r
2fc59a00 921 @param ImageContext The pointer to the image context structure that describes the PE/COFF\r
d071fb19 922 image that is being relocated.\r
923\r
924 @retval RETURN_SUCCESS The PE/COFF image was relocated.\r
925 Extended status information is in the ImageError field of ImageContext.\r
926 @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.\r
927 Extended status information is in the ImageError field of ImageContext.\r
928 @retval RETURN_UNSUPPORTED A relocation record type is not supported.\r
929 Extended status information is in the ImageError field of ImageContext.\r
930\r
931**/\r
932RETURN_STATUS\r
933EFIAPI\r
934PeCoffLoaderRelocateImage (\r
935 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
936 )\r
937{\r
938 RETURN_STATUS Status;\r
939 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
940 EFI_IMAGE_DATA_DIRECTORY *RelocDir;\r
941 UINT64 Adjust;\r
a8d8d430 942 EFI_IMAGE_BASE_RELOCATION *RelocBaseOrg;\r
d071fb19 943 EFI_IMAGE_BASE_RELOCATION *RelocBase;\r
944 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;\r
945 UINT16 *Reloc;\r
946 UINT16 *RelocEnd;\r
947 CHAR8 *Fixup;\r
948 CHAR8 *FixupBase;\r
1fa524e9 949 UINT16 *Fixup16;\r
950 UINT32 *Fixup32;\r
951 UINT64 *Fixup64;\r
d071fb19 952 CHAR8 *FixupData;\r
953 PHYSICAL_ADDRESS BaseAddress;\r
954 UINT32 NumberOfRvaAndSizes;\r
955 UINT16 Magic;\r
bf29dc16 956 UINT32 TeStrippedOffset;\r
d071fb19 957\r
958 ASSERT (ImageContext != NULL);\r
959\r
960 //\r
961 // Assume success\r
962 //\r
963 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;\r
964\r
965 //\r
966 // If there are no relocation entries, then we are done\r
967 //\r
968 if (ImageContext->RelocationsStripped) {\r
b4500f6e 969 // Applies additional environment specific actions to relocate fixups \r
970 // to a PE/COFF image if needed\r
01a54966 971 PeCoffLoaderRelocateImageExtraAction (ImageContext); \r
d071fb19 972 return RETURN_SUCCESS;\r
973 }\r
974\r
975 //\r
976 // If the destination address is not 0, use that rather than the\r
977 // image address as the relocation target.\r
978 //\r
979 if (ImageContext->DestinationAddress != 0) {\r
980 BaseAddress = ImageContext->DestinationAddress;\r
d071fb19 981 } else {\r
19bee90c 982 BaseAddress = ImageContext->ImageAddress;\r
d071fb19 983 }\r
984\r
985 if (!(ImageContext->IsTeImage)) {\r
986 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);\r
bf29dc16 987 TeStrippedOffset = 0;\r
d071fb19 988 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
989\r
990 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
991 //\r
992 // Use PE32 offset\r
993 //\r
994 Adjust = (UINT64)BaseAddress - Hdr.Pe32->OptionalHeader.ImageBase;\r
2816e216 995 if (Adjust != 0) {\r
996 Hdr.Pe32->OptionalHeader.ImageBase = (UINT32)BaseAddress;\r
997 }\r
d071fb19 998\r
999 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
1000 RelocDir = &Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1001 } else {\r
1002 //\r
1003 // Use PE32+ offset\r
1004 //\r
1005 Adjust = (UINT64) BaseAddress - Hdr.Pe32Plus->OptionalHeader.ImageBase;\r
2816e216 1006 if (Adjust != 0) {\r
1007 Hdr.Pe32Plus->OptionalHeader.ImageBase = (UINT64)BaseAddress;\r
1008 }\r
d071fb19 1009\r
1010 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
1011 RelocDir = &Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1012 }\r
1013\r
1014 //\r
1015 // Find the relocation block\r
1016 // Per the PE/COFF spec, you can't assume that a given data directory\r
1017 // is present in the image. You have to check the NumberOfRvaAndSizes in\r
1018 // the optional header to verify a desired directory entry is there.\r
1019 //\r
bf29dc16
ED		 1020 if ((NumberOfRvaAndSizes < EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC)) {\r
1021 RelocDir = NULL;\r
d071fb19 1022 }\r
1023 } else {\r
1024 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);\r
bf29dc16
ED		 1025 TeStrippedOffset = (UINT32)Hdr.Te->StrippedSize - sizeof (EFI_TE_IMAGE_HEADER);\r
1026 Adjust = (UINT64) (BaseAddress - (Hdr.Te->ImageBase + TeStrippedOffset));\r
2816e216 1027 if (Adjust != 0) {\r
bf29dc16 1028 Hdr.Te->ImageBase = (UINT64) (BaseAddress - TeStrippedOffset);\r
2816e216 1029 }\r
d071fb19 1030\r
1031 //\r
1032 // Find the relocation block\r
1033 //\r
1034 RelocDir = &Hdr.Te->DataDirectory[0];\r
bf29dc16
ED		 1035 }\r
1036\r
1037 if ((RelocDir != NULL) && (RelocDir->Size > 0)) {\r
1038 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) PeCoffLoaderImageAddress (ImageContext, RelocDir->VirtualAddress, TeStrippedOffset);\r
1039 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *) PeCoffLoaderImageAddress (ImageContext,\r
1040 RelocDir->VirtualAddress + RelocDir->Size - 1,\r
1041 TeStrippedOffset\r
1042 );\r
a8d8d430
ED		 1043 if (RelocBase == NULL || RelocBaseEnd == NULL || RelocBaseEnd < RelocBase) {\r
1044 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
bf29dc16 1045 return RETURN_LOAD_ERROR;\r
9833a9bb 1046 }\r
bf29dc16
ED		 1047 } else {\r
1048 //\r
1049 // Set base and end to bypass processing below.\r
1050 //\r
1051 RelocBase = RelocBaseEnd = NULL; \r
d071fb19 1052 }\r
a8d8d430 1053 RelocBaseOrg = RelocBase;\r
d071fb19 1054\r
1055 //\r
01e1171e 1056 // If Adjust is not zero, then apply fix ups to the image\r
d071fb19 1057 //\r
01e1171e 1058 if (Adjust != 0) {\r
9833a9bb 1059 //\r
01e1171e 1060 // Run the relocation information and apply the fixups\r
9833a9bb 1061 //\r
01e1171e 1062 FixupData = ImageContext->FixupData;\r
1063 while (RelocBase < RelocBaseEnd) {\r
9833a9bb 1064\r
01e1171e 1065 Reloc = (UINT16 *) ((CHAR8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));\r
01e1171e 1066 //\r
72ccedbd 1067 // Add check for RelocBase->SizeOfBlock field.\r
01e1171e 1068 //\r
a8d8d430
ED		 1069 if (RelocBase->SizeOfBlock == 0) {\r
1070 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1071 return RETURN_LOAD_ERROR;\r
1072 }\r
1073 if ((UINTN)RelocBase > MAX_ADDRESS - RelocBase->SizeOfBlock) {\r
01e1171e 1074 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
9833a9bb
LG		 1075 return RETURN_LOAD_ERROR;\r
1076 }\r
d071fb19 1077\r
72ccedbd 1078 RelocEnd = (UINT16 *) ((CHAR8 *) RelocBase + RelocBase->SizeOfBlock);\r
a8d8d430
ED		 1079 if ((UINTN)RelocEnd > (UINTN)RelocBaseOrg + RelocDir->Size) {\r
1080 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1081 return RETURN_LOAD_ERROR;\r
1082 }\r
bf29dc16
ED		 1083 FixupBase = PeCoffLoaderImageAddress (ImageContext, RelocBase->VirtualAddress, TeStrippedOffset);\r
1084 if (FixupBase == NULL) {\r
a8d8d430 1085 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
bf29dc16
ED		 1086 return RETURN_LOAD_ERROR;\r
1087 } \r
01e1171e 1088\r
1089 //\r
1090 // Run this relocation record\r
1091 //\r
1092 while (Reloc < RelocEnd) {\r
a8d8d430
ED		 1093 Fixup = PeCoffLoaderImageAddress (ImageContext, RelocBase->VirtualAddress + (*Reloc & 0xFFF), TeStrippedOffset);\r
1094 if (Fixup == NULL) {\r
1095 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1096 return RETURN_LOAD_ERROR;\r
1097 }\r
01e1171e 1098 switch ((*Reloc) >> 12) {\r
1099 case EFI_IMAGE_REL_BASED_ABSOLUTE:\r
1100 break;\r
1101\r
1102 case EFI_IMAGE_REL_BASED_HIGH:\r
1103 Fixup16 = (UINT16 *) Fixup;\r
1104 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
1105 if (FixupData != NULL) {\r
1106 *(UINT16 *) FixupData = *Fixup16;\r
1107 FixupData = FixupData + sizeof (UINT16);\r
1108 }\r
1109 break;\r
1110\r
1111 case EFI_IMAGE_REL_BASED_LOW:\r
1112 Fixup16 = (UINT16 *) Fixup;\r
1113 *Fixup16 = (UINT16) (*Fixup16 + (UINT16) Adjust);\r
1114 if (FixupData != NULL) {\r
1115 *(UINT16 *) FixupData = *Fixup16;\r
1116 FixupData = FixupData + sizeof (UINT16);\r
1117 }\r
1118 break;\r
1119\r
1120 case EFI_IMAGE_REL_BASED_HIGHLOW:\r
1121 Fixup32 = (UINT32 *) Fixup;\r
1122 *Fixup32 = *Fixup32 + (UINT32) Adjust;\r
1123 if (FixupData != NULL) {\r
1124 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));\r
1125 *(UINT32 *)FixupData = *Fixup32;\r
1126 FixupData = FixupData + sizeof (UINT32);\r
1127 }\r
1128 break;\r
1129\r
1130 case EFI_IMAGE_REL_BASED_DIR64:\r
1131 Fixup64 = (UINT64 *) Fixup;\r
1132 *Fixup64 = *Fixup64 + (UINT64) Adjust;\r
1133 if (FixupData != NULL) {\r
1134 FixupData = ALIGN_POINTER (FixupData, sizeof(UINT64));\r
1135 *(UINT64 *)(FixupData) = *Fixup64;\r
1136 FixupData = FixupData + sizeof(UINT64);\r
1137 }\r
1138 break;\r
1139\r
1140 default:\r
1141 //\r
1142 // The common code does not handle some of the stranger IPF relocations\r
1143 // PeCoffLoaderRelocateImageEx () adds support for these complex fixups\r
1144 // on IPF and is a No-Op on other architectures.\r
1145 //\r
1146 Status = PeCoffLoaderRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);\r
1147 if (RETURN_ERROR (Status)) {\r
1148 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1149 return Status;\r
1150 }\r
d071fb19 1151 }\r
d071fb19 1152\r
d071fb19 1153 //\r
01e1171e 1154 // Next relocation record\r
d071fb19 1155 //\r
01e1171e 1156 Reloc += 1;\r
d071fb19 1157 }\r
1158\r
1159 //\r
01e1171e 1160 // Next reloc block\r
d071fb19 1161 //\r
01e1171e 1162 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;\r
d071fb19 1163 }\r
a8d8d430 1164 ASSERT ((UINTN)FixupData <= (UINTN)ImageContext->FixupData + ImageContext->FixupDataSize);\r
d071fb19 1165\r
1166 //\r
01e1171e 1167 // Adjust the EntryPoint to match the linked-to address\r
d071fb19 1168 //\r
01e1171e 1169 if (ImageContext->DestinationAddress != 0) {\r
1170 ImageContext->EntryPoint -= (UINT64) ImageContext->ImageAddress;\r
1171 ImageContext->EntryPoint += (UINT64) ImageContext->DestinationAddress;\r
1172 }\r
19bee90c 1173 }\r
27b2d249 1174 \r
1175 // Applies additional environment specific actions to relocate fixups \r
1176 // to a PE/COFF image if needed\r
1177 PeCoffLoaderRelocateImageExtraAction (ImageContext);\r
1178 \r
d071fb19 1179 return RETURN_SUCCESS;\r
1180}\r
1181\r
1182/**\r
1183 Loads a PE/COFF image into memory.\r
1184\r
1185 Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer\r
1186 specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate\r
1187 the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.\r
b4500f6e 1188 The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.\r
efb23117 1189 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, \r
1190 DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva \r
1191 fields of the ImageContext structure must be valid prior to invoking this service.\r
1192 \r
d071fb19 1193 If ImageContext is NULL, then ASSERT().\r
1194\r
8d579453 1195 Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
1196 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
1197 prior to transferring control to a PE/COFF image that is loaded using this library.\r
1198\r
2fc59a00 1199 @param ImageContext The pointer to the image context structure that describes the PE/COFF\r
d071fb19 1200 image that is being loaded.\r
1201\r
1202 @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by\r
1203 the ImageAddress and ImageSize fields of ImageContext.\r
1204 Extended status information is in the ImageError field of ImageContext.\r
1205 @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.\r
1206 Extended status information is in the ImageError field of ImageContext.\r
1207 @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.\r
1208 Extended status information is in the ImageError field of ImageContext.\r
1209 @retval RETURN_INVALID_PARAMETER The image address is invalid.\r
1210 Extended status information is in the ImageError field of ImageContext.\r
1211\r
1212**/\r
1213RETURN_STATUS\r
1214EFIAPI\r
1215PeCoffLoaderLoadImage (\r
1216 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
1217 )\r
1218{\r
1219 RETURN_STATUS Status;\r
1220 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
1221 PE_COFF_LOADER_IMAGE_CONTEXT CheckContext;\r
1222 EFI_IMAGE_SECTION_HEADER *FirstSection;\r
1223 EFI_IMAGE_SECTION_HEADER *Section;\r
1224 UINTN NumberOfSections;\r
1225 UINTN Index;\r
1226 CHAR8 *Base;\r
1227 CHAR8 *End;\r
d071fb19 1228 EFI_IMAGE_DATA_DIRECTORY *DirectoryEntry;\r
1229 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *DebugEntry;\r
1230 UINTN Size;\r
1231 UINT32 TempDebugEntryRva;\r
1232 UINT32 NumberOfRvaAndSizes;\r
1233 UINT16 Magic;\r
b4500f6e 1234 EFI_IMAGE_RESOURCE_DIRECTORY *ResourceDirectory;\r
1235 EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *ResourceDirectoryEntry;\r
1236 EFI_IMAGE_RESOURCE_DIRECTORY_STRING *ResourceDirectoryString;\r
1237 EFI_IMAGE_RESOURCE_DATA_ENTRY *ResourceDataEntry;\r
bab427db 1238 CHAR16 *String;\r
713ffa20 1239 UINT32 Offset;\r
bf29dc16 1240 UINT32 TeStrippedOffset;\r
d071fb19 1241\r
1242 ASSERT (ImageContext != NULL);\r
1243\r
1244 //\r
1245 // Assume success\r
1246 //\r
1247 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;\r
1248\r
1249 //\r
58380e9c 1250 // Copy the provided context information into our local version, get what we\r
d071fb19 1251 // can from the original image, and then use that to make sure everything\r
1252 // is legit.\r
1253 //\r
1254 CopyMem (&CheckContext, ImageContext, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT));\r
1255\r
1256 Status = PeCoffLoaderGetImageInfo (&CheckContext);\r
1257 if (RETURN_ERROR (Status)) {\r
1258 return Status;\r
1259 }\r
1260\r
1261 //\r
1262 // Make sure there is enough allocated space for the image being loaded\r
1263 //\r
1264 if (ImageContext->ImageSize < CheckContext.ImageSize) {\r
1265 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_SIZE;\r
1266 return RETURN_BUFFER_TOO_SMALL;\r
1267 }\r
1268 if (ImageContext->ImageAddress == 0) {\r
1269 //\r
1270 // Image cannot be loaded into 0 address.\r
1271 //\r
1272 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;\r
1273 return RETURN_INVALID_PARAMETER;\r
1274 }\r
1275 //\r
1276 // If there's no relocations, then make sure it's not a runtime driver,\r
1277 // and that it's being loaded at the linked address.\r
1278 //\r
1279 if (CheckContext.RelocationsStripped) {\r
1280 //\r
1281 // If the image does not contain relocations and it is a runtime driver\r
1282 // then return an error.\r
1283 //\r
1284 if (CheckContext.ImageType == EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER) {\r
1285 ImageContext->ImageError = IMAGE_ERROR_INVALID_SUBSYSTEM;\r
1286 return RETURN_LOAD_ERROR;\r
1287 }\r
1288 //\r
1289 // If the image does not contain relocations, and the requested load address\r
1290 // is not the linked address, then return an error.\r
1291 //\r
1292 if (CheckContext.ImageAddress != ImageContext->ImageAddress) {\r
1293 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;\r
1294 return RETURN_INVALID_PARAMETER;\r
1295 }\r
1296 }\r
1297 //\r
1298 // Make sure the allocated space has the proper section alignment\r
1299 //\r
1300 if (!(ImageContext->IsTeImage)) {\r
1301 if ((ImageContext->ImageAddress & (CheckContext.SectionAlignment - 1)) != 0) {\r
1302 ImageContext->ImageError = IMAGE_ERROR_INVALID_SECTION_ALIGNMENT;\r
1303 return RETURN_INVALID_PARAMETER;\r
1304 }\r
1305 }\r
1306 //\r
1307 // Read the entire PE/COFF or TE header into memory\r
1308 //\r
1309 if (!(ImageContext->IsTeImage)) {\r
1310 Status = ImageContext->ImageRead (\r
1311 ImageContext->Handle,\r
1312 0,\r
1313 &ImageContext->SizeOfHeaders,\r
1314 (VOID *) (UINTN) ImageContext->ImageAddress\r
1315 );\r
1316\r
1317 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);\r
1318\r
1319 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (\r
1320 (UINTN)ImageContext->ImageAddress +\r
1321 ImageContext->PeCoffHeaderOffset +\r
1322 sizeof(UINT32) +\r
1323 sizeof(EFI_IMAGE_FILE_HEADER) +\r
1324 Hdr.Pe32->FileHeader.SizeOfOptionalHeader\r
1325 );\r
1326 NumberOfSections = (UINTN) (Hdr.Pe32->FileHeader.NumberOfSections);\r
bf29dc16 1327 TeStrippedOffset = 0;\r
d071fb19 1328 } else {\r
1329 Status = ImageContext->ImageRead (\r
1330 ImageContext->Handle,\r
1331 0,\r
1332 &ImageContext->SizeOfHeaders,\r
1333 (void *)(UINTN)ImageContext->ImageAddress\r
1334 );\r
1335\r
1336 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);\r
d071fb19 1337 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (\r
1338 (UINTN)ImageContext->ImageAddress +\r
1339 sizeof(EFI_TE_IMAGE_HEADER)\r
1340 );\r
1341 NumberOfSections = (UINTN) (Hdr.Te->NumberOfSections);\r
bf29dc16 1342 TeStrippedOffset = (UINT32) Hdr.Te->StrippedSize - sizeof (EFI_TE_IMAGE_HEADER);\r
d071fb19 1343 }\r
1344\r
1345 if (RETURN_ERROR (Status)) {\r
1346 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
1347 return RETURN_LOAD_ERROR;\r
1348 }\r
1349\r
1350 //\r
1351 // Load each section of the image\r
1352 //\r
1353 Section = FirstSection;\r
f8ffa6d7 1354 for (Index = 0; Index < NumberOfSections; Index++) {\r
5cfafa07 1355 //\r
1356 // Read the section\r
1357 //\r
1358 Size = (UINTN) Section->Misc.VirtualSize;\r
1359 if ((Size == 0) || (Size > Section->SizeOfRawData)) {\r
1360 Size = (UINTN) Section->SizeOfRawData;\r
1361 }\r
1362\r
d071fb19 1363 //\r
1364 // Compute sections address\r
1365 //\r
bf29dc16
ED		 1366 Base = PeCoffLoaderImageAddress (ImageContext, Section->VirtualAddress, TeStrippedOffset);\r
1367 End = PeCoffLoaderImageAddress (ImageContext, Section->VirtualAddress + Section->Misc.VirtualSize - 1, TeStrippedOffset);\r
d071fb19 1368\r
d071fb19 1369 //\r
5cfafa07 1370 // If the size of the section is non-zero and the base address or end address resolved to 0, then fail.\r
d071fb19 1371 //\r
5cfafa07 1372 if ((Size > 0) && ((Base == NULL) || (End == NULL))) {\r
d071fb19 1373 ImageContext->ImageError = IMAGE_ERROR_SECTION_NOT_LOADED;\r
1374 return RETURN_LOAD_ERROR;\r
1375 }\r
1376\r
2bfb6009 1377 if (Section->SizeOfRawData > 0) {\r
bf29dc16
ED		 1378 Status = ImageContext->ImageRead (\r
1379 ImageContext->Handle,\r
1380 Section->PointerToRawData - TeStrippedOffset,\r
1381 &Size,\r
1382 Base\r
1383 );\r
d071fb19 1384 if (RETURN_ERROR (Status)) {\r
1385 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
1386 return Status;\r
1387 }\r
1388 }\r
1389\r
1390 //\r
b4500f6e 1391 // If raw size is less then virtual size, zero fill the remaining\r
d071fb19 1392 //\r
1393\r
1394 if (Size < Section->Misc.VirtualSize) {\r
1395 ZeroMem (Base + Size, Section->Misc.VirtualSize - Size);\r
1396 }\r
1397\r
1398 //\r
1399 // Next Section\r
1400 //\r
1401 Section += 1;\r
1402 }\r
1403\r
1404 //\r
1405 // Get image's entry point\r
1406 //\r
1407 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
1408 if (!(ImageContext->IsTeImage)) {\r
1409 //\r
1410 // Sizes of AddressOfEntryPoint are different so we need to do this safely\r
1411 //\r
1412 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1413 //\r
1414 // Use PE32 offset\r
1415 //\r
1416 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (\r
1417 ImageContext,\r
bf29dc16
ED		 1418 (UINTN)Hdr.Pe32->OptionalHeader.AddressOfEntryPoint,\r
1419 0\r
d071fb19 1420 );\r
1421 } else {\r
1422 //\r
1423 // Use PE32+ offset\r
1424 //\r
1425 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (\r
1426 ImageContext,\r
bf29dc16
ED		 1427 (UINTN)Hdr.Pe32Plus->OptionalHeader.AddressOfEntryPoint,\r
1428 0\r
d071fb19 1429 );\r
1430 }\r
1431 } else {\r
bf29dc16
ED		 1432 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (\r
1433 ImageContext,\r
1434 (UINTN)Hdr.Te->AddressOfEntryPoint,\r
1435 TeStrippedOffset\r
1436 );\r
d071fb19 1437 }\r
1438\r
1439 //\r
1440 // Determine the size of the fixup data\r
1441 //\r
1442 // Per the PE/COFF spec, you can't assume that a given data directory\r
1443 // is present in the image. You have to check the NumberOfRvaAndSizes in\r
1444 // the optional header to verify a desired directory entry is there.\r
1445 //\r
1446 if (!(ImageContext->IsTeImage)) {\r
1447 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1448 //\r
1449 // Use PE32 offset\r
1450 //\r
1451 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
1452 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1453 } else {\r
1454 //\r
1455 // Use PE32+ offset\r
1456 //\r
1457 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
1458 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1459 }\r
1460\r
a8d8d430
ED		 1461 //\r
1462 // Must use UINT64 here, because there might a case that 32bit loader to load 64bit image.\r
1463 //\r
d071fb19 1464 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {\r
a8d8d430 1465 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINT64);\r
d071fb19 1466 } else {\r
1467 ImageContext->FixupDataSize = 0;\r
1468 }\r
1469 } else {\r
1470 DirectoryEntry = &Hdr.Te->DataDirectory[0];\r
a8d8d430 1471 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINT64);\r
d071fb19 1472 }\r
1473 //\r
1474 // Consumer must allocate a buffer for the relocation fixup log.\r
1475 // Only used for runtime drivers.\r
1476 //\r
1477 ImageContext->FixupData = NULL;\r
1478\r
1479 //\r
58380e9c 1480 // Load the Codeview information if present\r
d071fb19 1481 //\r
1482 if (ImageContext->DebugDirectoryEntryRva != 0) {\r
bf29dc16
ED		 1483 DebugEntry = PeCoffLoaderImageAddress (\r
1484 ImageContext,\r
1485 ImageContext->DebugDirectoryEntryRva,\r
1486 TeStrippedOffset\r
1487 );\r
1488 if (DebugEntry == NULL) {\r
1489 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1490 return RETURN_LOAD_ERROR;\r
d071fb19 1491 }\r
1492\r
bf29dc16
ED		 1493 TempDebugEntryRva = DebugEntry->RVA;\r
1494 if (DebugEntry->RVA == 0 && DebugEntry->FileOffset != 0) {\r
1495 Section--;\r
1496 if ((UINTN)Section->SizeOfRawData < Section->Misc.VirtualSize) {\r
1497 TempDebugEntryRva = Section->VirtualAddress + Section->Misc.VirtualSize;\r
1498 } else {\r
1499 TempDebugEntryRva = Section->VirtualAddress + Section->SizeOfRawData;\r
d071fb19 1500 }\r
bf29dc16 1501 }\r
d071fb19 1502\r
bf29dc16
ED		 1503 if (TempDebugEntryRva != 0) {\r
1504 ImageContext->CodeView = PeCoffLoaderImageAddress (ImageContext, TempDebugEntryRva, TeStrippedOffset); \r
1505 if (ImageContext->CodeView == NULL) {\r
1506 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1507 return RETURN_LOAD_ERROR;\r
1508 }\r
d071fb19 1509\r
bf29dc16
ED		 1510 if (DebugEntry->RVA == 0) {\r
1511 Size = DebugEntry->SizeOfData;\r
1512 Status = ImageContext->ImageRead (\r
1513 ImageContext->Handle,\r
1514 DebugEntry->FileOffset - TeStrippedOffset,\r
1515 &Size,\r
1516 ImageContext->CodeView\r
1517 );\r
1518 //\r
1519 // Should we apply fix up to this field according to the size difference between PE and TE?\r
1520 // Because now we maintain TE header fields unfixed, this field will also remain as they are\r
1521 // in original PE image.\r
1522 //\r
1523\r
1524 if (RETURN_ERROR (Status)) {\r
d071fb19 1525 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
1526 return RETURN_LOAD_ERROR;\r
1527 }\r
1528\r
bf29dc16
ED		 1529 DebugEntry->RVA = TempDebugEntryRva;\r
1530 }\r
d071fb19 1531\r
bf29dc16
ED		 1532 switch (*(UINT32 *) ImageContext->CodeView) {\r
1533 case CODEVIEW_SIGNATURE_NB10:\r
1534 if (DebugEntry->SizeOfData < sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY)) {\r
1535 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1536 return RETURN_UNSUPPORTED;\r
d071fb19 1537 }\r
bf29dc16
ED		 1538 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);\r
1539 break;\r
d071fb19 1540\r
bf29dc16
ED		 1541 case CODEVIEW_SIGNATURE_RSDS:\r
1542 if (DebugEntry->SizeOfData < sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY)) {\r
1543 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1544 return RETURN_UNSUPPORTED;\r
1545 }\r
1546 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);\r
1547 break;\r
ebd04fc2 1548\r
bf29dc16
ED		 1549 case CODEVIEW_SIGNATURE_MTOC:\r
1550 if (DebugEntry->SizeOfData < sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY)) {\r
1551 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1552 return RETURN_UNSUPPORTED;\r
d071fb19 1553 }\r
bf29dc16
ED		 1554 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY);\r
1555 break;\r
1556\r
1557 default:\r
1558 break;\r
d071fb19 1559 }\r
1560 }\r
1561 }\r
1562\r
b4500f6e 1563 //\r
1564 // Get Image's HII resource section\r
1565 //\r
1566 ImageContext->HiiResourceData = 0;\r
1567 if (!(ImageContext->IsTeImage)) {\r
1568 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1569 //\r
1570 // Use PE32 offset\r
1571 //\r
713ffa20 1572 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
b4500f6e 1573 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE];\r
1574 } else {\r
1575 //\r
1576 // Use PE32+ offset\r
1577 //\r
713ffa20 1578 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
b4500f6e 1579 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE];\r
1580 }\r
1581\r
713ffa20 1582 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE && DirectoryEntry->Size != 0) {\r
bf29dc16 1583 Base = PeCoffLoaderImageAddress (ImageContext, DirectoryEntry->VirtualAddress, 0);\r
50cd68df 1584 if (Base != NULL) {\r
1585 ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) Base;\r
713ffa20
ED		 1586 Offset = sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * \r
1587 (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);\r
1588 if (Offset > DirectoryEntry->Size) {\r
1589 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1590 return RETURN_UNSUPPORTED;\r
1591 }\r
50cd68df 1592 ResourceDirectoryEntry = (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *) (ResourceDirectory + 1);\r
1593\r
1594 for (Index = 0; Index < ResourceDirectory->NumberOfNamedEntries; Index++) {\r
1595 if (ResourceDirectoryEntry->u1.s.NameIsString) {\r
60893cc3
ED		 1596 //\r
1597 // Check the ResourceDirectoryEntry->u1.s.NameOffset before use it.\r
1598 //\r
1599 if (ResourceDirectoryEntry->u1.s.NameOffset >= DirectoryEntry->Size) {\r
713ffa20
ED		 1600 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1601 return RETURN_UNSUPPORTED;\r
60893cc3 1602 }\r
50cd68df 1603 ResourceDirectoryString = (EFI_IMAGE_RESOURCE_DIRECTORY_STRING *) (Base + ResourceDirectoryEntry->u1.s.NameOffset);\r
bab427db 1604 String = &ResourceDirectoryString->String[0];\r
50cd68df 1605\r
1606 if (ResourceDirectoryString->Length == 3 &&\r
bab427db 1607 String[0] == L'H' &&\r
1608 String[1] == L'I' &&\r
1609 String[2] == L'I') {\r
b4500f6e 1610 //\r
50cd68df 1611 // Resource Type "HII" found\r
b4500f6e 1612 //\r
b4500f6e 1613 if (ResourceDirectoryEntry->u2.s.DataIsDirectory) {\r
1614 //\r
50cd68df 1615 // Move to next level - resource Name\r
b4500f6e 1616 //\r
713ffa20
ED		 1617 if (ResourceDirectoryEntry->u2.s.OffsetToDirectory >= DirectoryEntry->Size) {\r
1618 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1619 return RETURN_UNSUPPORTED;\r
1620 }\r
b4500f6e 1621 ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) (Base + ResourceDirectoryEntry->u2.s.OffsetToDirectory);\r
713ffa20
ED		 1622 Offset = ResourceDirectoryEntry->u2.s.OffsetToDirectory + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + \r
1623 sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);\r
1624 if (Offset > DirectoryEntry->Size) {\r
1625 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1626 return RETURN_UNSUPPORTED;\r
1627 }\r
b4500f6e 1628 ResourceDirectoryEntry = (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *) (ResourceDirectory + 1);\r
50cd68df 1629\r
1630 if (ResourceDirectoryEntry->u2.s.DataIsDirectory) {\r
1631 //\r
1632 // Move to next level - resource Language\r
1633 //\r
713ffa20
ED		 1634 if (ResourceDirectoryEntry->u2.s.OffsetToDirectory >= DirectoryEntry->Size) {\r
1635 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1636 return RETURN_UNSUPPORTED;\r
1637 }\r
50cd68df 1638 ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) (Base + ResourceDirectoryEntry->u2.s.OffsetToDirectory);\r
713ffa20
ED		 1639 Offset = ResourceDirectoryEntry->u2.s.OffsetToDirectory + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + \r
1640 sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);\r
1641 if (Offset > DirectoryEntry->Size) {\r
1642 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1643 return RETURN_UNSUPPORTED;\r
1644 }\r
50cd68df 1645 ResourceDirectoryEntry = (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *) (ResourceDirectory + 1);\r
1646 }\r
b4500f6e 1647 }\r
b4500f6e 1648\r
50cd68df 1649 //\r
1650 // Now it ought to be resource Data\r
1651 //\r
1652 if (!ResourceDirectoryEntry->u2.s.DataIsDirectory) {\r
713ffa20
ED		 1653 if (ResourceDirectoryEntry->u2.OffsetToData >= DirectoryEntry->Size) {\r
1654 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1655 return RETURN_UNSUPPORTED;\r
1656 }\r
50cd68df 1657 ResourceDataEntry = (EFI_IMAGE_RESOURCE_DATA_ENTRY *) (Base + ResourceDirectoryEntry->u2.OffsetToData);\r
bf29dc16 1658 ImageContext->HiiResourceData = (PHYSICAL_ADDRESS) (UINTN) PeCoffLoaderImageAddress (ImageContext, ResourceDataEntry->OffsetToData, 0);\r
50cd68df 1659 break;\r
1660 }\r
b4500f6e 1661 }\r
1662 }\r
50cd68df 1663 ResourceDirectoryEntry++;\r
b4500f6e 1664 }\r
b4500f6e 1665 }\r
1666 }\r
1667 }\r
1668 \r
d071fb19 1669 return Status;\r
1670}\r
1671\r
1672\r
1673/**\r
1674 Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
efb23117 1675 runtime. \r
1676 \r
9833a9bb
LG		 1677 This function reapplies relocation fixups to the PE/COFF image specified by ImageBase \r
1678 and ImageSize so the image will execute correctly when the PE/COFF image is mapped \r
1679 to the address specified by VirtualImageBase. RelocationData must be identical \r
1680 to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure \r
1681 after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().\r
d071fb19 1682\r
8d579453 1683 Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
1684 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
1685 prior to transferring control to a PE/COFF image that is loaded using this library.\r
1686\r
2fc59a00 1687 @param ImageBase The base address of a PE/COFF image that has been loaded \r
efb23117 1688 and relocated into system memory.\r
1689 @param VirtImageBase The request virtual address that the PE/COFF image is to\r
1690 be fixed up for.\r
1691 @param ImageSize The size, in bytes, of the PE/COFF image.\r
1692 @param RelocationData A pointer to the relocation data that was collected when the PE/COFF \r
1693 image was relocated using PeCoffLoaderRelocateImage().\r
1694 \r
d071fb19 1695**/\r
1696VOID\r
1697EFIAPI\r
1698PeCoffLoaderRelocateImageForRuntime (\r
1699 IN PHYSICAL_ADDRESS ImageBase,\r
1700 IN PHYSICAL_ADDRESS VirtImageBase,\r
1701 IN UINTN ImageSize,\r
1702 IN VOID *RelocationData\r
1703 )\r
1704{\r
1705 CHAR8 *OldBase;\r
1706 CHAR8 *NewBase;\r
1707 EFI_IMAGE_DOS_HEADER *DosHdr;\r
1708 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
1709 UINT32 NumberOfRvaAndSizes;\r
1710 EFI_IMAGE_DATA_DIRECTORY *DataDirectory;\r
1711 EFI_IMAGE_DATA_DIRECTORY *RelocDir;\r
1712 EFI_IMAGE_BASE_RELOCATION *RelocBase;\r
1713 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;\r
1714 UINT16 *Reloc;\r
1715 UINT16 *RelocEnd;\r
1716 CHAR8 *Fixup;\r
1717 CHAR8 *FixupBase;\r
1fa524e9 1718 UINT16 *Fixup16;\r
1719 UINT32 *Fixup32;\r
1720 UINT64 *Fixup64;\r
d071fb19 1721 CHAR8 *FixupData;\r
1722 UINTN Adjust;\r
1723 RETURN_STATUS Status;\r
1724 UINT16 Magic;\r
1725\r
1726 OldBase = (CHAR8 *)((UINTN)ImageBase);\r
1727 NewBase = (CHAR8 *)((UINTN)VirtImageBase);\r
1728 Adjust = (UINTN) NewBase - (UINTN) OldBase;\r
1729\r
1730 //\r
1731 // Find the image's relocate dir info\r
1732 //\r
1733 DosHdr = (EFI_IMAGE_DOS_HEADER *)OldBase;\r
1734 if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
1735 //\r
1736 // Valid DOS header so get address of PE header\r
1737 //\r
1738 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)(((CHAR8 *)DosHdr) + DosHdr->e_lfanew);\r
1739 } else {\r
1740 //\r
1741 // No Dos header so assume image starts with PE header.\r
1742 //\r
1743 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)OldBase;\r
1744 }\r
1745\r
1746 if (Hdr.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {\r
1747 //\r
1748 // Not a valid PE image so Exit\r
1749 //\r
1750 return ;\r
1751 }\r
1752\r
1753 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
1754\r
1755 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1756 //\r
1757 // Use PE32 offset\r
1758 //\r
1759 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
1760 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32->OptionalHeader.DataDirectory[0]);\r
1761 } else {\r
1762 //\r
1763 // Use PE32+ offset\r
1764 //\r
1765 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
1766 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32Plus->OptionalHeader.DataDirectory[0]);\r
1767 }\r
1768\r
1769 //\r
1770 // Find the relocation block\r
1771 //\r
1772 // Per the PE/COFF spec, you can't assume that a given data directory\r
1773 // is present in the image. You have to check the NumberOfRvaAndSizes in\r
1774 // the optional header to verify a desired directory entry is there.\r
1775 //\r
1776 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {\r
1777 RelocDir = DataDirectory + EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC;\r
1778 RelocBase = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress);\r
1779 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress + RelocDir->Size);\r
1780 } else {\r
1781 //\r
2bfb6009 1782 // Cannot find relocations, cannot continue to relocate the image, ASSERT for this invalid image.\r
d071fb19 1783 //\r
1784 ASSERT (FALSE);\r
1785 return ;\r
1786 }\r
2bfb6009
LG		 1787 \r
1788 //\r
1789 // ASSERT for the invalid image when RelocBase and RelocBaseEnd are both NULL.\r
1790 //\r
d071fb19 1791 ASSERT (RelocBase != NULL && RelocBaseEnd != NULL);\r
1792\r
1793 //\r
1794 // Run the whole relocation block. And re-fixup data that has not been\r
1795 // modified. The FixupData is used to see if the image has been modified\r
1796 // since it was relocated. This is so data sections that have been updated\r
1797 // by code will not be fixed up, since that would set them back to\r
1798 // defaults.\r
1799 //\r
1800 FixupData = RelocationData;\r
1801 while (RelocBase < RelocBaseEnd) {\r
60893cc3
ED		 1802 //\r
1803 // Add check for RelocBase->SizeOfBlock field.\r
1804 //\r
1805 if ((RelocBase->SizeOfBlock == 0) || (RelocBase->SizeOfBlock > RelocDir->Size)) {\r
1806 //\r
1807 // Data invalid, cannot continue to relocate the image, just return.\r
1808 //\r
1809 return;\r
1810 }\r
d071fb19 1811\r
1812 Reloc = (UINT16 *) ((UINT8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));\r
1813 RelocEnd = (UINT16 *) ((UINT8 *) RelocBase + RelocBase->SizeOfBlock);\r
1814 FixupBase = (CHAR8 *) ((UINTN)ImageBase) + RelocBase->VirtualAddress;\r
1815\r
1816 //\r
1817 // Run this relocation record\r
1818 //\r
1819 while (Reloc < RelocEnd) {\r
1820\r
1821 Fixup = FixupBase + (*Reloc & 0xFFF);\r
1822 switch ((*Reloc) >> 12) {\r
1823\r
1824 case EFI_IMAGE_REL_BASED_ABSOLUTE:\r
1825 break;\r
1826\r
1827 case EFI_IMAGE_REL_BASED_HIGH:\r
1fa524e9 1828 Fixup16 = (UINT16 *) Fixup;\r
1829 if (*(UINT16 *) FixupData == *Fixup16) {\r
1830 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
d071fb19 1831 }\r
1832\r
1833 FixupData = FixupData + sizeof (UINT16);\r
1834 break;\r
1835\r
1836 case EFI_IMAGE_REL_BASED_LOW:\r
1fa524e9 1837 Fixup16 = (UINT16 *) Fixup;\r
1838 if (*(UINT16 *) FixupData == *Fixup16) {\r
1839 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) Adjust & 0xffff));\r
d071fb19 1840 }\r
1841\r
1842 FixupData = FixupData + sizeof (UINT16);\r
1843 break;\r
1844\r
1845 case EFI_IMAGE_REL_BASED_HIGHLOW:\r
1fa524e9 1846 Fixup32 = (UINT32 *) Fixup;\r
d071fb19 1847 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));\r
1fa524e9 1848 if (*(UINT32 *) FixupData == *Fixup32) {\r
1849 *Fixup32 = *Fixup32 + (UINT32) Adjust;\r
d071fb19 1850 }\r
1851\r
1852 FixupData = FixupData + sizeof (UINT32);\r
1853 break;\r
1854\r
1855 case EFI_IMAGE_REL_BASED_DIR64:\r
1fa524e9 1856 Fixup64 = (UINT64 *)Fixup;\r
d071fb19 1857 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT64));\r
1fa524e9 1858 if (*(UINT64 *) FixupData == *Fixup64) {\r
1859 *Fixup64 = *Fixup64 + (UINT64)Adjust;\r
d071fb19 1860 }\r
1861\r
1862 FixupData = FixupData + sizeof (UINT64);\r
1863 break;\r
1864\r
d071fb19 1865 default:\r
1866 //\r
1867 // Only Itanium requires ConvertPeImage_Ex\r
1868 //\r
1869 Status = PeHotRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);\r
1870 if (RETURN_ERROR (Status)) {\r
1871 return ;\r
1872 }\r
1873 }\r
1874 //\r
1875 // Next relocation record\r
1876 //\r
1877 Reloc += 1;\r
1878 }\r
1879 //\r
1880 // next reloc block\r
1881 //\r
1882 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;\r
1883 }\r
1884}\r
1885\r
1886\r
1887/**\r
657073df 1888 Reads contents of a PE/COFF image from a buffer in system memory.\r
1889 \r
1890 This is the default implementation of a PE_COFF_LOADER_READ_FILE function \r
1891 that assumes FileHandle pointer to the beginning of a PE/COFF image. \r
1892 This function reads contents of the PE/COFF image that starts at the system memory \r
1893 address specified by FileHandle. The read operation copies ReadSize bytes from the \r
1894 PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. \r
1895 The size of the buffer actually read is returned in ReadSize.\r
1896 \r
158e788f
ED		 1897 The caller must make sure the FileOffset and ReadSize within the file scope.\r
1898\r
657073df 1899 If FileHandle is NULL, then ASSERT().\r
1900 If ReadSize is NULL, then ASSERT().\r
1901 If Buffer is NULL, then ASSERT().\r
d071fb19 1902\r
2fc59a00 1903 @param FileHandle The pointer to base of the input stream\r
657073df 1904 @param FileOffset Offset into the PE/COFF image to begin the read operation.\r
1905 @param ReadSize On input, the size in bytes of the requested read operation. \r
1906 On output, the number of bytes actually read.\r
1907 @param Buffer Output buffer that contains the data read from the PE/COFF image.\r
d071fb19 1908\r
657073df 1909 @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into \r
d071fb19 1910 the buffer.\r
1911**/\r
1912RETURN_STATUS\r
1913EFIAPI\r
1914PeCoffLoaderImageReadFromMemory (\r
1915 IN VOID *FileHandle,\r
1916 IN UINTN FileOffset,\r
1917 IN OUT UINTN *ReadSize,\r
1918 OUT VOID *Buffer\r
1919 )\r
1920{\r
657073df 1921 ASSERT (ReadSize != NULL);\r
1922 ASSERT (FileHandle != NULL);\r
1923 ASSERT (Buffer != NULL);\r
1924\r
d071fb19 1925 CopyMem (Buffer, ((UINT8 *)FileHandle) + FileOffset, *ReadSize);\r
1926 return RETURN_SUCCESS;\r
1927}\r
1928\r
3d7b0992
LG		 1929/**\r
1930 Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
efb23117 1931 Releases any environment specific resources that were allocated when the image \r
1932 specified by ImageContext was loaded using PeCoffLoaderLoadImage(). \r
1933 \r
3d7b0992
LG		 1934 For NT32 emulator, the PE/COFF image loaded by system needs to release.\r
1935 For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r
1936 this function can simply return RETURN_SUCCESS.\r
efb23117 1937 \r
1938 If ImageContext is NULL, then ASSERT().\r
1939 \r
2fc59a00 1940 @param ImageContext The pointer to the image context structure that describes the PE/COFF\r
3d7b0992
LG		 1941 image to be unloaded.\r
1942\r
1943 @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.\r
1944**/\r
1945RETURN_STATUS\r
1946EFIAPI\r
1947PeCoffLoaderUnloadImage (\r
0465a73e 1948 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
3d7b0992
LG		 1949 )\r
1950{\r
b4500f6e 1951 //\r
27b2d249 1952 // Applies additional environment specific actions to unload a \r
1953 // PE/COFF image if needed\r
b4500f6e 1954 //\r
27b2d249 1955 PeCoffLoaderUnloadImageExtraAction (ImageContext);\r
3d7b0992
LG		 1956 return RETURN_SUCCESS;\r
1957}\r
EFI Development Kit II mirror for PVE