add debug information.
authorvanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Wed, 21 May 2008 08:32:06 +0000 (08:32 +0000)
committervanjeff <vanjeff@de2fecce-e211-0410-80a6-f3fac2684e05>
Wed, 21 May 2008 08:32:06 +0000 (08:32 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@5266 de2fecce-e211-0410-80a6-f3fac2684e05

edk2/MdeModulePkg/Core/Dxe/Image/Image.c

index 64e5e34..b4a1581 100644 (file)
@@ -76,7 +76,7 @@ LOADED_IMAGE_PRIVATE_DATA mCorePrivateImage  = {
   Add the Image Services to EFI Boot Services Table and install the protocol\r
   interfaces for this image.\r
 \r
-  @param  HobStart                The HOB to initialize \r
+  @param  HobStart                The HOB to initialize\r
 \r
   @return Status code.\r
 \r
@@ -158,27 +158,27 @@ CoreInitializeImageServices (
 /**\r
   Loads, relocates, and invokes a PE/COFF image\r
 \r
-  @param  BootPolicy              If TRUE, indicates that the request originates \r
-                                  from the boot manager, and that the boot \r
-                                  manager is attempting to load FilePath as a \r
-                                  boot selection. \r
-  @param  Pe32Handle              The handle of PE32 image \r
-  @param  Image                   PE image to be loaded \r
-  @param  DstBuffer               The buffer to store the image \r
-  @param  EntryPoint              A pointer to the entry point \r
-  @param  Attribute               The bit mask of attributes to set for the load \r
-                                  PE image \r
-\r
-  @retval EFI_SUCCESS             The file was loaded, relocated, and invoked \r
-  @retval EFI_OUT_OF_RESOURCES    There was not enough memory to load and \r
-                                  relocate the PE/COFF file \r
-  @retval EFI_INVALID_PARAMETER   Invalid parameter \r
+  @param  BootPolicy              If TRUE, indicates that the request originates\r
+                                  from the boot manager, and that the boot\r
+                                  manager is attempting to load FilePath as a\r
+                                  boot selection.\r
+  @param  Pe32Handle              The handle of PE32 image\r
+  @param  Image                   PE image to be loaded\r
+  @param  DstBuffer               The buffer to store the image\r
+  @param  EntryPoint              A pointer to the entry point\r
+  @param  Attribute               The bit mask of attributes to set for the load\r
+                                  PE image\r
+\r
+  @retval EFI_SUCCESS             The file was loaded, relocated, and invoked\r
+  @retval EFI_OUT_OF_RESOURCES    There was not enough memory to load and\r
+                                  relocate the PE/COFF file\r
+  @retval EFI_INVALID_PARAMETER   Invalid parameter\r
   @retval EFI_BUFFER_TOO_SMALL    Buffer for image is too small\r
 \r
 **/\r
 EFI_STATUS\r
 CoreLoadPeImage (\r
-  IN BOOLEAN                     BootPolicy,  \r
+  IN BOOLEAN                     BootPolicy,\r
   IN VOID                        *Pe32Handle,\r
   IN LOADED_IMAGE_PRIVATE_DATA   *Image,\r
   IN EFI_PHYSICAL_ADDRESS        DstBuffer    OPTIONAL,\r
@@ -216,7 +216,7 @@ CoreLoadPeImage (
       return EFI_UNSUPPORTED;\r
     }\r
   }\r
-  \r
+\r
   //\r
   // Set EFI memory type based on ImageType\r
   //\r
@@ -396,6 +396,7 @@ CoreLoadPeImage (
     //\r
     Status = CoreLocateProtocol (&gEfiEbcProtocolGuid, NULL, (VOID **)&Image->Ebc);\r
     if (EFI_ERROR(Status)) {\r
+      DEBUG ((DEBUG_LOAD | DEBUG_ERROR, "CoreLoadPeImage: There is no EBC interpreter for an EBC image.\n"));\r
       goto Done;\r
     }\r
 \r
@@ -464,22 +465,22 @@ CoreLoadPeImage (
     UINTN Index;\r
     UINTN StartIndex;\r
     CHAR8 EfiFileName[256];\r
-    \r
+\r
     if (Image->ImageContext.Machine != IMAGE_FILE_MACHINE_IA64) {\r
-      DEBUG ((DEBUG_INFO | DEBUG_LOAD, \r
-              "Loading driver at 0x%10p EntryPoint=0x%10p ", \r
-              (VOID *)(UINTN)Image->ImageContext.ImageAddress, \r
+      DEBUG ((DEBUG_INFO | DEBUG_LOAD,\r
+              "Loading driver at 0x%10p EntryPoint=0x%10p ",\r
+              (VOID *)(UINTN)Image->ImageContext.ImageAddress,\r
               (VOID *)(UINTN)Image->ImageContext.EntryPoint));\r
     } else {\r
       //\r
       // For IPF Image, the real entry point should be print.\r
-      //      \r
-      DEBUG ((DEBUG_INFO | DEBUG_LOAD, \r
-              "Loading driver at 0x%10p EntryPoint=0x%10p ", \r
-              (VOID *)(UINTN)Image->ImageContext.ImageAddress, \r
+      //\r
+      DEBUG ((DEBUG_INFO | DEBUG_LOAD,\r
+              "Loading driver at 0x%10p EntryPoint=0x%10p ",\r
+              (VOID *)(UINTN)Image->ImageContext.ImageAddress,\r
               (VOID *)(UINTN)(*(UINT64 *)(UINTN)Image->ImageContext.EntryPoint)));\r
     }\r
-    \r
+\r
     //\r
     // Print Module Name by Pdb file path\r
     //\r
@@ -536,7 +537,7 @@ Done:
 /**\r
   Get the image's private data from its handle.\r
 \r
-  @param  ImageHandle             The image handle \r
+  @param  ImageHandle             The image handle\r
 \r
   @return Return the image private data associated with ImageHandle.\r
 \r
@@ -569,36 +570,36 @@ CoreLoadedImageInfo (
 /**\r
   Loads an EFI image into memory and returns a handle to the image.\r
 \r
-  @param  BootPolicy              If TRUE, indicates that the request originates \r
-                                  from the boot manager, and that the boot \r
-                                  manager is attempting to load FilePath as a \r
-                                  boot selection. \r
-  @param  ParentImageHandle       The caller's image handle. \r
-  @param  FilePath                The specific file path from which the image is \r
-                                  loaded. \r
-  @param  SourceBuffer            If not NULL, a pointer to the memory location \r
-                                  containing a copy of the image to be loaded. \r
-  @param  SourceSize              The size in bytes of SourceBuffer. \r
-  @param  DstBuffer               The buffer to store the image \r
-  @param  NumberOfPages           If not NULL, it inputs a pointer to the page \r
-                                  number of DstBuffer and outputs a pointer to \r
-                                  the page number of the image. If this number is \r
-                                  not enough,  return EFI_BUFFER_TOO_SMALL and \r
-                                  this parameter contains the required number. \r
-  @param  ImageHandle             Pointer to the returned image handle that is \r
-                                  created when the image is successfully loaded. \r
-  @param  EntryPoint              A pointer to the entry point \r
-  @param  Attribute               The bit mask of attributes to set for the load \r
-                                  PE image \r
-\r
-  @retval EFI_SUCCESS             The image was loaded into memory. \r
-  @retval EFI_NOT_FOUND           The FilePath was not found. \r
-  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value. \r
-  @retval EFI_BUFFER_TOO_SMALL    The buffer is too small \r
-  @retval EFI_UNSUPPORTED         The image type is not supported, or the device \r
-                                  path cannot be parsed to locate the proper \r
-                                  protocol for loading the file. \r
-  @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient \r
+  @param  BootPolicy              If TRUE, indicates that the request originates\r
+                                  from the boot manager, and that the boot\r
+                                  manager is attempting to load FilePath as a\r
+                                  boot selection.\r
+  @param  ParentImageHandle       The caller's image handle.\r
+  @param  FilePath                The specific file path from which the image is\r
+                                  loaded.\r
+  @param  SourceBuffer            If not NULL, a pointer to the memory location\r
+                                  containing a copy of the image to be loaded.\r
+  @param  SourceSize              The size in bytes of SourceBuffer.\r
+  @param  DstBuffer               The buffer to store the image\r
+  @param  NumberOfPages           If not NULL, it inputs a pointer to the page\r
+                                  number of DstBuffer and outputs a pointer to\r
+                                  the page number of the image. If this number is\r
+                                  not enough,  return EFI_BUFFER_TOO_SMALL and\r
+                                  this parameter contains the required number.\r
+  @param  ImageHandle             Pointer to the returned image handle that is\r
+                                  created when the image is successfully loaded.\r
+  @param  EntryPoint              A pointer to the entry point\r
+  @param  Attribute               The bit mask of attributes to set for the load\r
+                                  PE image\r
+\r
+  @retval EFI_SUCCESS             The image was loaded into memory.\r
+  @retval EFI_NOT_FOUND           The FilePath was not found.\r
+  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value.\r
+  @retval EFI_BUFFER_TOO_SMALL    The buffer is too small\r
+  @retval EFI_UNSUPPORTED         The image type is not supported, or the device\r
+                                  path cannot be parsed to locate the proper\r
+                                  protocol for loading the file.\r
+  @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient\r
                                   resources.\r
 \r
 **/\r
@@ -747,7 +748,7 @@ CoreLoadImageCommon (
 \r
   if (NumberOfPages != NULL) {\r
     *NumberOfPages = Image->NumberOfPages;\r
-  }  \r
+  }\r
 \r
   //\r
   // Register the image in the Debug Image Info Table if the attribute is set\r
@@ -825,26 +826,26 @@ Done:
 /**\r
   Loads an EFI image into memory and returns a handle to the image.\r
 \r
-  @param  BootPolicy              If TRUE, indicates that the request originates \r
-                                  from the boot manager, and that the boot \r
-                                  manager is attempting to load FilePath as a \r
-                                  boot selection. \r
-  @param  ParentImageHandle       The caller's image handle. \r
-  @param  FilePath                The specific file path from which the image is \r
-                                  loaded. \r
-  @param  SourceBuffer            If not NULL, a pointer to the memory location \r
-                                  containing a copy of the image to be loaded. \r
-  @param  SourceSize              The size in bytes of SourceBuffer. \r
-  @param  ImageHandle             Pointer to the returned image handle that is \r
-                                  created when the image is successfully loaded. \r
-\r
-  @retval EFI_SUCCESS             The image was loaded into memory. \r
-  @retval EFI_NOT_FOUND           The FilePath was not found. \r
-  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value. \r
-  @retval EFI_UNSUPPORTED         The image type is not supported, or the device \r
-                                  path cannot be parsed to locate the proper \r
-                                  protocol for loading the file. \r
-  @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient \r
+  @param  BootPolicy              If TRUE, indicates that the request originates\r
+                                  from the boot manager, and that the boot\r
+                                  manager is attempting to load FilePath as a\r
+                                  boot selection.\r
+  @param  ParentImageHandle       The caller's image handle.\r
+  @param  FilePath                The specific file path from which the image is\r
+                                  loaded.\r
+  @param  SourceBuffer            If not NULL, a pointer to the memory location\r
+                                  containing a copy of the image to be loaded.\r
+  @param  SourceSize              The size in bytes of SourceBuffer.\r
+  @param  ImageHandle             Pointer to the returned image handle that is\r
+                                  created when the image is successfully loaded.\r
+\r
+  @retval EFI_SUCCESS             The image was loaded into memory.\r
+  @retval EFI_NOT_FOUND           The FilePath was not found.\r
+  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value.\r
+  @retval EFI_UNSUPPORTED         The image type is not supported, or the device\r
+                                  path cannot be parsed to locate the proper\r
+                                  protocol for loading the file.\r
+  @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient\r
                                   resources.\r
 \r
 **/\r
@@ -886,29 +887,29 @@ CoreLoadImage (
 /**\r
   Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
 \r
-  @param  This                    Calling context \r
-  @param  ParentImageHandle       The caller's image handle. \r
-  @param  FilePath                The specific file path from which the image is \r
-                                  loaded. \r
-  @param  SourceBuffer            If not NULL, a pointer to the memory location \r
-                                  containing a copy of the image to be loaded. \r
-  @param  SourceSize              The size in bytes of SourceBuffer. \r
-  @param  DstBuffer               The buffer to store the image. \r
-  @param  NumberOfPages           For input, specifies the space size of the \r
-                                  image by caller if not NULL. For output, \r
-                                  specifies the actual space size needed. \r
-  @param  ImageHandle             Image handle for output. \r
-  @param  EntryPoint              Image entry point for output. \r
-  @param  Attribute               The bit mask of attributes to set for the load \r
-                                  PE image. \r
-\r
-  @retval EFI_SUCCESS             The image was loaded into memory. \r
-  @retval EFI_NOT_FOUND           The FilePath was not found. \r
-  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value. \r
-  @retval EFI_UNSUPPORTED         The image type is not supported, or the device \r
-                                  path cannot be parsed to locate the proper \r
-                                  protocol for loading the file. \r
-  @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient \r
+  @param  This                    Calling context\r
+  @param  ParentImageHandle       The caller's image handle.\r
+  @param  FilePath                The specific file path from which the image is\r
+                                  loaded.\r
+  @param  SourceBuffer            If not NULL, a pointer to the memory location\r
+                                  containing a copy of the image to be loaded.\r
+  @param  SourceSize              The size in bytes of SourceBuffer.\r
+  @param  DstBuffer               The buffer to store the image.\r
+  @param  NumberOfPages           For input, specifies the space size of the\r
+                                  image by caller if not NULL. For output,\r
+                                  specifies the actual space size needed.\r
+  @param  ImageHandle             Image handle for output.\r
+  @param  EntryPoint              Image entry point for output.\r
+  @param  Attribute               The bit mask of attributes to set for the load\r
+                                  PE image.\r
+\r
+  @retval EFI_SUCCESS             The image was loaded into memory.\r
+  @retval EFI_NOT_FOUND           The FilePath was not found.\r
+  @retval EFI_INVALID_PARAMETER   One of the parameters has an invalid value.\r
+  @retval EFI_UNSUPPORTED         The image type is not supported, or the device\r
+                                  path cannot be parsed to locate the proper\r
+                                  protocol for loading the file.\r
+  @retval EFI_OUT_OF_RESOURCES    Image was not loaded due to insufficient\r
                                   resources.\r
 \r
 **/\r
@@ -945,18 +946,18 @@ CoreLoadImageEx (
 /**\r
   Transfer control to a loaded image's entry point.\r
 \r
-  @param  ImageHandle             Handle of image to be started. \r
-  @param  ExitDataSize            Pointer of the size to ExitData \r
-  @param  ExitData                Pointer to a pointer to a data buffer that \r
-                                  includes a Null-terminated Unicode string, \r
-                                  optionally followed by additional binary data. \r
-                                  The string is a description that the caller may \r
-                                  use to further indicate the reason for the \r
-                                  image's exit. \r
-\r
-  @retval EFI_INVALID_PARAMETER   Invalid parameter \r
-  @retval EFI_OUT_OF_RESOURCES    No enough buffer to allocate \r
-  @retval EFI_SUCCESS             Successfully transfer control to the image's \r
+  @param  ImageHandle             Handle of image to be started.\r
+  @param  ExitDataSize            Pointer of the size to ExitData\r
+  @param  ExitData                Pointer to a pointer to a data buffer that\r
+                                  includes a Null-terminated Unicode string,\r
+                                  optionally followed by additional binary data.\r
+                                  The string is a description that the caller may\r
+                                  use to further indicate the reason for the\r
+                                  image's exit.\r
+\r
+  @retval EFI_INVALID_PARAMETER   Invalid parameter\r
+  @retval EFI_OUT_OF_RESOURCES    No enough buffer to allocate\r
+  @retval EFI_SUCCESS             Successfully transfer control to the image's\r
                                   entry point.\r
 \r
 **/\r
@@ -1112,7 +1113,7 @@ CoreStartImage (
 /**\r
   Unloads EFI image from memory.\r
 \r
-  @param  Image                   EFI image \r
+  @param  Image                   EFI image\r
   @param  FreePage                Free allocated pages\r
 \r
 **/\r
@@ -1255,23 +1256,23 @@ CoreUnloadAndCloseImage (
 /**\r
   Terminates the currently loaded EFI image and returns control to boot services.\r
 \r
-  @param  ImageHandle             Handle that identifies the image. This \r
-                                  parameter is passed to the image on entry. \r
-  @param  Status                  The image's exit code. \r
-  @param  ExitDataSize            The size, in bytes, of ExitData. Ignored if \r
-                                  ExitStatus is EFI_SUCCESS. \r
-  @param  ExitData                Pointer to a data buffer that includes a \r
-                                  Null-terminated Unicode string, optionally \r
-                                  followed by additional binary data. The string \r
-                                  is a description that the caller may use to \r
-                                  further indicate the reason for the image's \r
-                                  exit. \r
-\r
-  @retval EFI_INVALID_PARAMETER   Image handle is NULL or it is not current \r
-                                  image. \r
-  @retval EFI_SUCCESS             Successfully terminates the currently loaded \r
-                                  EFI image. \r
-  @retval EFI_ACCESS_DENIED       Should never reach there. \r
+  @param  ImageHandle             Handle that identifies the image. This\r
+                                  parameter is passed to the image on entry.\r
+  @param  Status                  The image's exit code.\r
+  @param  ExitDataSize            The size, in bytes, of ExitData. Ignored if\r
+                                  ExitStatus is EFI_SUCCESS.\r
+  @param  ExitData                Pointer to a data buffer that includes a\r
+                                  Null-terminated Unicode string, optionally\r
+                                  followed by additional binary data. The string\r
+                                  is a description that the caller may use to\r
+                                  further indicate the reason for the image's\r
+                                  exit.\r
+\r
+  @retval EFI_INVALID_PARAMETER   Image handle is NULL or it is not current\r
+                                  image.\r
+  @retval EFI_SUCCESS             Successfully terminates the currently loaded\r
+                                  EFI image.\r
+  @retval EFI_ACCESS_DENIED       Should never reach there.\r
   @retval EFI_OUT_OF_RESOURCES    Could not allocate pool\r
 \r
 **/\r
@@ -1290,9 +1291,9 @@ CoreExit (
   //\r
   // Prevent possible reentrance to this function\r
   // for the same ImageHandle\r
-  // \r
-  OldTpl = CoreRaiseTpl (TPL_NOTIFY); \r
\r
+  //\r
+  OldTpl = CoreRaiseTpl (TPL_NOTIFY);\r
+\r
   Image = CoreLoadedImageInfo (ImageHandle);\r
   if (Image == NULL_HANDLE) {\r
     Status = EFI_INVALID_PARAMETER;\r
@@ -1357,12 +1358,12 @@ Done:
 /**\r
   Unloads an image.\r
 \r
-  @param  ImageHandle             Handle that identifies the image to be \r
-                                  unloaded. \r
+  @param  ImageHandle             Handle that identifies the image to be\r
+                                  unloaded.\r
 \r
-  @retval EFI_SUCCESS             The image has been unloaded. \r
-  @retval EFI_UNSUPPORTED         The image has been sarted, and does not support \r
-                                  unload. \r
+  @retval EFI_SUCCESS             The image has been unloaded.\r
+  @retval EFI_UNSUPPORTED         The image has been sarted, and does not support\r
+                                  unload.\r
   @retval EFI_INVALID_PARAMPETER  ImageHandle is not a valid image handle.\r
 \r
 **/\r
@@ -1379,9 +1380,9 @@ CoreUnloadImage (
   //\r
   // Prevent possible reentrance to this function\r
   // for the same ImageHandle\r
-  // \r
+  //\r
   OldTpl = CoreRaiseTpl (TPL_NOTIFY);\r
\r
+\r
   Image = CoreLoadedImageInfo (ImageHandle);\r
   if (Image == NULL ) {\r
     //\r
@@ -1425,11 +1426,11 @@ Done:
 /**\r
   Unload the specified image.\r
 \r
-  @param  This                    Indicates the calling context. \r
-  @param  ImageHandle             The specified image handle. \r
+  @param  This                    Indicates the calling context.\r
+  @param  ImageHandle             The specified image handle.\r
 \r
-  @retval EFI_INVALID_PARAMETER   Image handle is NULL. \r
-  @retval EFI_UNSUPPORTED         Attempt to unload an unsupported image. \r
+  @retval EFI_INVALID_PARAMETER   Image handle is NULL.\r
+  @retval EFI_UNSUPPORTED         Attempt to unload an unsupported image.\r
   @retval EFI_SUCCESS             Image successfully unloaded.\r
 \r
 **/\r