Re: [PATCH] ShellPkg: Increase PcdShellPrintBufferSize from UINT16 to UINT32

["Gao, Zhichao" <zhichao.gao@intel.com>]

Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>

Thanks,
Zhichao

> -----Original Message-----
> From: Giri Mudusuru <girim@apple.com>
> Sent: Tuesday, June 6, 2023 2:02 PM
> To: devel@edk2.groups.io
> Cc: Giri Mudusuru <girim@apple.com>; Ni, Ray <ray.ni@intel.com>; Gao,
> Zhichao <zhichao.gao@intel.com>; Andrew Fish <afish@apple.com>
> Subject: [PATCH] ShellPkg: Increase PcdShellPrintBufferSize from UINT16 to
> UINT32
> 
> Increase max buffer size to support more than 64K.
> 
> Signed-off-by: Giri Mudusuru <girim@apple.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Zhichao Gao <zhichao.gao@intel.com>
> Cc: Andrew Fish <afish@apple.com>
> ---
>  ShellPkg/Application/Shell/Shell.c           |  5 +++--
>  ShellPkg/Library/UefiShellLib/UefiShellLib.c | 19 ++++++++++---------
>  ShellPkg/ShellPkg.dec                        |  4 ++--
>  3 files changed, 15 insertions(+), 13 deletions(-)
> 
> diff --git a/ShellPkg/Application/Shell/Shell.c
> b/ShellPkg/Application/Shell/Shell.c
> index f95c799bb2..01b4e37871 100644
> --- a/ShellPkg/Application/Shell/Shell.c
> +++ b/ShellPkg/Application/Shell/Shell.c
> @@ -4,8 +4,9 @@
>    Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>
> 
>    (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.<BR>
> 
>    Copyright 2015-2018 Dell Technologies.<BR>
> 
> -  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +  Copyright (C) 2023, Apple Inc. All rights reserved.<BR>
> 
> 
> 
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
>  **/
> 
> 
> 
>  #include "Shell.h"
> 
> @@ -2944,7 +2945,7 @@ RunScriptFileHandle (
>    ASSERT (!ShellCommandGetScriptExit ());
> 
> 
> 
>    PreScriptEchoState = ShellCommandGetEchoState ();
> 
> -  PrintBuffSize      = PcdGet16 (PcdShellPrintBufferSize);
> 
> +  PrintBuffSize      = PcdGet32 (PcdShellPrintBufferSize);
> 
> 
> 
>    NewScriptFile = (SCRIPT_FILE *)AllocateZeroPool (sizeof (SCRIPT_FILE));
> 
>    if (NewScriptFile == NULL) {
> 
> diff --git a/ShellPkg/Library/UefiShellLib/UefiShellLib.c
> b/ShellPkg/Library/UefiShellLib/UefiShellLib.c
> index a72767bd86..746c9ccece 100644
> --- a/ShellPkg/Library/UefiShellLib/UefiShellLib.c
> +++ b/ShellPkg/Library/UefiShellLib/UefiShellLib.c
> @@ -4,8 +4,9 @@
>    (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
> 
>    Copyright 2016-2018 Dell Technologies.<BR>
> 
>    Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
> 
> -  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +  Copyright (C) 2023, Apple Inc. All rights reserved.<BR>
> 
> 
> 
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
>  **/
> 
> 
> 
>  #include "UefiShellLib.h"
> 
> @@ -2952,8 +2953,8 @@ InternalShellPrintWorker (
>    CHAR16      *mPostReplaceFormat;
> 
>    CHAR16      *mPostReplaceFormat2;
> 
> 
> 
> -  mPostReplaceFormat  = AllocateZeroPool (PcdGet16
> (PcdShellPrintBufferSize));
> 
> -  mPostReplaceFormat2 = AllocateZeroPool (PcdGet16
> (PcdShellPrintBufferSize));
> 
> +  mPostReplaceFormat  = AllocateZeroPool (PcdGet32
> (PcdShellPrintBufferSize));
> 
> +  mPostReplaceFormat2 = AllocateZeroPool (PcdGet32
> (PcdShellPrintBufferSize));
> 
> 
> 
>    if ((mPostReplaceFormat == NULL) || (mPostReplaceFormat2 == NULL)) {
> 
>      SHELL_FREE_NON_NULL (mPostReplaceFormat);
> 
> @@ -2967,21 +2968,21 @@ InternalShellPrintWorker (
>    //
> 
>    // Back and forth each time fixing up 1 of our flags...
> 
>    //
> 
> -  Status = ShellCopySearchAndReplace (Format, mPostReplaceFormat,
> PcdGet16 (PcdShellPrintBufferSize), L"%N", L"%%N", FALSE, FALSE);
> 
> +  Status = ShellCopySearchAndReplace (Format, mPostReplaceFormat,
> PcdGet32 (PcdShellPrintBufferSize), L"%N", L"%%N", FALSE, FALSE);
> 
>    ASSERT_EFI_ERROR (Status);
> 
> -  Status = ShellCopySearchAndReplace (mPostReplaceFormat,
> mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%E", L"%%E",
> FALSE, FALSE);
> 
> +  Status = ShellCopySearchAndReplace (mPostReplaceFormat,
> mPostReplaceFormat2, PcdGet32 (PcdShellPrintBufferSize), L"%E", L"%%E",
> FALSE, FALSE);
> 
>    ASSERT_EFI_ERROR (Status);
> 
> -  Status = ShellCopySearchAndReplace (mPostReplaceFormat2,
> mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%H", L"%%H",
> FALSE, FALSE);
> 
> +  Status = ShellCopySearchAndReplace (mPostReplaceFormat2,
> mPostReplaceFormat, PcdGet32 (PcdShellPrintBufferSize), L"%H", L"%%H",
> FALSE, FALSE);
> 
>    ASSERT_EFI_ERROR (Status);
> 
> -  Status = ShellCopySearchAndReplace (mPostReplaceFormat,
> mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%B", L"%%B",
> FALSE, FALSE);
> 
> +  Status = ShellCopySearchAndReplace (mPostReplaceFormat,
> mPostReplaceFormat2, PcdGet32 (PcdShellPrintBufferSize), L"%B", L"%%B",
> FALSE, FALSE);
> 
>    ASSERT_EFI_ERROR (Status);
> 
> -  Status = ShellCopySearchAndReplace (mPostReplaceFormat2,
> mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%V", L"%%V",
> FALSE, FALSE);
> 
> +  Status = ShellCopySearchAndReplace (mPostReplaceFormat2,
> mPostReplaceFormat, PcdGet32 (PcdShellPrintBufferSize), L"%V", L"%%V",
> FALSE, FALSE);
> 
>    ASSERT_EFI_ERROR (Status);
> 
> 
> 
>    //
> 
>    // Use the last buffer from replacing to print from...
> 
>    //
> 
> -  UnicodeVSPrint (mPostReplaceFormat2, PcdGet16
> (PcdShellPrintBufferSize), mPostReplaceFormat, Marker);
> 
> +  UnicodeVSPrint (mPostReplaceFormat2, PcdGet32
> (PcdShellPrintBufferSize), mPostReplaceFormat, Marker);
> 
> 
> 
>    if ((Col != -1) && (Row != -1)) {
> 
>      Status = gST->ConOut->SetCursorPosition (gST->ConOut, Col, Row);
> 
> diff --git a/ShellPkg/ShellPkg.dec b/ShellPkg/ShellPkg.dec
> index 2ebea0a261..18df262106 100644
> --- a/ShellPkg/ShellPkg.dec
> +++ b/ShellPkg/ShellPkg.dec
> @@ -4,9 +4,9 @@
>  # (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.<BR>
> 
>  # Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
> 
>  # Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>
> 
> +# Copyright (C) 2023, Apple Inc. All rights reserved.<BR>
> 
>  #
> 
>  # SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> -#
> 
>  ##
> 
> 
> 
>  [Defines]
> 
> @@ -84,7 +84,7 @@
> 
> gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00
> 000005
> 
> 
> 
>    ## This is the max buffer for ShellLib and internal Shell printings.
> 
> -
> gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize|16000|UINT16|0x0000
> 000C
> 
> +
> gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize|16000|UINT32|0x0000
> 000C
> 
> 
> 
>    ## This flag is used to control the commands available in the shell
> 
>    gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel|3|UINT8|0x00000001
> 
> --
> 2.39.2 (Apple Git-144)