sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ShellPkg: stop using EFI_HANDLE in place of EFI_HII_HANDLE

Browse Source 
The UefiShell*CommandsLib instances have constructor functions that do
something like:

  gHiiHandle = HiiAddPackages (...);
  ...
  ShellCommandRegisterCommandName (..., gHiiHandle, ...);

and destructor functions that implement the following pattern:

  HiiRemovePackages (gHiiHandle);

The -- semantic, not functional -- problem is that "gHiiHandle" is
declared with type EFI_HANDLE, and not EFI_HII_HANDLE, in all of these
library instances, even though HiiAddPackages() correctly returns
EFI_HII_HANDLE, and HiiRemovePackages() takes EFI_HII_HANDLE.

Once we fix the type of "gHiiHandle", it causes sort of a butterfly
effect, because it is passed around widely. Track down and update all of
those locations.

The DynamicCommand lib instances use a similar pattern, so they are
affected too.

NOTE: in practice, this patch is a no-op, as both EFI_HII_HANDLE and
EFI_HANDLE are typedefs to (VOID*). However, we shouldn't use EFI_HANDLE
where semantically EFI_HII_HANDLE is passed around.

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>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
This commit is contained in:
Laszlo Ersek
2019-09-06 23:15:42 +02:00
parent 61d505dfc1
commit c44501b313
25 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
ShellPkg/DynamicCommand/DpDynamicCommand/Dp.c
View File

@ -36,7 +36,7 @@ typedef struct {
#pragma pack()
EFI_HANDLE mDpHiiHandle;
EFI_HII_HANDLE mDpHiiHandle;
typedef struct {
EFI_HANDLE Handle;
@ -924,14 +924,14 @@ Done:
@return HII handle.
**/
EFI_HANDLE
EFI_HII_HANDLE
InitializeHiiPackage (
EFI_HANDLE ImageHandle
)
{
EFI_STATUS Status;
EFI_HII_PACKAGE_LIST_HEADER *PackageList;
EFI_HANDLE HiiHandle;
EFI_HII_HANDLE HiiHandle;
//
// Retrieve HII package list from ImageHandle