From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mx.groups.io with SMTP id smtpd.web09.4936.1634111164823985013 for ; Wed, 13 Oct 2021 00:46:05 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.100, mailfrom: hua.ma@intel.com) X-IronPort-AV: E=McAfee;i="6200,9189,10135"; a="290864729" X-IronPort-AV: E=Sophos;i="5.85,369,1624345200"; d="scan'208";a="290864729" Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Oct 2021 00:46:03 -0700 X-IronPort-AV: E=Sophos;i="5.85,369,1624345200"; d="scan'208";a="491343540" Received: from huama-mobl1.ccr.corp.intel.com ([10.239.15.137]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Oct 2021 00:46:02 -0700 From: "Ma, Hua" To: devel@edk2.groups.io Cc: Hua Ma , Jian J Wang , Liming Gao , Dandan Bi , Ray Ni Subject: [PATCH v3] MdeModulePkg/Core/Dxe: Acquire a lock when iterating gHandleList Date: Wed, 13 Oct 2021 15:45:14 +0800 Message-Id: <837b6a9e5919e51d47fabc133e4b860389e99a15.1634109861.git.hua.ma@intel.com> X-Mailer: git-send-email 2.32.0.windows.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3680 This patch fixes the following issue: The global variable gHandleList is a linked list. This list is locked when a entry is added or removed from the list, but there is no lock when iterating this list in function CoreValidateHandle(). It can lead to "Handle.c (76): CR has Bad Signature" assertion if the iterated entry in the list is just removed by other task during iterating. Currently some caller functions of CoreValidateHandle() have CoreAcquireProtocolLock(), but some caller functions of CoreValidateHandle() do not CoreAcquireProtocolLock(). Add CoreAcquireProtocolLock() always when CoreValidateHandle() is called, Also, A lock check is added in the CoreValidateHandle(). v3 changes: - keep ASSERT_LOCKED(&gProtocolDatabaseLock) in CoreValidateHandle() - Call CoreAcquireProtocolLock() before any calling of CoreValidateHandle() and CoreReleaseProtocolLock() afterwards - Update the commit message v2 changes: - Add lock check and comments in CoreGetProtocolInterface() before calling CoreValidateHandle() - Update the comments in CoreValidateHandle() header file v1: https://edk2.groups.io/g/devel/topic/86233569 Cc: Jian J Wang Cc: Liming Gao Cc: Dandan Bi Cc: Ray Ni Signed-off-by: Hua Ma --- MdeModulePkg/Core/Dxe/Hand/DriverSupport.c | 16 +++++ MdeModulePkg/Core/Dxe/Hand/Handle.c | 75 ++++++++++++---------- MdeModulePkg/Core/Dxe/Hand/Handle.h | 1 + MdeModulePkg/Core/Dxe/Hand/Notify.c | 13 ++-- 4 files changed, 64 insertions(+), 41 deletions(-) diff --git a/MdeModulePkg/Core/Dxe/Hand/DriverSupport.c b/MdeModulePkg/Core/Dxe/Hand/DriverSupport.c index feabf12faf..12a202417c 100644 --- a/MdeModulePkg/Core/Dxe/Hand/DriverSupport.c +++ b/MdeModulePkg/Core/Dxe/Hand/DriverSupport.c @@ -68,7 +68,12 @@ CoreConnectController ( // // Make sure ControllerHandle is valid // + CoreAcquireProtocolLock (); + Status = CoreValidateHandle (ControllerHandle); + + CoreReleaseProtocolLock (); + if (EFI_ERROR (Status)) { return Status; } @@ -268,7 +273,12 @@ AddSortedDriverBindingProtocol ( // // Make sure the DriverBindingHandle is valid // + CoreAcquireProtocolLock (); + Status = CoreValidateHandle (DriverBindingHandle); + + CoreReleaseProtocolLock (); + if (EFI_ERROR (Status)) { return; } @@ -746,8 +756,11 @@ CoreDisconnectController ( // // Make sure ControllerHandle is valid // + CoreAcquireProtocolLock (); + Status = CoreValidateHandle (ControllerHandle); if (EFI_ERROR (Status)) { + CoreReleaseProtocolLock (); return Status; } @@ -757,10 +770,13 @@ CoreDisconnectController ( if (ChildHandle != NULL) { Status = CoreValidateHandle (ChildHandle); if (EFI_ERROR (Status)) { + CoreReleaseProtocolLock (); return Status; } } + CoreReleaseProtocolLock (); + Handle = ControllerHandle; // diff --git a/MdeModulePkg/Core/Dxe/Hand/Handle.c b/MdeModulePkg/Core/Dxe/Hand/Handle.c index 6eccb41ecb..92979281b7 100644 --- a/MdeModulePkg/Core/Dxe/Hand/Handle.c +++ b/MdeModulePkg/Core/Dxe/Hand/Handle.c @@ -53,6 +53,7 @@ CoreReleaseProtocolLock ( /** Check whether a handle is a valid EFI_HANDLE + The gProtocolDatabaseLock must be owned @param UserHandle The handle to check @@ -72,6 +73,8 @@ CoreValidateHandle ( return EFI_INVALID_PARAMETER; } + ASSERT_LOCKED(&gProtocolDatabaseLock); + for (Link = gHandleList.BackLink; Link != &gHandleList; Link = Link->BackLink) { Handle = CR (Link, IHANDLE, AllHandles, EFI_HANDLE_SIGNATURE); if (Handle == (IHANDLE *) UserHandle) { @@ -720,19 +723,19 @@ CoreUninstallProtocolInterface ( return EFI_INVALID_PARAMETER; } + // + // Lock the protocol database + // + CoreAcquireProtocolLock (); + // // Check that UserHandle is a valid handle // Status = CoreValidateHandle (UserHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } - // - // Lock the protocol database - // - CoreAcquireProtocolLock (); - // // Check that Protocol exists on UserHandle, and Interface matches the interface in the database // @@ -1010,12 +1013,17 @@ CoreOpenProtocol ( return EFI_INVALID_PARAMETER; } + // + // Lock the protocol database + // + CoreAcquireProtocolLock (); + // // Check for invalid UserHandle // Status = CoreValidateHandle (UserHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } // @@ -1025,31 +1033,32 @@ CoreOpenProtocol ( case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER : Status = CoreValidateHandle (ImageHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } Status = CoreValidateHandle (ControllerHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } if (UserHandle == ControllerHandle) { - return EFI_INVALID_PARAMETER; + Status = EFI_INVALID_PARAMETER; + goto Done; } break; case EFI_OPEN_PROTOCOL_BY_DRIVER : case EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE : Status = CoreValidateHandle (ImageHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } Status = CoreValidateHandle (ControllerHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } break; case EFI_OPEN_PROTOCOL_EXCLUSIVE : Status = CoreValidateHandle (ImageHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } break; case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL : @@ -1057,13 +1066,10 @@ CoreOpenProtocol ( case EFI_OPEN_PROTOCOL_TEST_PROTOCOL : break; default: - return EFI_INVALID_PARAMETER; + Status = EFI_INVALID_PARAMETER; + goto Done; } - // - // Lock the protocol database - // - CoreAcquireProtocolLock (); // // Look at each protocol interface for a match @@ -1246,32 +1252,33 @@ CoreCloseProtocol ( LIST_ENTRY *Link; OPEN_PROTOCOL_DATA *OpenData; + // + // Lock the protocol database + // + CoreAcquireProtocolLock (); + // // Check for invalid parameters // Status = CoreValidateHandle (UserHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } Status = CoreValidateHandle (AgentHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } if (ControllerHandle != NULL) { Status = CoreValidateHandle (ControllerHandle); if (EFI_ERROR (Status)) { - return Status; + goto Done; } } if (Protocol == NULL) { - return EFI_INVALID_PARAMETER; + Status = EFI_INVALID_PARAMETER; + goto Done; } - // - // Lock the protocol database - // - CoreAcquireProtocolLock (); - // // Look at each protocol interface for a match // @@ -1443,13 +1450,6 @@ CoreProtocolsPerHandle ( UINTN ProtocolCount; EFI_GUID **Buffer; - Status = CoreValidateHandle (UserHandle); - if (EFI_ERROR (Status)) { - return Status; - } - - Handle = (IHANDLE *)UserHandle; - if (ProtocolBuffer == NULL) { return EFI_INVALID_PARAMETER; } @@ -1464,6 +1464,13 @@ CoreProtocolsPerHandle ( CoreAcquireProtocolLock (); + Status = CoreValidateHandle (UserHandle); + if (EFI_ERROR (Status)) { + goto Done; + } + + Handle = (IHANDLE *)UserHandle; + for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) { ProtocolCount++; } diff --git a/MdeModulePkg/Core/Dxe/Hand/Handle.h b/MdeModulePkg/Core/Dxe/Hand/Handle.h index 83eb2b9f3a..3f83e3af15 100644 --- a/MdeModulePkg/Core/Dxe/Hand/Handle.h +++ b/MdeModulePkg/Core/Dxe/Hand/Handle.h @@ -242,6 +242,7 @@ CoreReleaseProtocolLock ( /** Check whether a handle is a valid EFI_HANDLE + The gProtocolDatabaseLock must be owned @param UserHandle The handle to check diff --git a/MdeModulePkg/Core/Dxe/Hand/Notify.c b/MdeModulePkg/Core/Dxe/Hand/Notify.c index 553413a350..d05f95207f 100644 --- a/MdeModulePkg/Core/Dxe/Hand/Notify.c +++ b/MdeModulePkg/Core/Dxe/Hand/Notify.c @@ -188,22 +188,21 @@ CoreReinstallProtocolInterface ( PROTOCOL_INTERFACE *Prot; PROTOCOL_ENTRY *ProtEntry; - Status = CoreValidateHandle (UserHandle); - if (EFI_ERROR (Status)) { - return Status; - } - if (Protocol == NULL) { return EFI_INVALID_PARAMETER; } - Handle = (IHANDLE *) UserHandle; - // // Lock the protocol database // CoreAcquireProtocolLock (); + Status = CoreValidateHandle (UserHandle); + if (EFI_ERROR (Status)) { + goto Done; + } + + Handle = (IHANDLE *) UserHandle; // // Check that Protocol exists on UserHandle, and Interface matches the interface in the database // -- 2.32.0.windows.2