]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BasePeCoffLib/Ipf/PeCoffLoaderEx.c
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Library / BasePeCoffLib / Ipf / PeCoffLoaderEx.c
index babf7ca3a2367574fae874d0605795304d77b097..41580e56a7ea3430e5ea9e721f3d32ccaa1c14e2 100644 (file)
@@ -1,20 +1,18 @@
 /** @file\r
   Fixes Intel Itanium(TM) specific relocation types.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  PeCoffLoaderEx.c\r
-\r
 **/\r
 \r
-\r
+#include "BasePeCoffLibInternals.h"\r
 \r
 \r
 \r
 #define IMM64_IC_INST_WORD_POS_X        12\r
 #define IMM64_IC_VAL_POS_X              21\r
 \r
-#define IMM64_IMM41a_INST_WORD_X        1\r
-#define IMM64_IMM41a_SIZE_X             10\r
-#define IMM64_IMM41a_INST_WORD_POS_X    14\r
-#define IMM64_IMM41a_VAL_POS_X          22\r
+#define IMM64_IMM41A_INST_WORD_X        1\r
+#define IMM64_IMM41A_SIZE_X             10\r
+#define IMM64_IMM41A_INST_WORD_POS_X    14\r
+#define IMM64_IMM41A_VAL_POS_X          22\r
 \r
-#define IMM64_IMM41b_INST_WORD_X        1\r
-#define IMM64_IMM41b_SIZE_X             8\r
-#define IMM64_IMM41b_INST_WORD_POS_X    24\r
-#define IMM64_IMM41b_VAL_POS_X          32\r
+#define IMM64_IMM41B_INST_WORD_X        1\r
+#define IMM64_IMM41B_SIZE_X             8\r
+#define IMM64_IMM41B_INST_WORD_POS_X    24\r
+#define IMM64_IMM41B_VAL_POS_X          32\r
 \r
-#define IMM64_IMM41c_INST_WORD_X        2\r
-#define IMM64_IMM41c_SIZE_X             23\r
-#define IMM64_IMM41c_INST_WORD_POS_X    0\r
-#define IMM64_IMM41c_VAL_POS_X          40\r
+#define IMM64_IMM41C_INST_WORD_X        2\r
+#define IMM64_IMM41C_SIZE_X             23\r
+#define IMM64_IMM41C_INST_WORD_POS_X    0\r
+#define IMM64_IMM41C_VAL_POS_X          40\r
 \r
 #define IMM64_SIGN_INST_WORD_X          3\r
 #define IMM64_SIGN_SIZE_X               1\r
 /**\r
   Performs an Itanium-based specific relocation fixup.\r
 \r
-  @param  Reloc       Pointer to the relocation record.\r
-  @param  Fixup       Pointer to the address to fix up.\r
-  @param  FixupData   Pointer to a buffer to log the fixups.\r
+  @param  Reloc       The pointer to the relocation record.\r
+  @param  Fixup       The pointer to the address to fix up.\r
+  @param  FixupData   The pointer to a buffer to log the fixups.\r
   @param  Adjust      The offset to adjust the fixup.\r
 \r
-  @return Status code.\r
+  @retval RETURN_SUCCESS Succeed to fix the relocation entry.\r
+  @retval RETURN_UNSUPPOTED Unrecoganized relocation entry.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -84,7 +83,7 @@ PeCoffLoaderRelocateImageEx (
   IN UINT64      Adjust\r
   )\r
 {\r
-  UINT64      *F64;\r
+  UINT64      *Fixup64;\r
   UINT64      FixupVal;\r
 \r
   switch ((*Reloc) >> 12) {\r
@@ -130,10 +129,10 @@ PeCoffLoaderRelocateImageEx (
                 );\r
 \r
       EXT_IMM64(FixupVal,\r
-                (UINT32 *)Fixup + IMM64_IMM41a_INST_WORD_X,\r
-                IMM64_IMM41a_SIZE_X,\r
-                IMM64_IMM41a_INST_WORD_POS_X,\r
-                IMM64_IMM41a_VAL_POS_X\r
+                (UINT32 *)Fixup + IMM64_IMM41A_INST_WORD_X,\r
+                IMM64_IMM41A_SIZE_X,\r
+                IMM64_IMM41A_INST_WORD_POS_X,\r
+                IMM64_IMM41A_VAL_POS_X\r
                 );\r
 \r
       //\r
@@ -173,24 +172,24 @@ PeCoffLoaderRelocateImageEx (
                 );\r
 \r
       INS_IMM64(FixupVal,\r
-                ((UINT32 *)Fixup + IMM64_IMM41a_INST_WORD_X),\r
-                IMM64_IMM41a_SIZE_X,\r
-                IMM64_IMM41a_INST_WORD_POS_X,\r
-                IMM64_IMM41a_VAL_POS_X\r
+                ((UINT32 *)Fixup + IMM64_IMM41A_INST_WORD_X),\r
+                IMM64_IMM41A_SIZE_X,\r
+                IMM64_IMM41A_INST_WORD_POS_X,\r
+                IMM64_IMM41A_VAL_POS_X\r
                 );\r
 \r
       INS_IMM64(FixupVal,\r
-                ((UINT32 *)Fixup + IMM64_IMM41b_INST_WORD_X),\r
-                IMM64_IMM41b_SIZE_X,\r
-                IMM64_IMM41b_INST_WORD_POS_X,\r
-                IMM64_IMM41b_VAL_POS_X\r
+                ((UINT32 *)Fixup + IMM64_IMM41B_INST_WORD_X),\r
+                IMM64_IMM41B_SIZE_X,\r
+                IMM64_IMM41B_INST_WORD_POS_X,\r
+                IMM64_IMM41B_VAL_POS_X\r
                 );\r
 \r
       INS_IMM64(FixupVal,\r
-                ((UINT32 *)Fixup + IMM64_IMM41c_INST_WORD_X),\r
-                IMM64_IMM41c_SIZE_X,\r
-                IMM64_IMM41c_INST_WORD_POS_X,\r
-                IMM64_IMM41c_VAL_POS_X\r
+                ((UINT32 *)Fixup + IMM64_IMM41C_INST_WORD_X),\r
+                IMM64_IMM41C_SIZE_X,\r
+                IMM64_IMM41C_INST_WORD_POS_X,\r
+                IMM64_IMM41C_VAL_POS_X\r
                 );\r
 \r
       INS_IMM64(FixupVal,\r
@@ -200,10 +199,10 @@ PeCoffLoaderRelocateImageEx (
                 IMM64_SIGN_VAL_POS_X\r
                 );\r
 \r
-      F64 = (UINT64 *) Fixup;\r
+      Fixup64 = (UINT64 *) Fixup;\r
       if (*FixupData != NULL) {\r
         *FixupData = ALIGN_POINTER(*FixupData, sizeof(UINT64));\r
-        *(UINT64 *)(*FixupData) = *F64;\r
+        *(UINT64 *)(*FixupData) = *Fixup64;\r
         *FixupData = *FixupData + sizeof(UINT64);\r
       }\r
       break;\r
@@ -221,14 +220,12 @@ PeCoffLoaderRelocateImageEx (
   loading and relocating of the image type. It's up to the caller to support\r
   the entry point.\r
 \r
-  This function implies the basic PE/COFF loader/relocator supports IA32, EBC,\r
-  & X64 images. Calling the entry point in a correct mannor is up to the\r
-  consumer of this library. This version also supports the special relocations\r
-  for Itanium.\r
+  The itanium version PE/COFF loader/relocater supports itanium and EBC image.\r
 \r
   @param  Machine   Machine type from the PE Header.\r
 \r
   @return TRUE if this PE/COFF loader can load the image\r
+  @return FALSE unrecoganized machine type of image.\r
 \r
 **/\r
 BOOLEAN\r
@@ -236,8 +233,7 @@ PeCoffLoaderImageFormatSupported (
   IN  UINT16  Machine\r
   )\r
 {\r
-  if ((Machine == EFI_IMAGE_MACHINE_IPF) || (Machine == EFI_IMAGE_MACHINE_IA32) ||\r
-      (Machine ==  EFI_IMAGE_MACHINE_EBC) || (Machine == EFI_IMAGE_MACHINE_X64)) {\r
+  if ((Machine == IMAGE_FILE_MACHINE_IA64) || (Machine == IMAGE_FILE_MACHINE_EBC)) {\r
     return TRUE;\r
   }\r
 \r
@@ -251,11 +247,13 @@ PeCoffLoaderImageFormatSupported (
 \r
   @param  Reloc             Ponter to baes of the input stream\r
   @param  Fixup             Offset to the start of the buffer\r
-  @param  FixupData         Number of bytes to copy into the buffer\r
+  @param  FixupData         The number of bytes to copy into the buffer\r
   @param  Adjust            Location to place results of read\r
 \r
   @retval RETURN_SUCCESS    Data is read from FileOffset from the Handle into\r
                             the buffer.\r
+  @retval RETURN_UNSUPPORTED Un-recoganized relocation entry\r
+                             type.\r
 **/\r
 RETURN_STATUS\r
 PeHotRelocateImageEx (\r
@@ -265,24 +263,24 @@ PeHotRelocateImageEx (
   IN UINT64      Adjust\r
   )\r
 {\r
-  UINT64  *F64;\r
+  UINT64  *Fixup64;\r
   UINT64  FixupVal;\r
 \r
   switch ((*Reloc) >> 12) {\r
   case EFI_IMAGE_REL_BASED_DIR64:\r
-    F64         = (UINT64 *) Fixup;\r
+    Fixup64     = (UINT64 *) Fixup;\r
     *FixupData  = ALIGN_POINTER (*FixupData, sizeof (UINT64));\r
-    if (*(UINT64 *) (*FixupData) == *F64) {\r
-      *F64 = *F64 + (UINT64) Adjust;\r
+    if (*(UINT64 *) (*FixupData) == *Fixup64) {\r
+      *Fixup64 = *Fixup64 + (UINT64) Adjust;\r
     }\r
 \r
     *FixupData = *FixupData + sizeof (UINT64);\r
     break;\r
 \r
   case EFI_IMAGE_REL_BASED_IA64_IMM64:\r
-    F64         = (UINT64 *) Fixup;\r
+    Fixup64     = (UINT64 *) Fixup;\r
     *FixupData  = ALIGN_POINTER (*FixupData, sizeof (UINT64));\r
-    if (*(UINT64 *) (*FixupData) == *F64) {\r
+    if (*(UINT64 *) (*FixupData) == *Fixup64) {\r
       //\r
       // Align it to bundle address before fixing up the\r
       // 64-bit immediate value of the movl instruction.\r
@@ -328,10 +326,10 @@ PeHotRelocateImageEx (
 \r
       EXT_IMM64 (\r
         FixupVal,\r
-        (UINT32 *) Fixup + IMM64_IMM41a_INST_WORD_X,\r
-        IMM64_IMM41a_SIZE_X,\r
-        IMM64_IMM41a_INST_WORD_POS_X,\r
-        IMM64_IMM41a_VAL_POS_X\r
+        (UINT32 *) Fixup + IMM64_IMM41A_INST_WORD_X,\r
+        IMM64_IMM41A_SIZE_X,\r
+        IMM64_IMM41A_INST_WORD_POS_X,\r
+        IMM64_IMM41A_VAL_POS_X\r
         );\r
 \r
       //\r
@@ -376,26 +374,26 @@ PeHotRelocateImageEx (
 \r
       INS_IMM64 (\r
         FixupVal,\r
-        ((UINT32 *) Fixup + IMM64_IMM41a_INST_WORD_X),\r
-        IMM64_IMM41a_SIZE_X,\r
-        IMM64_IMM41a_INST_WORD_POS_X,\r
-        IMM64_IMM41a_VAL_POS_X\r
+        ((UINT32 *) Fixup + IMM64_IMM41A_INST_WORD_X),\r
+        IMM64_IMM41A_SIZE_X,\r
+        IMM64_IMM41A_INST_WORD_POS_X,\r
+        IMM64_IMM41A_VAL_POS_X\r
         );\r
 \r
       INS_IMM64 (\r
         FixupVal,\r
-        ((UINT32 *) Fixup + IMM64_IMM41b_INST_WORD_X),\r
-        IMM64_IMM41b_SIZE_X,\r
-        IMM64_IMM41b_INST_WORD_POS_X,\r
-        IMM64_IMM41b_VAL_POS_X\r
+        ((UINT32 *) Fixup + IMM64_IMM41B_INST_WORD_X),\r
+        IMM64_IMM41B_SIZE_X,\r
+        IMM64_IMM41B_INST_WORD_POS_X,\r
+        IMM64_IMM41B_VAL_POS_X\r
         );\r
 \r
       INS_IMM64 (\r
         FixupVal,\r
-        ((UINT32 *) Fixup + IMM64_IMM41c_INST_WORD_X),\r
-        IMM64_IMM41c_SIZE_X,\r
-        IMM64_IMM41c_INST_WORD_POS_X,\r
-        IMM64_IMM41c_VAL_POS_X\r
+        ((UINT32 *) Fixup + IMM64_IMM41C_INST_WORD_X),\r
+        IMM64_IMM41C_SIZE_X,\r
+        IMM64_IMM41C_INST_WORD_POS_X,\r
+        IMM64_IMM41C_VAL_POS_X\r
         );\r
 \r
       INS_IMM64 (\r
@@ -406,7 +404,7 @@ PeHotRelocateImageEx (
         IMM64_SIGN_VAL_POS_X\r
         );\r
 \r
-      *(UINT64 *) (*FixupData) = *F64;\r
+      *(UINT64 *) (*FixupData) = *Fixup64;\r
     }\r
 \r
     *FixupData = *FixupData + sizeof (UINT64);\r