From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail04.groups.io (mail04.groups.io [45.79.224.9]) by spool.mail.gandi.net (Postfix) with ESMTPS id 80ACB740032 for ; Tue, 16 Apr 2024 02:41:32 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=2XGjkKkFT3O9mszk9NEfPXTn/5dW1Y36ZuYqOAdgeJg=; c=relaxed/simple; d=groups.io; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Resent-Date:Resent-From:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Transfer-Encoding; s=20240206; t=1713235291; v=1; b=jH6b8oTS4IeGSxBztAaxWcFxQ2gR4qih2Hfk8aYCQZrmVcgrAGa5xTndWqcBgTYX7ZgOpupj yo6m9qhEfICtMB2vOtK8flXfqpgELymDr/jbOdqWpqlFvZomsY2B9+4NkaLTN5F0f+N5AFryyP+ 2jqCO6zRUldpnQf/92GWGwEKoroMRgVjuH4nibI52neORTEKOJ3+vaAj8ieJv4ti8gxxqXiZfel jgrZlrRLz3lK8lRUMPSVJQ9qSHFr6zEdpVgSCjZtiq4YXyRN5y5fg5EWmXnSUopJR4xUgWlfzp0 HYLirOITYdZHMGjf1jTsueP2lV0Lpn9x4daD3nr9NvJwg== X-Received: by 127.0.0.2 with SMTP id SLJJYY7687511xirsTaDKU4B; Mon, 15 Apr 2024 19:41:31 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.16]) by mx.groups.io with SMTP id smtpd.web10.11001.1713235276662353128 for ; Mon, 15 Apr 2024 19:41:30 -0700 X-CSE-ConnectionGUID: wm1k495LSQWhIFfSCHwYRw== X-CSE-MsgGUID: IdNXmP7FQ4qt2thef/AGOg== X-IronPort-AV: E=McAfee;i="6600,9927,11045"; a="9205592" X-IronPort-AV: E=Sophos;i="6.07,204,1708416000"; d="scan'208";a="9205592" X-Received: from orviesa001.jf.intel.com ([10.64.159.141]) by fmvoesa110.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Apr 2024 19:41:30 -0700 X-CSE-ConnectionGUID: twn5hCW0TreXL/16zeVMaA== X-CSE-MsgGUID: NMDXU+74Ra+JPkdgNhw6DQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.07,204,1708416000"; d="scan'208";a="59553334" X-Received: from shwdesfp01.ccr.corp.intel.com ([10.239.158.151]) by smtpauth.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Apr 2024 19:41:28 -0700 From: "Zhiguang Liu" To: devel@edk2.groups.io Cc: Zhiguang Liu , Liming Gao , Jiaxin Wu , Ray Ni , Laszlo Ersek , Ard Biesheuvel , Sami Mujawar Subject: [edk2-devel] [PATCH v4 6/6] StandaloneMmPkg: Support to unregister MMI handler in MMI handlers Date: Tue, 16 Apr 2024 10:41:08 +0800 Message-Id: <20240416024108.1358-7-zhiguang.liu@intel.com> In-Reply-To: <20240416024108.1358-1-zhiguang.liu@intel.com> References: <20240416024108.1358-1-zhiguang.liu@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Resent-Date: Mon, 15 Apr 2024 19:41:30 -0700 Resent-From: zhiguang.liu@intel.com Reply-To: devel@edk2.groups.io,zhiguang.liu@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: A2Ctk8OP55fE1hIqCtbmSEP5x7686176AA= Content-Transfer-Encoding: 8bit X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20240206 header.b=jH6b8oTS; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=intel.com (policy=none); spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 45.79.224.9 as permitted sender) smtp.mailfrom=bounce@groups.io This patch fix a use-after-free issue where unregistering an MMI handler could lead to the deletion of the MMI_HANDLER while it is still in use by MmiManage(). The fix involves modifying MmiHandlerUnRegister() to detect whether it is being called from within the MmiManage() stack. If so, the removal of the MMI_HANDLER is deferred until MmiManage() has finished executing. Additionally, due to the possibility of recursive MmiManage() calls, the unregistration and subsequent removal of the MMI_HANDLER are ensured to occur only after the outermost MmiManage() invocation has completed. Cc: Liming Gao Cc: Jiaxin Wu Cc: Ray Ni Cc: Laszlo Ersek Cc: Ard Biesheuvel Cc: Sami Mujawar Signed-off-by: Zhiguang Liu --- StandaloneMmPkg/Core/Mmi.c | 161 +++++++++++++++++++++++++++++++------ 1 file changed, 136 insertions(+), 25 deletions(-) diff --git a/StandaloneMmPkg/Core/Mmi.c b/StandaloneMmPkg/Core/Mmi.c index 0de6fd17fc..e035245c87 100644 --- a/StandaloneMmPkg/Core/Mmi.c +++ b/StandaloneMmPkg/Core/Mmi.c @@ -34,11 +34,51 @@ typedef struct { LIST_ENTRY Link; // Link on MMI_ENTRY.MmiHandlers EFI_MM_HANDLER_ENTRY_POINT Handler; // The mm handler's entry point MMI_ENTRY *MmiEntry; + BOOLEAN ToRemove; // To remove this MMI_HANDLER later } MMI_HANDLER; +// +// mMmiManageCallingDepth is used to track the depth of recursive calls of MmiManage. +// +UINTN mMmiManageCallingDepth = 0; + LIST_ENTRY mRootMmiHandlerList = INITIALIZE_LIST_HEAD_VARIABLE (mRootMmiHandlerList); LIST_ENTRY mMmiEntryList = INITIALIZE_LIST_HEAD_VARIABLE (mMmiEntryList); +/** + Remove MmiHandler and free the memory it used. + If MmiEntry is empty, remove MmiEntry and free the memory it used. + + @param MmiHandler Points to MMI handler. + @param MmiEntry Points to MMI Entry or NULL for root MMI handlers. + + @retval TRUE MmiEntry is removed. + @retval FALSE MmiEntry is not removed. +**/ +BOOLEAN +RemoveMmiHandler ( + IN MMI_HANDLER *MmiHandler, + IN MMI_ENTRY *MmiEntry + ) +{ + ASSERT (MmiHandler->ToRemove); + RemoveEntryList (&MmiHandler->Link); + FreePool (MmiHandler); + + // + // Remove the MMI_ENTRY if all handlers have been removed. + // + if (MmiEntry != NULL) { + if (IsListEmpty (&MmiEntry->MmiHandlers)) { + RemoveEntryList (&MmiEntry->AllEntries); + FreePool (MmiEntry); + return TRUE; + } + } + + return FALSE; +} + /** Finds the MMI entry for the requested handler type. @@ -126,13 +166,16 @@ MmiManage ( { LIST_ENTRY *Link; LIST_ENTRY *Head; + LIST_ENTRY *EntryLink; MMI_ENTRY *MmiEntry; MMI_HANDLER *MmiHandler; - BOOLEAN SuccessReturn; + EFI_STATUS ReturnStatus; + BOOLEAN WillReturn; EFI_STATUS Status; - Status = EFI_NOT_FOUND; - SuccessReturn = FALSE; + mMmiManageCallingDepth++; + Status = EFI_NOT_FOUND; + ReturnStatus = Status; if (HandlerType == NULL) { // // Root MMI handler @@ -171,7 +214,16 @@ MmiManage ( // no additional handlers will be processed and EFI_INTERRUPT_PENDING will be returned. // if (HandlerType != NULL) { - return EFI_INTERRUPT_PENDING; + ReturnStatus = EFI_INTERRUPT_PENDING; + WillReturn = TRUE; + } else { + // + // If any other handler's result sets ReturnStatus as EFI_SUCCESS, the return status + // will be EFI_SUCCESS. + // + if (ReturnStatus != EFI_SUCCESS) { + ReturnStatus = Status; + } } break; @@ -183,10 +235,10 @@ MmiManage ( // additional handlers will be processed. // if (HandlerType != NULL) { - return EFI_SUCCESS; + WillReturn = TRUE; } - SuccessReturn = TRUE; + ReturnStatus = EFI_SUCCESS; break; case EFI_WARN_INTERRUPT_SOURCE_QUIESCED: @@ -194,7 +246,7 @@ MmiManage ( // If at least one of the handlers returns EFI_WARN_INTERRUPT_SOURCE_QUIESCED // then the function will return EFI_SUCCESS. // - SuccessReturn = TRUE; + ReturnStatus = EFI_SUCCESS; break; case EFI_WARN_INTERRUPT_SOURCE_PENDING: @@ -202,6 +254,10 @@ MmiManage ( // If all the handlers returned EFI_WARN_INTERRUPT_SOURCE_PENDING // then EFI_WARN_INTERRUPT_SOURCE_PENDING will be returned. // + if (ReturnStatus != EFI_SUCCESS) { + ReturnStatus = Status; + } + break; default: @@ -211,13 +267,76 @@ MmiManage ( ASSERT_EFI_ERROR (Status); break; } + + if (WillReturn) { + break; + } } - if (SuccessReturn) { - Status = EFI_SUCCESS; + ASSERT (mMmiManageCallingDepth > 0); + mMmiManageCallingDepth--; + + // + // MmiHandlerUnRegister() calls from MMI handlers are deferred till this point. + // Before returned from MmiManage, delete the MmiHandler which is + // marked as ToRemove. + // Note that MmiManage can be called recursively. + // + if (mMmiManageCallingDepth == 0) { + // + // Go through all MmiHandler in root Mmi handlers + // + for ( Link = GetFirstNode (&mRootMmiHandlerList) + ; !IsNull (&mRootMmiHandlerList, Link); + ) + { + // + // MmiHandler might be removed in below, so cache the next link in Link + // + MmiHandler = CR (Link, MMI_HANDLER, Link, MMI_HANDLER_SIGNATURE); + Link = GetNextNode (&mRootMmiHandlerList, Link); + if (MmiHandler->ToRemove) { + // + // Remove MmiHandler if the ToRemove is set. + // + RemoveMmiHandler (MmiHandler, NULL); + } + } + + // + // Go through all MmiHandler in non-root MMI handlers + // + for ( EntryLink = GetFirstNode (&mMmiEntryList) + ; !IsNull (&mMmiEntryList, EntryLink); + ) + { + // + // MmiEntry might be removed in below, so cache the next link in EntryLink + // + MmiEntry = CR (EntryLink, MMI_ENTRY, AllEntries, MMI_ENTRY_SIGNATURE); + EntryLink = GetNextNode (&mMmiEntryList, EntryLink); + for ( Link = GetFirstNode (&MmiEntry->MmiHandlers) + ; !IsNull (&MmiEntry->MmiHandlers, Link); + ) + { + // + // MmiHandler might be removed in below, so cache the next link in Link + // + MmiHandler = CR (Link, MMI_HANDLER, Link, MMI_HANDLER_SIGNATURE); + Link = GetNextNode (&MmiEntry->MmiHandlers, Link); + if (MmiHandler->ToRemove) { + // + // Remove MmiHandler if the ToRemove is set. + // + if (RemoveMmiHandler (MmiHandler, MmiEntry)) { + break; + } + } + } + } } - return Status; + return ReturnStatus; } /** @@ -254,6 +373,7 @@ MmiHandlerRegister ( MmiHandler->Signature = MMI_HANDLER_SIGNATURE; MmiHandler->Handler = Handler; + MmiHandler->ToRemove = FALSE; if (HandlerType == NULL) { // @@ -309,26 +429,17 @@ MmiHandlerUnRegister ( return EFI_INVALID_PARAMETER; } - MmiEntry = MmiHandler->MmiEntry; - - RemoveEntryList (&MmiHandler->Link); - FreePool (MmiHandler); - - if (MmiEntry == NULL) { + MmiHandler->ToRemove = TRUE; + if (mMmiManageCallingDepth > 0) { // - // This is root MMI handler + // This function is called from MmiManage() + // Do not delete or remove MmiHandler or MmiEntry now. // return EFI_SUCCESS; } - if (IsListEmpty (&MmiEntry->MmiHandlers)) { - // - // No handler registered for this interrupt now, remove the MMI_ENTRY - // - RemoveEntryList (&MmiEntry->AllEntries); - - FreePool (MmiEntry); - } + MmiEntry = MmiHandler->MmiEntry; + RemoveMmiHandler (MmiHandler, MmiEntry); return EFI_SUCCESS; } -- 2.31.1.windows.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#117823): https://edk2.groups.io/g/devel/message/117823 Mute This Topic: https://groups.io/mt/105550122/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=-=-=-=-=-=-=-=-=-=-=-