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>
		
			
				
	
	
		
			87 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			87 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  Main file for NULL named library for network2 shell command functions.
 | 
						|
 | 
						|
  Copyright (c) 2016, Intel Corporation. All rights reserved. <BR>
 | 
						|
  SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
**/
 | 
						|
#include "UefiShellNetwork2CommandsLib.h"
 | 
						|
 | 
						|
CONST CHAR16 gShellNetwork2FileName[] = L"ShellCommands";
 | 
						|
EFI_HII_HANDLE gShellNetwork2HiiHandle = NULL;
 | 
						|
 | 
						|
/**
 | 
						|
  return the file name of the help text file if not using HII.
 | 
						|
 | 
						|
  @return The string pointer to the file name.
 | 
						|
**/
 | 
						|
CONST CHAR16*
 | 
						|
EFIAPI
 | 
						|
ShellCommandGetManFileNameNetwork2 (
 | 
						|
  VOID
 | 
						|
  )
 | 
						|
{
 | 
						|
  return (gShellNetwork2FileName);
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Constructor for the Shell Network2 Commands library.
 | 
						|
 | 
						|
  Install the handlers for Network2 UEFI Shell 2.0 profile commands.
 | 
						|
 | 
						|
  @param ImageHandle            The image handle of the process.
 | 
						|
  @param SystemTable            The EFI System Table pointer.
 | 
						|
 | 
						|
  @retval EFI_SUCCESS           The shell command handlers were installed sucessfully.
 | 
						|
  @retval EFI_UNSUPPORTED       The shell level required was not found.
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellNetwork2CommandsLibConstructor (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  )
 | 
						|
{
 | 
						|
  gShellNetwork2HiiHandle = NULL;
 | 
						|
 | 
						|
  //
 | 
						|
  // check our bit of the profiles mask
 | 
						|
  //
 | 
						|
  if ((PcdGet8(PcdShellProfileMask) & BIT4) == 0) {
 | 
						|
    return (EFI_SUCCESS);
 | 
						|
  }
 | 
						|
 | 
						|
  gShellNetwork2HiiHandle = HiiAddPackages (&gShellNetwork2HiiGuid, gImageHandle, UefiShellNetwork2CommandsLibStrings, NULL);
 | 
						|
  if (gShellNetwork2HiiHandle == NULL) {
 | 
						|
    return (EFI_DEVICE_ERROR);
 | 
						|
  }
 | 
						|
  //
 | 
						|
  // install our shell command handlers
 | 
						|
  //
 | 
						|
  ShellCommandRegisterCommandName(L"ping6",    ShellCommandRunPing6     , ShellCommandGetManFileNameNetwork2, 0, L"network2", TRUE , gShellNetwork2HiiHandle, STRING_TOKEN(STR_GET_HELP_PING6));
 | 
						|
  ShellCommandRegisterCommandName(L"ifconfig6",ShellCommandRunIfconfig6 , ShellCommandGetManFileNameNetwork2, 0, L"network2", TRUE , gShellNetwork2HiiHandle, STRING_TOKEN(STR_GET_HELP_IFCONFIG6));
 | 
						|
 | 
						|
  return EFI_SUCCESS;
 | 
						|
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Destructor for the library.  free any resources.
 | 
						|
 | 
						|
  @param ImageHandle            The image handle of the process.
 | 
						|
  @param SystemTable            The EFI System Table pointer.
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellNetwork2CommandsLibDestructor (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  )
 | 
						|
{
 | 
						|
  if (gShellNetwork2HiiHandle != NULL) {
 | 
						|
    HiiRemovePackages(gShellNetwork2HiiHandle);
 | 
						|
  }
 | 
						|
  return EFI_SUCCESS;
 | 
						|
}
 | 
						|
 |