Re: [edk2-devel] [PATCH 31/35] ShellPkg/UefiShellDebug1CommandsLib: fix ShellCloseFile() call

["Philippe Mathieu-Daudé" <philmd@redhat.com>]

On 9/17/19 9:49 PM, Laszlo Ersek wrote:
> In the FileBufferSave() function, we invoke ShellCloseFile() if "Directory
> Can Not Be Saved".
> 
> The ShellCloseFile() function takes a (SHELL_FILE_HANDLE*) parameter
> called "FileHandle", and correctly passes the de-referenced (*FileHandle)
> to EFI_SHELL_CLOSE_FILE, which takes a SHELL_FILE_HANDLE.
> 
> However, FileBufferSave() passes SHELL_FILE_HANDLE to ShellCloseFile(),
> not the expected (SHELL_FILE_HANDLE*). Correct it.
> 
> This fixes an actual bug that has remained hidden for two reasons:
> 
> - pointer-to-VOID converts from/to any pointer-to-object type silently,
> - the bug is on an error path which has likely never fired in practice.
> 
> Cc: Jaben Carsey <jaben.carsey@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Zhichao Gao <zhichao.gao@intel.com>
> Signed-off-by: Laszlo Ersek <lersek@redhat.com>
> ---
> 
> Notes:
>     tested: edit (saving a file)
> 
>  ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c
> index 464f9de38e52..fd324cc4a861 100644
> --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c
> +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c
> @@ -1462,7 +1462,7 @@ FileBufferSave (
>  
>      if (Info != NULL && Info->Attribute & EFI_FILE_DIRECTORY) {
>        StatusBarSetStatusString (L"Directory Can Not Be Saved");
> -      ShellCloseFile(FileHandle);
> +      ShellCloseFile (&FileHandle);
>        FreePool(Info);
>        return EFI_LOAD_ERROR;
>      }
> 

Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>