Re: [PATCH] MdeModulePkg: Enhance the debug message for InstallProtocolInterface

["Gao, Liming" <liming.gao@intel.com>]

Reviewed-by: Liming Gao <liming.gao@intel.com>

> -----Original Message-----
> From: Zeng, Star
> Sent: Wednesday, June 21, 2017 1:35 PM
> To: edk2-devel@lists.01.org
> Cc: Zeng, Star <star.zeng@intel.com>; Gao, Liming <liming.gao@intel.com>
> Subject: [PATCH] MdeModulePkg: Enhance the debug message for InstallProtocolInterface
> 
> Current code is using debug message like below for
> InstallProtocolInterface.
> InstallProtocolInterface: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX XXX
> 
> User could not know whether the installation is failed or not by the
> debug message, for example, the code below does not initialize Handle
> before calling InstallProtocolInterface, EFI_INVALID_PARAMETER will be
> returned.
>   EFI_HANDLE Handle;
>   Status = gBS->InstallProtocolInterface (
>                   &Handle,
>                   &XXX,
>                   EFI_NATIVE_INTERFACE,
>                   XXX
>                   );
> 
> This patch is to add additional debug message if the installation
> is failed and specific debug message for the case that the input
> handle is invalid.
> 
> Cc: Liming Gao <liming.gao@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Star Zeng <star.zeng@intel.com>
> ---
>  MdeModulePkg/Core/Dxe/Hand/Handle.c  | 14 ++++++++------
>  MdeModulePkg/Core/PiSmmCore/Handle.c | 14 ++++++++------
>  2 files changed, 16 insertions(+), 12 deletions(-)
> 
> diff --git a/MdeModulePkg/Core/Dxe/Hand/Handle.c b/MdeModulePkg/Core/Dxe/Hand/Handle.c
> index 1c25521672ba..59b89148c8f0 100644
> --- a/MdeModulePkg/Core/Dxe/Hand/Handle.c
> +++ b/MdeModulePkg/Core/Dxe/Hand/Handle.c
> @@ -1,7 +1,7 @@
>  /** @file
>    UEFI handle & protocol handling.
> 
> -Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
>  This program and the accompanying materials
>  are licensed and made available under the terms and conditions of the BSD License
>  which accompanies this distribution.  The full text of the license may be found at
> @@ -428,11 +428,12 @@ CoreInstallProtocolInterfaceNotify (
>      // in the system
>      //
>      InsertTailList (&gHandleList, &Handle->AllHandles);
> -  }
> -
> -  Status = CoreValidateHandle (Handle);
> -  if (EFI_ERROR (Status)) {
> -    goto Done;
> +  } else {
> +    Status = CoreValidateHandle (Handle);
> +    if (EFI_ERROR (Status)) {
> +      DEBUG((DEBUG_ERROR, "InstallProtocolInterface: input handle at 0x%x is invalid\n", Handle));
> +      goto Done;
> +    }
>    }
> 
>    //
> @@ -491,6 +492,7 @@ Done:
>      if (Prot != NULL) {
>        CoreFreePool (Prot);
>      }
> +    DEBUG((DEBUG_ERROR, "InstallProtocolInterface: %g %p failed with %r\n", Protocol, Interface, Status));
>    }
> 
>    return Status;
> diff --git a/MdeModulePkg/Core/PiSmmCore/Handle.c b/MdeModulePkg/Core/PiSmmCore/Handle.c
> index 9cedb2aeb5ee..19faac844414 100644
> --- a/MdeModulePkg/Core/PiSmmCore/Handle.c
> +++ b/MdeModulePkg/Core/PiSmmCore/Handle.c
> @@ -1,7 +1,7 @@
>  /** @file
>    SMM handle & protocol handling.
> 
> -  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>
>    This program and the accompanying materials are licensed and made available
>    under the terms and conditions of the BSD License which accompanies this
>    distribution.  The full text of the license may be found at
> @@ -287,11 +287,12 @@ SmmInstallProtocolInterfaceNotify (
>      // in the system
>      //
>      InsertTailList (&gHandleList, &Handle->AllHandles);
> -  }
> -
> -  Status = SmmValidateHandle (Handle);
> -  if (EFI_ERROR (Status)) {
> -    goto Done;
> +  } else {
> +    Status = SmmValidateHandle (Handle);
> +    if (EFI_ERROR (Status)) {
> +      DEBUG((DEBUG_ERROR, "SmmInstallProtocolInterface: input handle at 0x%x is invalid\n", Handle));
> +      goto Done;
> +    }
>    }
> 
>    //
> @@ -340,6 +341,7 @@ Done:
>      if (Prot != NULL) {
>        FreePool (Prot);
>      }
> +    DEBUG((DEBUG_ERROR, "SmmInstallProtocolInterface: %g %p failed with %r\n", Protocol, Interface, Status));
>    }
>    return Status;
>  }
> --
> 2.7.0.windows.1