]> 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
OvmfPkg: QemuVideoDxe: filter BOCHS modes vs. available frame buffer 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
2080f676 18 Copyright (c) 2006 - 2014, 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
706 SectionHeaderOffset = (UINTN)(\r
707 ImageContext->PeCoffHeaderOffset +\r
708 sizeof (UINT32) +\r
709 sizeof (EFI_IMAGE_FILE_HEADER) +\r
710 Hdr.Pe32->FileHeader.SizeOfOptionalHeader\r
711 );\r
712\r
713 for (Index = 0; Index < Hdr.Pe32->FileHeader.NumberOfSections; Index++) {\r
714 //\r
715 // Read section header from file\r
716 //\r
717 Size = sizeof (EFI_IMAGE_SECTION_HEADER);\r
3acb1985 718 ReadSize = Size;\r
d071fb19 719 Status = ImageContext->ImageRead (\r
720 ImageContext->Handle,\r
721 SectionHeaderOffset,\r
722 &Size,\r
723 &SectionHeader\r
724 );\r
3acb1985 725 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 726 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 727 if (Size != ReadSize) {\r
728 Status = RETURN_UNSUPPORTED;\r
729 }\r
d071fb19 730 return Status;\r
731 }\r
732\r
733 if (DebugDirectoryEntryRva >= SectionHeader.VirtualAddress &&\r
734 DebugDirectoryEntryRva < SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) {\r
735\r
736 DebugDirectoryEntryFileOffset = DebugDirectoryEntryRva - SectionHeader.VirtualAddress + SectionHeader.PointerToRawData;\r
737 break;\r
738 }\r
739\r
740 SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);\r
741 }\r
742\r
743 if (DebugDirectoryEntryFileOffset != 0) {\r
744 for (Index = 0; Index < DebugDirectoryEntry->Size; Index += sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY)) {\r
745 //\r
746 // Read next debug directory entry\r
747 //\r
748 Size = sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);\r
3acb1985 749 ReadSize = Size;\r
d071fb19 750 Status = ImageContext->ImageRead (\r
751 ImageContext->Handle,\r
be30ddf7 752 DebugDirectoryEntryFileOffset + Index,\r
d071fb19 753 &Size,\r
754 &DebugEntry\r
755 );\r
3acb1985 756 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 757 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 758 if (Size != ReadSize) {\r
759 Status = RETURN_UNSUPPORTED;\r
760 }\r
d071fb19 761 return Status;\r
762 }\r
36b48bf6
ED		 763\r
764 //\r
765 // From PeCoff spec, when DebugEntry.RVA == 0 means this debug info will not load into memory.\r
766 // Here we will always load EFI_IMAGE_DEBUG_TYPE_CODEVIEW type debug info. so need adjust the\r
767 // ImageContext->ImageSize when DebugEntry.RVA == 0.\r
768 //\r
d071fb19 769 if (DebugEntry.Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
770 ImageContext->DebugDirectoryEntryRva = (UINT32) (DebugDirectoryEntryRva + Index);\r
771 if (DebugEntry.RVA == 0 && DebugEntry.FileOffset != 0) {\r
772 ImageContext->ImageSize += DebugEntry.SizeOfData;\r
773 }\r
774\r
775 return RETURN_SUCCESS;\r
776 }\r
777 }\r
778 }\r
779 }\r
780 } else {\r
781\r
782 DebugDirectoryEntry = &Hdr.Te->DataDirectory[1];\r
783 DebugDirectoryEntryRva = DebugDirectoryEntry->VirtualAddress;\r
784 SectionHeaderOffset = (UINTN)(sizeof (EFI_TE_IMAGE_HEADER));\r
785\r
786 DebugDirectoryEntryFileOffset = 0;\r
787\r
788 for (Index = 0; Index < Hdr.Te->NumberOfSections;) {\r
789 //\r
790 // Read section header from file\r
791 //\r
792 Size = sizeof (EFI_IMAGE_SECTION_HEADER);\r
3acb1985 793 ReadSize = Size;\r
d071fb19 794 Status = ImageContext->ImageRead (\r
795 ImageContext->Handle,\r
796 SectionHeaderOffset,\r
797 &Size,\r
798 &SectionHeader\r
799 );\r
3acb1985 800 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 801 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 802 if (Size != ReadSize) {\r
803 Status = RETURN_UNSUPPORTED;\r
804 }\r
d071fb19 805 return Status;\r
806 }\r
807\r
808 if (DebugDirectoryEntryRva >= SectionHeader.VirtualAddress &&\r
809 DebugDirectoryEntryRva < SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) {\r
810 DebugDirectoryEntryFileOffset = DebugDirectoryEntryRva -\r
811 SectionHeader.VirtualAddress +\r
bf29dc16
ED		 812 SectionHeader.PointerToRawData -\r
813 TeStrippedOffset;\r
d071fb19 814\r
815 //\r
816 // File offset of the debug directory was found, if this is not the last\r
817 // section, then skip to the last section for calculating the image size.\r
818 //\r
819 if (Index < (UINTN) Hdr.Te->NumberOfSections - 1) {\r
820 SectionHeaderOffset += (Hdr.Te->NumberOfSections - 1 - Index) * sizeof (EFI_IMAGE_SECTION_HEADER);\r
821 Index = Hdr.Te->NumberOfSections - 1;\r
822 continue;\r
823 }\r
824 }\r
825\r
826 //\r
827 // In Te image header there is not a field to describe the ImageSize.\r
828 // Actually, the ImageSize equals the RVA plus the VirtualSize of\r
829 // the last section mapped into memory (Must be rounded up to\r
b4500f6e 830 // a multiple of Section Alignment). Per the PE/COFF specification, the\r
d071fb19 831 // section headers in the Section Table must appear in order of the RVA\r
832 // values for the corresponding sections. So the ImageSize can be determined\r
833 // by the RVA and the VirtualSize of the last section header in the\r
2bfb6009 834 // Section Table. \r
d071fb19 835 //\r
836 if ((++Index) == (UINTN)Hdr.Te->NumberOfSections) {\r
bf29dc16 837 ImageContext->ImageSize = (SectionHeader.VirtualAddress + SectionHeader.Misc.VirtualSize) - TeStrippedOffset;\r
d071fb19 838 }\r
839\r
840 SectionHeaderOffset += sizeof (EFI_IMAGE_SECTION_HEADER);\r
841 }\r
842\r
843 if (DebugDirectoryEntryFileOffset != 0) {\r
844 for (Index = 0; Index < DebugDirectoryEntry->Size; Index += sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY)) {\r
845 //\r
846 // Read next debug directory entry\r
847 //\r
848 Size = sizeof (EFI_IMAGE_DEBUG_DIRECTORY_ENTRY);\r
3acb1985 849 ReadSize = Size;\r
d071fb19 850 Status = ImageContext->ImageRead (\r
851 ImageContext->Handle,\r
be30ddf7 852 DebugDirectoryEntryFileOffset + Index,\r
d071fb19 853 &Size,\r
854 &DebugEntry\r
855 );\r
3acb1985 856 if (RETURN_ERROR (Status) || (Size != ReadSize)) {\r
d071fb19 857 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
0054ce56
ED		 858 if (Size != ReadSize) {\r
859 Status = RETURN_UNSUPPORTED;\r
860 }\r
d071fb19 861 return Status;\r
862 }\r
863\r
864 if (DebugEntry.Type == EFI_IMAGE_DEBUG_TYPE_CODEVIEW) {\r
865 ImageContext->DebugDirectoryEntryRva = (UINT32) (DebugDirectoryEntryRva + Index);\r
866 return RETURN_SUCCESS;\r
867 }\r
868 }\r
869 }\r
870 }\r
871\r
872 return RETURN_SUCCESS;\r
873}\r
874\r
875\r
876/**\r
877 Converts an image address to the loaded address.\r
878\r
bf29dc16
ED		 879 @param ImageContext The context of the image being loaded.\r
880 @param Address The address to be converted to the loaded address.\r
881 @param TeStrippedOffset Stripped offset for TE image.\r
d071fb19 882\r
883 @return The converted address or NULL if the address can not be converted.\r
884\r
885**/\r
886VOID *\r
887PeCoffLoaderImageAddress (\r
888 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext,\r
bf29dc16
ED		 889 IN UINTN Address, \r
890 IN UINTN TeStrippedOffset\r
d071fb19 891 )\r
892{\r
893 //\r
9833a9bb 894 // Make sure that Address and ImageSize is correct for the loaded image.\r
d071fb19 895 //\r
bf29dc16 896 if (Address >= ImageContext->ImageSize + TeStrippedOffset) {\r
d071fb19 897 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;\r
898 return NULL;\r
899 }\r
900\r
bf29dc16 901 return (CHAR8 *)((UINTN) ImageContext->ImageAddress + Address - TeStrippedOffset);\r
d071fb19 902}\r
903\r
904/**\r
905 Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().\r
906\r
907 If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of\r
908 ImageContext as the relocation base address. Otherwise, use the DestinationAddress field\r
909 of ImageContext as the relocation base address. The caller must allocate the relocation\r
910 fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.\r
efb23117 911 \r
912 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, \r
913 ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, \r
914 DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of \r
915 the ImageContext structure must be valid prior to invoking this service.\r
916 \r
d071fb19 917 If ImageContext is NULL, then ASSERT().\r
918\r
8d579453 919 Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
920 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
921 prior to transferring control to a PE/COFF image that is loaded using this library.\r
922\r
2fc59a00 923 @param ImageContext The pointer to the image context structure that describes the PE/COFF\r
d071fb19 924 image that is being relocated.\r
925\r
926 @retval RETURN_SUCCESS The PE/COFF image was relocated.\r
927 Extended status information is in the ImageError field of ImageContext.\r
928 @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.\r
929 Extended status information is in the ImageError field of ImageContext.\r
930 @retval RETURN_UNSUPPORTED A relocation record type is not supported.\r
931 Extended status information is in the ImageError field of ImageContext.\r
932\r
933**/\r
934RETURN_STATUS\r
935EFIAPI\r
936PeCoffLoaderRelocateImage (\r
937 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
938 )\r
939{\r
940 RETURN_STATUS Status;\r
941 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
942 EFI_IMAGE_DATA_DIRECTORY *RelocDir;\r
943 UINT64 Adjust;\r
944 EFI_IMAGE_BASE_RELOCATION *RelocBase;\r
945 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;\r
946 UINT16 *Reloc;\r
947 UINT16 *RelocEnd;\r
948 CHAR8 *Fixup;\r
949 CHAR8 *FixupBase;\r
1fa524e9 950 UINT16 *Fixup16;\r
951 UINT32 *Fixup32;\r
952 UINT64 *Fixup64;\r
d071fb19 953 CHAR8 *FixupData;\r
954 PHYSICAL_ADDRESS BaseAddress;\r
955 UINT32 NumberOfRvaAndSizes;\r
956 UINT16 Magic;\r
bf29dc16 957 UINT32 TeStrippedOffset;\r
d071fb19 958\r
959 ASSERT (ImageContext != NULL);\r
960\r
961 //\r
962 // Assume success\r
963 //\r
964 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;\r
965\r
966 //\r
967 // If there are no relocation entries, then we are done\r
968 //\r
969 if (ImageContext->RelocationsStripped) {\r
b4500f6e 970 // Applies additional environment specific actions to relocate fixups \r
971 // to a PE/COFF image if needed\r
01a54966 972 PeCoffLoaderRelocateImageExtraAction (ImageContext); \r
d071fb19 973 return RETURN_SUCCESS;\r
974 }\r
975\r
976 //\r
977 // If the destination address is not 0, use that rather than the\r
978 // image address as the relocation target.\r
979 //\r
980 if (ImageContext->DestinationAddress != 0) {\r
981 BaseAddress = ImageContext->DestinationAddress;\r
d071fb19 982 } else {\r
19bee90c 983 BaseAddress = ImageContext->ImageAddress;\r
d071fb19 984 }\r
985\r
986 if (!(ImageContext->IsTeImage)) {\r
987 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);\r
bf29dc16 988 TeStrippedOffset = 0;\r
d071fb19 989 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
990\r
991 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
992 //\r
993 // Use PE32 offset\r
994 //\r
995 Adjust = (UINT64)BaseAddress - Hdr.Pe32->OptionalHeader.ImageBase;\r
2816e216 996 if (Adjust != 0) {\r
997 Hdr.Pe32->OptionalHeader.ImageBase = (UINT32)BaseAddress;\r
998 }\r
d071fb19 999\r
1000 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
1001 RelocDir = &Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1002 } else {\r
1003 //\r
1004 // Use PE32+ offset\r
1005 //\r
1006 Adjust = (UINT64) BaseAddress - Hdr.Pe32Plus->OptionalHeader.ImageBase;\r
2816e216 1007 if (Adjust != 0) {\r
1008 Hdr.Pe32Plus->OptionalHeader.ImageBase = (UINT64)BaseAddress;\r
1009 }\r
d071fb19 1010\r
1011 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
1012 RelocDir = &Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1013 }\r
1014\r
1015 //\r
1016 // Find the relocation block\r
1017 // Per the PE/COFF spec, you can't assume that a given data directory\r
1018 // is present in the image. You have to check the NumberOfRvaAndSizes in\r
1019 // the optional header to verify a desired directory entry is there.\r
1020 //\r
bf29dc16
ED		 1021 if ((NumberOfRvaAndSizes < EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC)) {\r
1022 RelocDir = NULL;\r
d071fb19 1023 }\r
1024 } else {\r
1025 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);\r
bf29dc16
ED		 1026 TeStrippedOffset = (UINT32)Hdr.Te->StrippedSize - sizeof (EFI_TE_IMAGE_HEADER);\r
1027 Adjust = (UINT64) (BaseAddress - (Hdr.Te->ImageBase + TeStrippedOffset));\r
2816e216 1028 if (Adjust != 0) {\r
bf29dc16 1029 Hdr.Te->ImageBase = (UINT64) (BaseAddress - TeStrippedOffset);\r
2816e216 1030 }\r
d071fb19 1031\r
1032 //\r
1033 // Find the relocation block\r
1034 //\r
1035 RelocDir = &Hdr.Te->DataDirectory[0];\r
bf29dc16
ED		 1036 }\r
1037\r
1038 if ((RelocDir != NULL) && (RelocDir->Size > 0)) {\r
1039 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) PeCoffLoaderImageAddress (ImageContext, RelocDir->VirtualAddress, TeStrippedOffset);\r
1040 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *) PeCoffLoaderImageAddress (ImageContext,\r
1041 RelocDir->VirtualAddress + RelocDir->Size - 1,\r
1042 TeStrippedOffset\r
1043 );\r
1044 if (RelocBase == NULL || RelocBaseEnd == NULL) {\r
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
1053\r
1054 //\r
01e1171e 1055 // If Adjust is not zero, then apply fix ups to the image\r
d071fb19 1056 //\r
01e1171e 1057 if (Adjust != 0) {\r
9833a9bb 1058 //\r
01e1171e 1059 // Run the relocation information and apply the fixups\r
9833a9bb 1060 //\r
01e1171e 1061 FixupData = ImageContext->FixupData;\r
1062 while (RelocBase < RelocBaseEnd) {\r
9833a9bb 1063\r
01e1171e 1064 Reloc = (UINT16 *) ((CHAR8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));\r
01e1171e 1065 //\r
72ccedbd 1066 // Add check for RelocBase->SizeOfBlock field.\r
01e1171e 1067 //\r
72ccedbd 1068 if ((RelocBase->SizeOfBlock == 0) || (RelocBase->SizeOfBlock > RelocDir->Size)) {\r
01e1171e 1069 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
9833a9bb
LG		 1070 return RETURN_LOAD_ERROR;\r
1071 }\r
d071fb19 1072\r
72ccedbd 1073 RelocEnd = (UINT16 *) ((CHAR8 *) RelocBase + RelocBase->SizeOfBlock);\r
bf29dc16
ED		 1074 FixupBase = PeCoffLoaderImageAddress (ImageContext, RelocBase->VirtualAddress, TeStrippedOffset);\r
1075 if (FixupBase == NULL) {\r
1076 return RETURN_LOAD_ERROR;\r
1077 } \r
01e1171e 1078\r
1079 //\r
1080 // Run this relocation record\r
1081 //\r
1082 while (Reloc < RelocEnd) {\r
1083\r
1084 Fixup = FixupBase + (*Reloc & 0xFFF);\r
1085 switch ((*Reloc) >> 12) {\r
1086 case EFI_IMAGE_REL_BASED_ABSOLUTE:\r
1087 break;\r
1088\r
1089 case EFI_IMAGE_REL_BASED_HIGH:\r
1090 Fixup16 = (UINT16 *) Fixup;\r
1091 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
1092 if (FixupData != NULL) {\r
1093 *(UINT16 *) FixupData = *Fixup16;\r
1094 FixupData = FixupData + sizeof (UINT16);\r
1095 }\r
1096 break;\r
1097\r
1098 case EFI_IMAGE_REL_BASED_LOW:\r
1099 Fixup16 = (UINT16 *) Fixup;\r
1100 *Fixup16 = (UINT16) (*Fixup16 + (UINT16) Adjust);\r
1101 if (FixupData != NULL) {\r
1102 *(UINT16 *) FixupData = *Fixup16;\r
1103 FixupData = FixupData + sizeof (UINT16);\r
1104 }\r
1105 break;\r
1106\r
1107 case EFI_IMAGE_REL_BASED_HIGHLOW:\r
1108 Fixup32 = (UINT32 *) Fixup;\r
1109 *Fixup32 = *Fixup32 + (UINT32) Adjust;\r
1110 if (FixupData != NULL) {\r
1111 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));\r
1112 *(UINT32 *)FixupData = *Fixup32;\r
1113 FixupData = FixupData + sizeof (UINT32);\r
1114 }\r
1115 break;\r
1116\r
1117 case EFI_IMAGE_REL_BASED_DIR64:\r
1118 Fixup64 = (UINT64 *) Fixup;\r
1119 *Fixup64 = *Fixup64 + (UINT64) Adjust;\r
1120 if (FixupData != NULL) {\r
1121 FixupData = ALIGN_POINTER (FixupData, sizeof(UINT64));\r
1122 *(UINT64 *)(FixupData) = *Fixup64;\r
1123 FixupData = FixupData + sizeof(UINT64);\r
1124 }\r
1125 break;\r
1126\r
1127 default:\r
1128 //\r
1129 // The common code does not handle some of the stranger IPF relocations\r
1130 // PeCoffLoaderRelocateImageEx () adds support for these complex fixups\r
1131 // on IPF and is a No-Op on other architectures.\r
1132 //\r
1133 Status = PeCoffLoaderRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);\r
1134 if (RETURN_ERROR (Status)) {\r
1135 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1136 return Status;\r
1137 }\r
d071fb19 1138 }\r
d071fb19 1139\r
d071fb19 1140 //\r
01e1171e 1141 // Next relocation record\r
d071fb19 1142 //\r
01e1171e 1143 Reloc += 1;\r
d071fb19 1144 }\r
1145\r
1146 //\r
01e1171e 1147 // Next reloc block\r
d071fb19 1148 //\r
01e1171e 1149 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;\r
d071fb19 1150 }\r
1151\r
1152 //\r
01e1171e 1153 // Adjust the EntryPoint to match the linked-to address\r
d071fb19 1154 //\r
01e1171e 1155 if (ImageContext->DestinationAddress != 0) {\r
1156 ImageContext->EntryPoint -= (UINT64) ImageContext->ImageAddress;\r
1157 ImageContext->EntryPoint += (UINT64) ImageContext->DestinationAddress;\r
1158 }\r
19bee90c 1159 }\r
27b2d249 1160 \r
1161 // Applies additional environment specific actions to relocate fixups \r
1162 // to a PE/COFF image if needed\r
1163 PeCoffLoaderRelocateImageExtraAction (ImageContext);\r
1164 \r
d071fb19 1165 return RETURN_SUCCESS;\r
1166}\r
1167\r
1168/**\r
1169 Loads a PE/COFF image into memory.\r
1170\r
1171 Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer\r
1172 specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate\r
1173 the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.\r
b4500f6e 1174 The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.\r
efb23117 1175 The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize, \r
1176 DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva \r
1177 fields of the ImageContext structure must be valid prior to invoking this service.\r
1178 \r
d071fb19 1179 If ImageContext is NULL, then ASSERT().\r
1180\r
8d579453 1181 Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
1182 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
1183 prior to transferring control to a PE/COFF image that is loaded using this library.\r
1184\r
2fc59a00 1185 @param ImageContext The pointer to the image context structure that describes the PE/COFF\r
d071fb19 1186 image that is being loaded.\r
1187\r
1188 @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by\r
1189 the ImageAddress and ImageSize fields of ImageContext.\r
1190 Extended status information is in the ImageError field of ImageContext.\r
1191 @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.\r
1192 Extended status information is in the ImageError field of ImageContext.\r
1193 @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.\r
1194 Extended status information is in the ImageError field of ImageContext.\r
1195 @retval RETURN_INVALID_PARAMETER The image address is invalid.\r
1196 Extended status information is in the ImageError field of ImageContext.\r
1197\r
1198**/\r
1199RETURN_STATUS\r
1200EFIAPI\r
1201PeCoffLoaderLoadImage (\r
1202 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
1203 )\r
1204{\r
1205 RETURN_STATUS Status;\r
1206 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
1207 PE_COFF_LOADER_IMAGE_CONTEXT CheckContext;\r
1208 EFI_IMAGE_SECTION_HEADER *FirstSection;\r
1209 EFI_IMAGE_SECTION_HEADER *Section;\r
1210 UINTN NumberOfSections;\r
1211 UINTN Index;\r
1212 CHAR8 *Base;\r
1213 CHAR8 *End;\r
d071fb19 1214 EFI_IMAGE_DATA_DIRECTORY *DirectoryEntry;\r
1215 EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *DebugEntry;\r
1216 UINTN Size;\r
1217 UINT32 TempDebugEntryRva;\r
1218 UINT32 NumberOfRvaAndSizes;\r
1219 UINT16 Magic;\r
b4500f6e 1220 EFI_IMAGE_RESOURCE_DIRECTORY *ResourceDirectory;\r
1221 EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *ResourceDirectoryEntry;\r
1222 EFI_IMAGE_RESOURCE_DIRECTORY_STRING *ResourceDirectoryString;\r
1223 EFI_IMAGE_RESOURCE_DATA_ENTRY *ResourceDataEntry;\r
bab427db 1224 CHAR16 *String;\r
713ffa20 1225 UINT32 Offset;\r
bf29dc16 1226 UINT32 TeStrippedOffset;\r
d071fb19 1227\r
1228 ASSERT (ImageContext != NULL);\r
1229\r
1230 //\r
1231 // Assume success\r
1232 //\r
1233 ImageContext->ImageError = IMAGE_ERROR_SUCCESS;\r
1234\r
1235 //\r
58380e9c 1236 // Copy the provided context information into our local version, get what we\r
d071fb19 1237 // can from the original image, and then use that to make sure everything\r
1238 // is legit.\r
1239 //\r
1240 CopyMem (&CheckContext, ImageContext, sizeof (PE_COFF_LOADER_IMAGE_CONTEXT));\r
1241\r
1242 Status = PeCoffLoaderGetImageInfo (&CheckContext);\r
1243 if (RETURN_ERROR (Status)) {\r
1244 return Status;\r
1245 }\r
1246\r
1247 //\r
1248 // Make sure there is enough allocated space for the image being loaded\r
1249 //\r
1250 if (ImageContext->ImageSize < CheckContext.ImageSize) {\r
1251 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_SIZE;\r
1252 return RETURN_BUFFER_TOO_SMALL;\r
1253 }\r
1254 if (ImageContext->ImageAddress == 0) {\r
1255 //\r
1256 // Image cannot be loaded into 0 address.\r
1257 //\r
1258 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;\r
1259 return RETURN_INVALID_PARAMETER;\r
1260 }\r
1261 //\r
1262 // If there's no relocations, then make sure it's not a runtime driver,\r
1263 // and that it's being loaded at the linked address.\r
1264 //\r
1265 if (CheckContext.RelocationsStripped) {\r
1266 //\r
1267 // If the image does not contain relocations and it is a runtime driver\r
1268 // then return an error.\r
1269 //\r
1270 if (CheckContext.ImageType == EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER) {\r
1271 ImageContext->ImageError = IMAGE_ERROR_INVALID_SUBSYSTEM;\r
1272 return RETURN_LOAD_ERROR;\r
1273 }\r
1274 //\r
1275 // If the image does not contain relocations, and the requested load address\r
1276 // is not the linked address, then return an error.\r
1277 //\r
1278 if (CheckContext.ImageAddress != ImageContext->ImageAddress) {\r
1279 ImageContext->ImageError = IMAGE_ERROR_INVALID_IMAGE_ADDRESS;\r
1280 return RETURN_INVALID_PARAMETER;\r
1281 }\r
1282 }\r
1283 //\r
1284 // Make sure the allocated space has the proper section alignment\r
1285 //\r
1286 if (!(ImageContext->IsTeImage)) {\r
1287 if ((ImageContext->ImageAddress & (CheckContext.SectionAlignment - 1)) != 0) {\r
1288 ImageContext->ImageError = IMAGE_ERROR_INVALID_SECTION_ALIGNMENT;\r
1289 return RETURN_INVALID_PARAMETER;\r
1290 }\r
1291 }\r
1292 //\r
1293 // Read the entire PE/COFF or TE header into memory\r
1294 //\r
1295 if (!(ImageContext->IsTeImage)) {\r
1296 Status = ImageContext->ImageRead (\r
1297 ImageContext->Handle,\r
1298 0,\r
1299 &ImageContext->SizeOfHeaders,\r
1300 (VOID *) (UINTN) ImageContext->ImageAddress\r
1301 );\r
1302\r
1303 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)((UINTN)ImageContext->ImageAddress + ImageContext->PeCoffHeaderOffset);\r
1304\r
1305 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (\r
1306 (UINTN)ImageContext->ImageAddress +\r
1307 ImageContext->PeCoffHeaderOffset +\r
1308 sizeof(UINT32) +\r
1309 sizeof(EFI_IMAGE_FILE_HEADER) +\r
1310 Hdr.Pe32->FileHeader.SizeOfOptionalHeader\r
1311 );\r
1312 NumberOfSections = (UINTN) (Hdr.Pe32->FileHeader.NumberOfSections);\r
bf29dc16 1313 TeStrippedOffset = 0;\r
d071fb19 1314 } else {\r
1315 Status = ImageContext->ImageRead (\r
1316 ImageContext->Handle,\r
1317 0,\r
1318 &ImageContext->SizeOfHeaders,\r
1319 (void *)(UINTN)ImageContext->ImageAddress\r
1320 );\r
1321\r
1322 Hdr.Te = (EFI_TE_IMAGE_HEADER *)(UINTN)(ImageContext->ImageAddress);\r
d071fb19 1323 FirstSection = (EFI_IMAGE_SECTION_HEADER *) (\r
1324 (UINTN)ImageContext->ImageAddress +\r
1325 sizeof(EFI_TE_IMAGE_HEADER)\r
1326 );\r
1327 NumberOfSections = (UINTN) (Hdr.Te->NumberOfSections);\r
bf29dc16 1328 TeStrippedOffset = (UINT32) Hdr.Te->StrippedSize - sizeof (EFI_TE_IMAGE_HEADER);\r
d071fb19 1329 }\r
1330\r
1331 if (RETURN_ERROR (Status)) {\r
1332 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
1333 return RETURN_LOAD_ERROR;\r
1334 }\r
1335\r
1336 //\r
1337 // Load each section of the image\r
1338 //\r
1339 Section = FirstSection;\r
f8ffa6d7 1340 for (Index = 0; Index < NumberOfSections; Index++) {\r
5cfafa07 1341 //\r
1342 // Read the section\r
1343 //\r
1344 Size = (UINTN) Section->Misc.VirtualSize;\r
1345 if ((Size == 0) || (Size > Section->SizeOfRawData)) {\r
1346 Size = (UINTN) Section->SizeOfRawData;\r
1347 }\r
1348\r
d071fb19 1349 //\r
1350 // Compute sections address\r
1351 //\r
bf29dc16
ED		 1352 Base = PeCoffLoaderImageAddress (ImageContext, Section->VirtualAddress, TeStrippedOffset);\r
1353 End = PeCoffLoaderImageAddress (ImageContext, Section->VirtualAddress + Section->Misc.VirtualSize - 1, TeStrippedOffset);\r
d071fb19 1354\r
d071fb19 1355 //\r
5cfafa07 1356 // If the size of the section is non-zero and the base address or end address resolved to 0, then fail.\r
d071fb19 1357 //\r
5cfafa07 1358 if ((Size > 0) && ((Base == NULL) || (End == NULL))) {\r
d071fb19 1359 ImageContext->ImageError = IMAGE_ERROR_SECTION_NOT_LOADED;\r
1360 return RETURN_LOAD_ERROR;\r
1361 }\r
1362\r
2bfb6009 1363 if (Section->SizeOfRawData > 0) {\r
bf29dc16
ED		 1364 Status = ImageContext->ImageRead (\r
1365 ImageContext->Handle,\r
1366 Section->PointerToRawData - TeStrippedOffset,\r
1367 &Size,\r
1368 Base\r
1369 );\r
d071fb19 1370 if (RETURN_ERROR (Status)) {\r
1371 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
1372 return Status;\r
1373 }\r
1374 }\r
1375\r
1376 //\r
b4500f6e 1377 // If raw size is less then virtual size, zero fill the remaining\r
d071fb19 1378 //\r
1379\r
1380 if (Size < Section->Misc.VirtualSize) {\r
1381 ZeroMem (Base + Size, Section->Misc.VirtualSize - Size);\r
1382 }\r
1383\r
1384 //\r
1385 // Next Section\r
1386 //\r
1387 Section += 1;\r
1388 }\r
1389\r
1390 //\r
1391 // Get image's entry point\r
1392 //\r
1393 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
1394 if (!(ImageContext->IsTeImage)) {\r
1395 //\r
1396 // Sizes of AddressOfEntryPoint are different so we need to do this safely\r
1397 //\r
1398 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1399 //\r
1400 // Use PE32 offset\r
1401 //\r
1402 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (\r
1403 ImageContext,\r
bf29dc16
ED		 1404 (UINTN)Hdr.Pe32->OptionalHeader.AddressOfEntryPoint,\r
1405 0\r
d071fb19 1406 );\r
1407 } else {\r
1408 //\r
1409 // Use PE32+ offset\r
1410 //\r
1411 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (\r
1412 ImageContext,\r
bf29dc16
ED		 1413 (UINTN)Hdr.Pe32Plus->OptionalHeader.AddressOfEntryPoint,\r
1414 0\r
d071fb19 1415 );\r
1416 }\r
1417 } else {\r
bf29dc16
ED		 1418 ImageContext->EntryPoint = (PHYSICAL_ADDRESS)(UINTN)PeCoffLoaderImageAddress (\r
1419 ImageContext,\r
1420 (UINTN)Hdr.Te->AddressOfEntryPoint,\r
1421 TeStrippedOffset\r
1422 );\r
d071fb19 1423 }\r
1424\r
1425 //\r
1426 // Determine the size of the fixup data\r
1427 //\r
1428 // Per the PE/COFF spec, you can't assume that a given data directory\r
1429 // is present in the image. You have to check the NumberOfRvaAndSizes in\r
1430 // the optional header to verify a desired directory entry is there.\r
1431 //\r
1432 if (!(ImageContext->IsTeImage)) {\r
1433 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1434 //\r
1435 // Use PE32 offset\r
1436 //\r
1437 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
1438 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1439 } else {\r
1440 //\r
1441 // Use PE32+ offset\r
1442 //\r
1443 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
1444 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC];\r
1445 }\r
1446\r
1447 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {\r
1448 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINTN);\r
1449 } else {\r
1450 ImageContext->FixupDataSize = 0;\r
1451 }\r
1452 } else {\r
1453 DirectoryEntry = &Hdr.Te->DataDirectory[0];\r
1454 ImageContext->FixupDataSize = DirectoryEntry->Size / sizeof (UINT16) * sizeof (UINTN);\r
1455 }\r
1456 //\r
1457 // Consumer must allocate a buffer for the relocation fixup log.\r
1458 // Only used for runtime drivers.\r
1459 //\r
1460 ImageContext->FixupData = NULL;\r
1461\r
1462 //\r
58380e9c 1463 // Load the Codeview information if present\r
d071fb19 1464 //\r
1465 if (ImageContext->DebugDirectoryEntryRva != 0) {\r
bf29dc16
ED		 1466 DebugEntry = PeCoffLoaderImageAddress (\r
1467 ImageContext,\r
1468 ImageContext->DebugDirectoryEntryRva,\r
1469 TeStrippedOffset\r
1470 );\r
1471 if (DebugEntry == NULL) {\r
1472 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1473 return RETURN_LOAD_ERROR;\r
d071fb19 1474 }\r
1475\r
bf29dc16
ED		 1476 TempDebugEntryRva = DebugEntry->RVA;\r
1477 if (DebugEntry->RVA == 0 && DebugEntry->FileOffset != 0) {\r
1478 Section--;\r
1479 if ((UINTN)Section->SizeOfRawData < Section->Misc.VirtualSize) {\r
1480 TempDebugEntryRva = Section->VirtualAddress + Section->Misc.VirtualSize;\r
1481 } else {\r
1482 TempDebugEntryRva = Section->VirtualAddress + Section->SizeOfRawData;\r
d071fb19 1483 }\r
bf29dc16 1484 }\r
d071fb19 1485\r
bf29dc16
ED		 1486 if (TempDebugEntryRva != 0) {\r
1487 ImageContext->CodeView = PeCoffLoaderImageAddress (ImageContext, TempDebugEntryRva, TeStrippedOffset); \r
1488 if (ImageContext->CodeView == NULL) {\r
1489 ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;\r
1490 return RETURN_LOAD_ERROR;\r
1491 }\r
d071fb19 1492\r
bf29dc16
ED		 1493 if (DebugEntry->RVA == 0) {\r
1494 Size = DebugEntry->SizeOfData;\r
1495 Status = ImageContext->ImageRead (\r
1496 ImageContext->Handle,\r
1497 DebugEntry->FileOffset - TeStrippedOffset,\r
1498 &Size,\r
1499 ImageContext->CodeView\r
1500 );\r
1501 //\r
1502 // Should we apply fix up to this field according to the size difference between PE and TE?\r
1503 // Because now we maintain TE header fields unfixed, this field will also remain as they are\r
1504 // in original PE image.\r
1505 //\r
1506\r
1507 if (RETURN_ERROR (Status)) {\r
d071fb19 1508 ImageContext->ImageError = IMAGE_ERROR_IMAGE_READ;\r
1509 return RETURN_LOAD_ERROR;\r
1510 }\r
1511\r
bf29dc16
ED		 1512 DebugEntry->RVA = TempDebugEntryRva;\r
1513 }\r
d071fb19 1514\r
bf29dc16
ED		 1515 switch (*(UINT32 *) ImageContext->CodeView) {\r
1516 case CODEVIEW_SIGNATURE_NB10:\r
1517 if (DebugEntry->SizeOfData < sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY)) {\r
1518 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1519 return RETURN_UNSUPPORTED;\r
d071fb19 1520 }\r
bf29dc16
ED		 1521 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY);\r
1522 break;\r
d071fb19 1523\r
bf29dc16
ED		 1524 case CODEVIEW_SIGNATURE_RSDS:\r
1525 if (DebugEntry->SizeOfData < sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY)) {\r
1526 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1527 return RETURN_UNSUPPORTED;\r
1528 }\r
1529 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY);\r
1530 break;\r
ebd04fc2 1531\r
bf29dc16
ED		 1532 case CODEVIEW_SIGNATURE_MTOC:\r
1533 if (DebugEntry->SizeOfData < sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY)) {\r
1534 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1535 return RETURN_UNSUPPORTED;\r
d071fb19 1536 }\r
bf29dc16
ED		 1537 ImageContext->PdbPointer = (CHAR8 *)ImageContext->CodeView + sizeof (EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY);\r
1538 break;\r
1539\r
1540 default:\r
1541 break;\r
d071fb19 1542 }\r
1543 }\r
1544 }\r
1545\r
b4500f6e 1546 //\r
1547 // Get Image's HII resource section\r
1548 //\r
1549 ImageContext->HiiResourceData = 0;\r
1550 if (!(ImageContext->IsTeImage)) {\r
1551 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1552 //\r
1553 // Use PE32 offset\r
1554 //\r
713ffa20 1555 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
b4500f6e 1556 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE];\r
1557 } else {\r
1558 //\r
1559 // Use PE32+ offset\r
1560 //\r
713ffa20 1561 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
b4500f6e 1562 DirectoryEntry = (EFI_IMAGE_DATA_DIRECTORY *)&Hdr.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE];\r
1563 }\r
1564\r
713ffa20 1565 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE && DirectoryEntry->Size != 0) {\r
bf29dc16 1566 Base = PeCoffLoaderImageAddress (ImageContext, DirectoryEntry->VirtualAddress, 0);\r
50cd68df 1567 if (Base != NULL) {\r
1568 ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) Base;\r
713ffa20
ED		 1569 Offset = sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * \r
1570 (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);\r
1571 if (Offset > DirectoryEntry->Size) {\r
1572 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1573 return RETURN_UNSUPPORTED;\r
1574 }\r
50cd68df 1575 ResourceDirectoryEntry = (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *) (ResourceDirectory + 1);\r
1576\r
1577 for (Index = 0; Index < ResourceDirectory->NumberOfNamedEntries; Index++) {\r
1578 if (ResourceDirectoryEntry->u1.s.NameIsString) {\r
60893cc3
ED		 1579 //\r
1580 // Check the ResourceDirectoryEntry->u1.s.NameOffset before use it.\r
1581 //\r
1582 if (ResourceDirectoryEntry->u1.s.NameOffset >= DirectoryEntry->Size) {\r
713ffa20
ED		 1583 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1584 return RETURN_UNSUPPORTED;\r
60893cc3 1585 }\r
50cd68df 1586 ResourceDirectoryString = (EFI_IMAGE_RESOURCE_DIRECTORY_STRING *) (Base + ResourceDirectoryEntry->u1.s.NameOffset);\r
bab427db 1587 String = &ResourceDirectoryString->String[0];\r
50cd68df 1588\r
1589 if (ResourceDirectoryString->Length == 3 &&\r
bab427db 1590 String[0] == L'H' &&\r
1591 String[1] == L'I' &&\r
1592 String[2] == L'I') {\r
b4500f6e 1593 //\r
50cd68df 1594 // Resource Type "HII" found\r
b4500f6e 1595 //\r
b4500f6e 1596 if (ResourceDirectoryEntry->u2.s.DataIsDirectory) {\r
1597 //\r
50cd68df 1598 // Move to next level - resource Name\r
b4500f6e 1599 //\r
713ffa20
ED		 1600 if (ResourceDirectoryEntry->u2.s.OffsetToDirectory >= DirectoryEntry->Size) {\r
1601 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1602 return RETURN_UNSUPPORTED;\r
1603 }\r
b4500f6e 1604 ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) (Base + ResourceDirectoryEntry->u2.s.OffsetToDirectory);\r
713ffa20
ED		 1605 Offset = ResourceDirectoryEntry->u2.s.OffsetToDirectory + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + \r
1606 sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);\r
1607 if (Offset > DirectoryEntry->Size) {\r
1608 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1609 return RETURN_UNSUPPORTED;\r
1610 }\r
b4500f6e 1611 ResourceDirectoryEntry = (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *) (ResourceDirectory + 1);\r
50cd68df 1612\r
1613 if (ResourceDirectoryEntry->u2.s.DataIsDirectory) {\r
1614 //\r
1615 // Move to next level - resource Language\r
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
50cd68df 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
50cd68df 1628 ResourceDirectoryEntry = (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY *) (ResourceDirectory + 1);\r
1629 }\r
b4500f6e 1630 }\r
b4500f6e 1631\r
50cd68df 1632 //\r
1633 // Now it ought to be resource Data\r
1634 //\r
1635 if (!ResourceDirectoryEntry->u2.s.DataIsDirectory) {\r
713ffa20
ED		 1636 if (ResourceDirectoryEntry->u2.OffsetToData >= DirectoryEntry->Size) {\r
1637 ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;\r
1638 return RETURN_UNSUPPORTED;\r
1639 }\r
50cd68df 1640 ResourceDataEntry = (EFI_IMAGE_RESOURCE_DATA_ENTRY *) (Base + ResourceDirectoryEntry->u2.OffsetToData);\r
bf29dc16 1641 ImageContext->HiiResourceData = (PHYSICAL_ADDRESS) (UINTN) PeCoffLoaderImageAddress (ImageContext, ResourceDataEntry->OffsetToData, 0);\r
50cd68df 1642 break;\r
1643 }\r
b4500f6e 1644 }\r
1645 }\r
50cd68df 1646 ResourceDirectoryEntry++;\r
b4500f6e 1647 }\r
b4500f6e 1648 }\r
1649 }\r
1650 }\r
1651 \r
d071fb19 1652 return Status;\r
1653}\r
1654\r
1655\r
1656/**\r
1657 Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
efb23117 1658 runtime. \r
1659 \r
9833a9bb
LG		 1660 This function reapplies relocation fixups to the PE/COFF image specified by ImageBase \r
1661 and ImageSize so the image will execute correctly when the PE/COFF image is mapped \r
1662 to the address specified by VirtualImageBase. RelocationData must be identical \r
1663 to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure \r
1664 after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().\r
d071fb19 1665\r
8d579453 1666 Note that if the platform does not maintain coherency between the instruction cache(s) and the data\r
1667 cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
1668 prior to transferring control to a PE/COFF image that is loaded using this library.\r
1669\r
2fc59a00 1670 @param ImageBase The base address of a PE/COFF image that has been loaded \r
efb23117 1671 and relocated into system memory.\r
1672 @param VirtImageBase The request virtual address that the PE/COFF image is to\r
1673 be fixed up for.\r
1674 @param ImageSize The size, in bytes, of the PE/COFF image.\r
1675 @param RelocationData A pointer to the relocation data that was collected when the PE/COFF \r
1676 image was relocated using PeCoffLoaderRelocateImage().\r
1677 \r
d071fb19 1678**/\r
1679VOID\r
1680EFIAPI\r
1681PeCoffLoaderRelocateImageForRuntime (\r
1682 IN PHYSICAL_ADDRESS ImageBase,\r
1683 IN PHYSICAL_ADDRESS VirtImageBase,\r
1684 IN UINTN ImageSize,\r
1685 IN VOID *RelocationData\r
1686 )\r
1687{\r
1688 CHAR8 *OldBase;\r
1689 CHAR8 *NewBase;\r
1690 EFI_IMAGE_DOS_HEADER *DosHdr;\r
1691 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
1692 UINT32 NumberOfRvaAndSizes;\r
1693 EFI_IMAGE_DATA_DIRECTORY *DataDirectory;\r
1694 EFI_IMAGE_DATA_DIRECTORY *RelocDir;\r
1695 EFI_IMAGE_BASE_RELOCATION *RelocBase;\r
1696 EFI_IMAGE_BASE_RELOCATION *RelocBaseEnd;\r
1697 UINT16 *Reloc;\r
1698 UINT16 *RelocEnd;\r
1699 CHAR8 *Fixup;\r
1700 CHAR8 *FixupBase;\r
1fa524e9 1701 UINT16 *Fixup16;\r
1702 UINT32 *Fixup32;\r
1703 UINT64 *Fixup64;\r
d071fb19 1704 CHAR8 *FixupData;\r
1705 UINTN Adjust;\r
1706 RETURN_STATUS Status;\r
1707 UINT16 Magic;\r
1708\r
1709 OldBase = (CHAR8 *)((UINTN)ImageBase);\r
1710 NewBase = (CHAR8 *)((UINTN)VirtImageBase);\r
1711 Adjust = (UINTN) NewBase - (UINTN) OldBase;\r
1712\r
1713 //\r
1714 // Find the image's relocate dir info\r
1715 //\r
1716 DosHdr = (EFI_IMAGE_DOS_HEADER *)OldBase;\r
1717 if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
1718 //\r
1719 // Valid DOS header so get address of PE header\r
1720 //\r
1721 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)(((CHAR8 *)DosHdr) + DosHdr->e_lfanew);\r
1722 } else {\r
1723 //\r
1724 // No Dos header so assume image starts with PE header.\r
1725 //\r
1726 Hdr.Pe32 = (EFI_IMAGE_NT_HEADERS32 *)OldBase;\r
1727 }\r
1728\r
1729 if (Hdr.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {\r
1730 //\r
1731 // Not a valid PE image so Exit\r
1732 //\r
1733 return ;\r
1734 }\r
1735\r
1736 Magic = PeCoffLoaderGetPeHeaderMagicValue (Hdr);\r
1737\r
1738 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
1739 //\r
1740 // Use PE32 offset\r
1741 //\r
1742 NumberOfRvaAndSizes = Hdr.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
1743 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32->OptionalHeader.DataDirectory[0]);\r
1744 } else {\r
1745 //\r
1746 // Use PE32+ offset\r
1747 //\r
1748 NumberOfRvaAndSizes = Hdr.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
1749 DataDirectory = (EFI_IMAGE_DATA_DIRECTORY *)&(Hdr.Pe32Plus->OptionalHeader.DataDirectory[0]);\r
1750 }\r
1751\r
1752 //\r
1753 // Find the relocation block\r
1754 //\r
1755 // Per the PE/COFF spec, you can't assume that a given data directory\r
1756 // is present in the image. You have to check the NumberOfRvaAndSizes in\r
1757 // the optional header to verify a desired directory entry is there.\r
1758 //\r
1759 if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC) {\r
1760 RelocDir = DataDirectory + EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC;\r
1761 RelocBase = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress);\r
1762 RelocBaseEnd = (EFI_IMAGE_BASE_RELOCATION *)(UINTN)(ImageBase + RelocDir->VirtualAddress + RelocDir->Size);\r
1763 } else {\r
1764 //\r
2bfb6009 1765 // Cannot find relocations, cannot continue to relocate the image, ASSERT for this invalid image.\r
d071fb19 1766 //\r
1767 ASSERT (FALSE);\r
1768 return ;\r
1769 }\r
2bfb6009
LG		 1770 \r
1771 //\r
1772 // ASSERT for the invalid image when RelocBase and RelocBaseEnd are both NULL.\r
1773 //\r
d071fb19 1774 ASSERT (RelocBase != NULL && RelocBaseEnd != NULL);\r
1775\r
1776 //\r
1777 // Run the whole relocation block. And re-fixup data that has not been\r
1778 // modified. The FixupData is used to see if the image has been modified\r
1779 // since it was relocated. This is so data sections that have been updated\r
1780 // by code will not be fixed up, since that would set them back to\r
1781 // defaults.\r
1782 //\r
1783 FixupData = RelocationData;\r
1784 while (RelocBase < RelocBaseEnd) {\r
60893cc3
ED		 1785 //\r
1786 // Add check for RelocBase->SizeOfBlock field.\r
1787 //\r
1788 if ((RelocBase->SizeOfBlock == 0) || (RelocBase->SizeOfBlock > RelocDir->Size)) {\r
1789 //\r
1790 // Data invalid, cannot continue to relocate the image, just return.\r
1791 //\r
1792 return;\r
1793 }\r
d071fb19 1794\r
1795 Reloc = (UINT16 *) ((UINT8 *) RelocBase + sizeof (EFI_IMAGE_BASE_RELOCATION));\r
1796 RelocEnd = (UINT16 *) ((UINT8 *) RelocBase + RelocBase->SizeOfBlock);\r
1797 FixupBase = (CHAR8 *) ((UINTN)ImageBase) + RelocBase->VirtualAddress;\r
1798\r
1799 //\r
1800 // Run this relocation record\r
1801 //\r
1802 while (Reloc < RelocEnd) {\r
1803\r
1804 Fixup = FixupBase + (*Reloc & 0xFFF);\r
1805 switch ((*Reloc) >> 12) {\r
1806\r
1807 case EFI_IMAGE_REL_BASED_ABSOLUTE:\r
1808 break;\r
1809\r
1810 case EFI_IMAGE_REL_BASED_HIGH:\r
1fa524e9 1811 Fixup16 = (UINT16 *) Fixup;\r
1812 if (*(UINT16 *) FixupData == *Fixup16) {\r
1813 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) ((UINT32) Adjust >> 16)));\r
d071fb19 1814 }\r
1815\r
1816 FixupData = FixupData + sizeof (UINT16);\r
1817 break;\r
1818\r
1819 case EFI_IMAGE_REL_BASED_LOW:\r
1fa524e9 1820 Fixup16 = (UINT16 *) Fixup;\r
1821 if (*(UINT16 *) FixupData == *Fixup16) {\r
1822 *Fixup16 = (UINT16) (*Fixup16 + ((UINT16) Adjust & 0xffff));\r
d071fb19 1823 }\r
1824\r
1825 FixupData = FixupData + sizeof (UINT16);\r
1826 break;\r
1827\r
1828 case EFI_IMAGE_REL_BASED_HIGHLOW:\r
1fa524e9 1829 Fixup32 = (UINT32 *) Fixup;\r
d071fb19 1830 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT32));\r
1fa524e9 1831 if (*(UINT32 *) FixupData == *Fixup32) {\r
1832 *Fixup32 = *Fixup32 + (UINT32) Adjust;\r
d071fb19 1833 }\r
1834\r
1835 FixupData = FixupData + sizeof (UINT32);\r
1836 break;\r
1837\r
1838 case EFI_IMAGE_REL_BASED_DIR64:\r
1fa524e9 1839 Fixup64 = (UINT64 *)Fixup;\r
d071fb19 1840 FixupData = ALIGN_POINTER (FixupData, sizeof (UINT64));\r
1fa524e9 1841 if (*(UINT64 *) FixupData == *Fixup64) {\r
1842 *Fixup64 = *Fixup64 + (UINT64)Adjust;\r
d071fb19 1843 }\r
1844\r
1845 FixupData = FixupData + sizeof (UINT64);\r
1846 break;\r
1847\r
d071fb19 1848 default:\r
1849 //\r
1850 // Only Itanium requires ConvertPeImage_Ex\r
1851 //\r
1852 Status = PeHotRelocateImageEx (Reloc, Fixup, &FixupData, Adjust);\r
1853 if (RETURN_ERROR (Status)) {\r
1854 return ;\r
1855 }\r
1856 }\r
1857 //\r
1858 // Next relocation record\r
1859 //\r
1860 Reloc += 1;\r
1861 }\r
1862 //\r
1863 // next reloc block\r
1864 //\r
1865 RelocBase = (EFI_IMAGE_BASE_RELOCATION *) RelocEnd;\r
1866 }\r
1867}\r
1868\r
1869\r
1870/**\r
657073df 1871 Reads contents of a PE/COFF image from a buffer in system memory.\r
1872 \r
1873 This is the default implementation of a PE_COFF_LOADER_READ_FILE function \r
1874 that assumes FileHandle pointer to the beginning of a PE/COFF image. \r
1875 This function reads contents of the PE/COFF image that starts at the system memory \r
1876 address specified by FileHandle. The read operation copies ReadSize bytes from the \r
1877 PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer. \r
1878 The size of the buffer actually read is returned in ReadSize.\r
1879 \r
158e788f
ED		 1880 The caller must make sure the FileOffset and ReadSize within the file scope.\r
1881\r
657073df 1882 If FileHandle is NULL, then ASSERT().\r
1883 If ReadSize is NULL, then ASSERT().\r
1884 If Buffer is NULL, then ASSERT().\r
d071fb19 1885\r
2fc59a00 1886 @param FileHandle The pointer to base of the input stream\r
657073df 1887 @param FileOffset Offset into the PE/COFF image to begin the read operation.\r
1888 @param ReadSize On input, the size in bytes of the requested read operation. \r
1889 On output, the number of bytes actually read.\r
1890 @param Buffer Output buffer that contains the data read from the PE/COFF image.\r
d071fb19 1891\r
657073df 1892 @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into \r
d071fb19 1893 the buffer.\r
1894**/\r
1895RETURN_STATUS\r
1896EFIAPI\r
1897PeCoffLoaderImageReadFromMemory (\r
1898 IN VOID *FileHandle,\r
1899 IN UINTN FileOffset,\r
1900 IN OUT UINTN *ReadSize,\r
1901 OUT VOID *Buffer\r
1902 )\r
1903{\r
657073df 1904 ASSERT (ReadSize != NULL);\r
1905 ASSERT (FileHandle != NULL);\r
1906 ASSERT (Buffer != NULL);\r
1907\r
d071fb19 1908 CopyMem (Buffer, ((UINT8 *)FileHandle) + FileOffset, *ReadSize);\r
1909 return RETURN_SUCCESS;\r
1910}\r
1911\r
3d7b0992
LG		 1912/**\r
1913 Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
efb23117 1914 Releases any environment specific resources that were allocated when the image \r
1915 specified by ImageContext was loaded using PeCoffLoaderLoadImage(). \r
1916 \r
3d7b0992
LG		 1917 For NT32 emulator, the PE/COFF image loaded by system needs to release.\r
1918 For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r
1919 this function can simply return RETURN_SUCCESS.\r
efb23117 1920 \r
1921 If ImageContext is NULL, then ASSERT().\r
1922 \r
2fc59a00 1923 @param ImageContext The pointer to the image context structure that describes the PE/COFF\r
3d7b0992
LG		 1924 image to be unloaded.\r
1925\r
1926 @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.\r
1927**/\r
1928RETURN_STATUS\r
1929EFIAPI\r
1930PeCoffLoaderUnloadImage (\r
0465a73e 1931 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
3d7b0992
LG		 1932 )\r
1933{\r
b4500f6e 1934 //\r
27b2d249 1935 // Applies additional environment specific actions to unload a \r
1936 // PE/COFF image if needed\r
b4500f6e 1937 //\r
27b2d249 1938 PeCoffLoaderUnloadImageExtraAction (ImageContext);\r
3d7b0992
LG		 1939 return RETURN_SUCCESS;\r
1940}\r
EFI Development Kit II mirror for PVE