From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by spool.mail.gandi.net (Postfix) with ESMTPS id 36DCE74004A for ; Wed, 10 Apr 2024 07:49:43 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=KmoQi6zePoHwMMHyK/yxuAHpmvXy2t3tPdBKvJhccZc=; 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=1712735381; v=1; b=tAXZIYz6yapYBBpSnIyAZILTbDelmuo53YtvPhMdqZxgrSfDLqznrct+P4FrnAlSLsbMXv+D hfveZ2aE2QhH5epLj94SxgzWCG+DTqt1hF4ClpvF/6C5Fnn5/ndRGkQdbclL4M74WLBVKbLHnkl vIdmmd12CKIx5SFAaQsgOonfETtX2sUIm7TBnYg1a0MRGhehr4ORX2bS5CDADAvLG8aMerdsrhI XdZ0tfbSnmBSv9GB2M4NdEsLE8KvGDzAepPZWC9y+4WebUHswMj5/7gHEZxx9wrkCbSvedU050Z 1GzIo90bgFMVEZIhrjitHpgMVik1CQza9aLQmv7DQncAw== X-Received: by 127.0.0.2 with SMTP id dtqLYY7687511xgooV4Uzf5d; Wed, 10 Apr 2024 00:49:41 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.19]) by mx.groups.io with SMTP id smtpd.web11.161430.1712735368660045425 for ; Wed, 10 Apr 2024 00:49:41 -0700 X-CSE-ConnectionGUID: GZxNV7OvQZa7qDRWdpvbEw== X-CSE-MsgGUID: 2GJNgzkaQFiGivLFhf4thw== X-IronPort-AV: E=McAfee;i="6600,9927,11039"; a="7955878" X-IronPort-AV: E=Sophos;i="6.07,190,1708416000"; d="scan'208";a="7955878" X-Received: from fmviesa001.fm.intel.com ([10.60.135.141]) by orvoesa111.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Apr 2024 00:49:41 -0700 X-CSE-ConnectionGUID: hqbbzJ4aTuahZ6V6b7Enrw== X-CSE-MsgGUID: QrDeYyRZTS2jK905P+ktlw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.07,190,1708416000"; d="scan'208";a="51694219" X-Received: from shwdesfp01.ccr.corp.intel.com ([10.239.158.151]) by smtpauth.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Apr 2024 00:49:39 -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 v3 6/6] StandaloneMmPkg: Support to unregister MMI handler in MMI handlers Date: Wed, 10 Apr 2024 15:49:07 +0800 Message-Id: <20240410074907.4095-7-zhiguang.liu@intel.com> In-Reply-To: <20240410074907.4095-1-zhiguang.liu@intel.com> References: <20240410074907.4095-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: Wed, 10 Apr 2024 00:49:41 -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: hrbrDOZ1D55fwkONcQxPXCKkx7686176AA= 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=tAXZIYz6; 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 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io Unregistering MMI handler will free the MMI_HANDLER. However, the MmiManage() may be using the link node from MMI_HANDLER for loop if the unregistering happens in MMI handlers. To avoid that, the idea is to inform MmiHandlerUnRegister() whether it's running or not running on the stack of MmiManage(), and to postpone MMI_HANDLER deletion until after the loop finishes. Cc: Liming Gao Cc: Jiaxin Wu Cc: Ray Ni Cc: Laszlo Ersek 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 (#117578): https://edk2.groups.io/g/devel/message/117578 Mute This Topic: https://groups.io/mt/105437960/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=-=-=-=-=-=-=-=-=-=-=-