Changeset 58466 in vbox for trunk/src/VBox/Devices/EFI/Firmware/MdePkg/Library/BasePeCoffLib/BasePeCoff.c

Timestamp:

Oct 29, 2015 4:30:44 AM (9 years ago)

Author:

vboxsync

Message:

EFI/Firmware: Merged in the svn:eol-style, svn:mime-type and trailing whitespace cleanup that was done after the initial UDK2014.SP1 import: svn merge ^{/vendor/edk2/UDK2014.SP1} /vendor/edk2/current .

Location:

trunk/src/VBox/Devices/EFI/Firmware

Files:

• . (modified) (1 prop)
• MdePkg/Library/BasePeCoffLib/BasePeCoff.c (modified) (27 diffs)

trunk/src/VBox/Devices/EFI/Firmware/MdePkg/Library/BasePeCoffLib/BasePeCoff.c

@@ -62 +62 @@
 {
   //
-  // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value 
-  //       in the PE/COFF Header.  If the MachineType is Itanium(IA64) and the 
+  // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value
+  //       in the PE/COFF Header.  If the MachineType is Itanium(IA64) and the
   //       Magic value in the OptionalHeader is  EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
   //       then override the returned value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
@@ -78 +78 @@
 
 /**
-  Retrieves the PE or TE Header from a PE/COFF or TE image. 
+  Retrieves the PE or TE Header from a PE/COFF or TE image.
 
   Caution: This function may receive untrusted input.
-  PE/COFF image is external input, so this routine will 
-  also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader, 
-  SizeOfHeader, Section Data Region and Security Data Region be in PE image range. 
+  PE/COFF image is external input, so this routine will
+  also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader,
+  SizeOfHeader, Section Data Region and Security Data Region be in PE image range.
 
   @param  ImageContext    The context of the image being loaded.
@@ -212 +212 @@
     //
     // TE Image Data Directory Entry size is non-zero, but the Data Directory Virtual Address is zero.
-    // This case is not a valid TE image. 
+    // This case is not a valid TE image.
     //
     if ((Hdr.Te->DataDirectory[0].Size != 0 && Hdr.Te->DataDirectory[0].VirtualAddress == 0) ||
@@ -236 +236 @@
       //
       // 2. Check the FileHeader.SizeOfOptionalHeader field.
-      // OptionalHeader.NumberOfRvaAndSizes is not bigger than 16, so 
+      // OptionalHeader.NumberOfRvaAndSizes is not bigger than 16, so
       // OptionalHeader.NumberOfRvaAndSizes * sizeof (EFI_IMAGE_DATA_DIRECTORY) will not overflow.
       //
@@ -350 +350 @@
       //
       // 2. Check the FileHeader.SizeOfOptionalHeader field.
-      // OptionalHeader.NumberOfRvaAndSizes is not bigger than 16, so 
+      // OptionalHeader.NumberOfRvaAndSizes is not bigger than 16, so
       // OptionalHeader.NumberOfRvaAndSizes * sizeof (EFI_IMAGE_DATA_DIRECTORY) will not overflow.
       //
@@ -514 +514 @@
       // Section data should bigger than the Pe header.
       //
-      if (SectionHeader.VirtualAddress < ImageContext->SizeOfHeaders || 
+      if (SectionHeader.VirtualAddress < ImageContext->SizeOfHeaders ||
           SectionHeader.PointerToRawData < ImageContext->SizeOfHeaders) {
         ImageContext->ImageError = IMAGE_ERROR_UNSUPPORTED;
@@ -562 +562 @@
   Retrieves information about a PE/COFF image.
 
-  Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize, 
-  DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and 
-  DebugDirectoryEntryRva fields of the ImageContext structure.  
-  If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.  
-  If the PE/COFF image accessed through the ImageRead service in the ImageContext 
-  structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.  
-  If any errors occur while computing the fields of ImageContext, 
-  then the error status is returned in the ImageError field of ImageContext.  
+  Computes the PeCoffHeaderOffset, IsTeImage, ImageType, ImageAddress, ImageSize,
+  DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and
+  DebugDirectoryEntryRva fields of the ImageContext structure.
+  If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.
+  If the PE/COFF image accessed through the ImageRead service in the ImageContext
+  structure is not a supported PE/COFF image type, then return RETURN_UNSUPPORTED.
+  If any errors occur while computing the fields of ImageContext,
+  then the error status is returned in the ImageError field of ImageContext.
   If the image is a TE image, then SectionAlignment is set to 0.
-  The ImageRead and Handle fields of ImageContext structure must be valid prior 
+  The ImageRead and Handle fields of ImageContext structure must be valid prior
   to invoking this service.
 
   Caution: This function may receive untrusted input.
-  PE/COFF image is external input, so this routine will 
-  also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader, 
-  SizeOfHeader, Section Data Region and Security Data Region be in PE image range. 
+  PE/COFF image is external input, so this routine will
+  also done many checks in PE image to make sure PE image DosHeader, PeOptionHeader,
+  SizeOfHeader, Section Data Region and Security Data Region be in PE image range.
 
   @param  ImageContext              The pointer to the image context structure that describes the PE/COFF
@@ -832 +832 @@
       // values for the corresponding sections. So the ImageSize can be determined
       // by the RVA and the VirtualSize of the last section header in the
-      // Section Table.  
+      // Section Table.
       //
       if ((++Index) == (UINTN)Hdr.Te->NumberOfSections) {
@@ -887 +887 @@
 PeCoffLoaderImageAddress (
   IN OUT PE_COFF_LOADER_IMAGE_CONTEXT          *ImageContext,
-  IN     UINTN                                 Address, 
+  IN     UINTN                                 Address,
   IN     UINTN                                 TeStrippedOffset
   )
@@ -909 +909 @@
   of ImageContext as the relocation base address.  The caller must allocate the relocation
   fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
-  
-  The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage, Machine, ImageType, ImageAddress, 
-  ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, 
-  DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of 
+
+  The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage, Machine, ImageType, ImageAddress,
+  ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
+  DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
   the ImageContext structure must be valid prior to invoking this service.
-    
+
   If ImageContext is NULL, then ASSERT().
 
@@ -969 +969 @@
   //
   if (ImageContext->RelocationsStripped) {
-    // Applies additional environment specific actions to relocate fixups 
+    // Applies additional environment specific actions to relocate fixups
     // to a PE/COFF image if needed
-    PeCoffLoaderRelocateImageExtraAction (ImageContext);  
+    PeCoffLoaderRelocateImageExtraAction (ImageContext);
     return RETURN_SUCCESS;
   }
@@ -1051 +1051 @@
     // Set base and end to bypass processing below.
     //
-    RelocBase = RelocBaseEnd = NULL;    
+    RelocBase = RelocBaseEnd = NULL;
   }
   RelocBaseOrg = RelocBase;
@@ -1087 +1087 @@
         ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;
         return RETURN_LOAD_ERROR;
-      }  
+      }
 
       //
@@ -1174 +1174 @@
     }
   }
-  
-  // Applies additional environment specific actions to relocate fixups 
+
+  // Applies additional environment specific actions to relocate fixups
   // to a PE/COFF image if needed
   PeCoffLoaderRelocateImageExtraAction (ImageContext);
-  
+
   return RETURN_SUCCESS;
 }
@@ -1189 +1189 @@
   the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
   The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.
-  The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage,  Machine, ImageType, ImageAddress, ImageSize, 
-  DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva 
+  The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage,  Machine, ImageType, ImageAddress, ImageSize,
+  DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
   fields of the ImageContext structure must be valid prior to invoking this service.
-  
+
   If ImageContext is NULL, then ASSERT().
 
@@ -1504 +1504 @@
 
     if (TempDebugEntryRva != 0) {
-      ImageContext->CodeView = PeCoffLoaderImageAddress (ImageContext, TempDebugEntryRva, TeStrippedOffset); 
+      ImageContext->CodeView = PeCoffLoaderImageAddress (ImageContext, TempDebugEntryRva, TeStrippedOffset);
       if (ImageContext->CodeView == NULL) {
         ImageContext->ImageError = IMAGE_ERROR_FAILED_RELOCATION;
@@ -1586 +1586 @@
       if (Base != NULL) {
         ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) Base;
-        Offset = sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * 
+        Offset = sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) *
                (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);
         if (Offset > DirectoryEntry->Size) {
@@ -1622 +1622 @@
                 }
                 ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) (Base + ResourceDirectoryEntry->u2.s.OffsetToDirectory);
-                Offset = ResourceDirectoryEntry->u2.s.OffsetToDirectory + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + 
+                Offset = ResourceDirectoryEntry->u2.s.OffsetToDirectory + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) +
                          sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);
                 if (Offset > DirectoryEntry->Size) {
@@ -1639 +1639 @@
                   }
                   ResourceDirectory = (EFI_IMAGE_RESOURCE_DIRECTORY *) (Base + ResourceDirectoryEntry->u2.s.OffsetToDirectory);
-                  Offset = ResourceDirectoryEntry->u2.s.OffsetToDirectory + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) + 
+                  Offset = ResourceDirectoryEntry->u2.s.OffsetToDirectory + sizeof (EFI_IMAGE_RESOURCE_DIRECTORY) +
                            sizeof (EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY) * (ResourceDirectory->NumberOfNamedEntries + ResourceDirectory->NumberOfIdEntries);
                   if (Offset > DirectoryEntry->Size) {
@@ -1668 +1668 @@
     }
   }
- 
+
   return Status;
 }
@@ -1675 +1675 @@
 /**
   Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
-  runtime. 
-  
-  This function reapplies relocation fixups to the PE/COFF image specified by ImageBase 
-  and ImageSize so the image will execute correctly when the PE/COFF image is mapped 
-  to the address specified by VirtualImageBase.  RelocationData must be identical 
-  to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure 
+  runtime.
+
+  This function reapplies relocation fixups to the PE/COFF image specified by ImageBase
+  and ImageSize so the image will execute correctly when the PE/COFF image is mapped
+  to the address specified by VirtualImageBase.  RelocationData must be identical
+  to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure
   after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
 
@@ -1687 +1687 @@
   prior to transferring control to a PE/COFF image that is loaded using this library.
 
-  @param  ImageBase          The base address of a PE/COFF image that has been loaded 
+  @param  ImageBase          The base address of a PE/COFF image that has been loaded
                              and relocated into system memory.
   @param  VirtImageBase      The request virtual address that the PE/COFF image is to
                              be fixed up for.
   @param  ImageSize          The size, in bytes, of the PE/COFF image.
-  @param  RelocationData     A pointer to the relocation data that was collected when the PE/COFF 
+  @param  RelocationData     A pointer to the relocation data that was collected when the PE/COFF
                              image was relocated using PeCoffLoaderRelocateImage().
-  
+
 **/
 VOID
@@ -1787 +1787 @@
     return ;
   }
-  
+
   //
   // ASSERT for the invalid image when RelocBase and RelocBaseEnd are both NULL.
@@ -1889 +1889 @@
 /**
   Reads contents of a PE/COFF image from a buffer in system memory.
-   
-  This is the default implementation of a PE_COFF_LOADER_READ_FILE function 
-  that assumes FileHandle pointer to the beginning of a PE/COFF image.   
-  This function reads contents of the PE/COFF image that starts at the system memory 
-  address specified by FileHandle.  The read operation copies ReadSize bytes from the 
-  PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.  
+
+  This is the default implementation of a PE_COFF_LOADER_READ_FILE function
+  that assumes FileHandle pointer to the beginning of a PE/COFF image.
+  This function reads contents of the PE/COFF image that starts at the system memory
+  address specified by FileHandle.  The read operation copies ReadSize bytes from the
+  PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
   The size of the buffer actually read is returned in ReadSize.
-  
+
   The caller must make sure the FileOffset and ReadSize within the file scope.
 
@@ -1905 +1905 @@
   @param  FileHandle        The pointer to base of the input stream
   @param  FileOffset        Offset into the PE/COFF image to begin the read operation.
-  @param  ReadSize          On input, the size in bytes of the requested read operation.  
+  @param  ReadSize          On input, the size in bytes of the requested read operation.
                             On output, the number of bytes actually read.
   @param  Buffer            Output buffer that contains the data read from the PE/COFF image.
 
-  @retval RETURN_SUCCESS    Data is read from FileOffset from the Handle into 
+  @retval RETURN_SUCCESS    Data is read from FileOffset from the Handle into
                             the buffer.
 **/
@@ -1931 +1931 @@
 /**
   Unloads a loaded PE/COFF image from memory and releases its taken resource.
-  Releases any environment specific resources that were allocated when the image 
-  specified by ImageContext was loaded using PeCoffLoaderLoadImage(). 
- 
+  Releases any environment specific resources that were allocated when the image
+  specified by ImageContext was loaded using PeCoffLoaderLoadImage().
+
   For NT32 emulator, the PE/COFF image loaded by system needs to release.
-  For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, 
+  For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
   this function can simply return RETURN_SUCCESS.
-  
+
   If ImageContext is NULL, then ASSERT().
-  
+
   @param  ImageContext              The pointer to the image context structure that describes the PE/COFF
                                     image to be unloaded.
@@ -1952 +1952 @@
 {
   //
-  // Applies additional environment specific actions to unload a 
+  // Applies additional environment specific actions to unload a
   // PE/COFF image if needed
   //