From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=209.132.183.28; helo=mx1.redhat.com; envelope-from=lersek@redhat.com; receiver=edk2-devel@lists.01.org Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 4BA5221E781EC for ; Mon, 9 Oct 2017 05:44:20 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 4654361463; Mon, 9 Oct 2017 12:47:47 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 4654361463 Authentication-Results: ext-mx10.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx10.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=lersek@redhat.com Received: from lacos-laptop-7.usersys.redhat.com (ovpn-121-84.rdu2.redhat.com [10.10.121.84]) by smtp.corp.redhat.com (Postfix) with ESMTP id 993556A778; Mon, 9 Oct 2017 12:47:45 +0000 (UTC) To: "Zeng, Star" , edk2-devel-01 Cc: "Dong, Eric" , "Yao, Jiewen" , Ladi Prosek References: <20171003212834.25740-1-lersek@redhat.com> <20171003212834.25740-3-lersek@redhat.com> <0C09AFA07DD0434D9E2A0C6AEB0483103B97F2D1@shsmsx102.ccr.corp.intel.com> From: Laszlo Ersek Message-ID: <326d53e9-e615-f7ff-c52f-a1760d9c76dc@redhat.com> Date: Mon, 9 Oct 2017 14:47:44 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.3.0 MIME-Version: 1.0 In-Reply-To: <0C09AFA07DD0434D9E2A0C6AEB0483103B97F2D1@shsmsx102.ccr.corp.intel.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.39]); Mon, 09 Oct 2017 12:47:47 +0000 (UTC) Subject: Re: [PATCH 2/6] MdeModulePkg/Variable/RuntimeDxe: move MOR func. declarations to header X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 09 Oct 2017 12:44:21 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit On 10/09/17 08:55, Zeng, Star wrote: > Minor comment: > > How about also to fix the comment for Attributes parameter of SetVariableCheckHandlerMor() like below? > > @param[in] Attributes Attributes bitmask to set for the variable. Right, I can do that. Thanks! Laszlo > -----Original Message----- > From: Laszlo Ersek [mailto:lersek@redhat.com] > Sent: Wednesday, October 4, 2017 5:29 AM > To: edk2-devel-01 > Cc: Dong, Eric ; Yao, Jiewen ; Ladi Prosek ; Zeng, Star > Subject: [PATCH 2/6] MdeModulePkg/Variable/RuntimeDxe: move MOR func. declarations to header > > The MorLockInit() and SetVariableCheckHandlerMor() functions have separate implementations for VariableRuntimeDxe (= unprivileged, unified DXE_RUNTIME driver) and VariableSmm (= privileged, DXE_SMM back-end of the split variable driver). > > Move their declarations from "Variable.c" to "PrivilegePolymorphic.h", so that the compiler enforce that the declarations and the definitions match. > (All C source files with the call sites and the function definitions already include "PrivilegePolymorphic.h" via "Variable.h".) > > At the same time: > > - replace two typos in the MorLockInit() description: > - replace "EFI_SUCEESS" with "EFI_SUCCESS", > - replace "MOR Lock Control" with "MOR Control Lock"; > > - in the SetVariableCheckHandlerMor() description: > - replace @param with @param[in], > - rewrap the comment to 80 columns. > > This change cleans up commit 2f6aa774fe38 ("MdeModulePkg: Add MorLock to variable driver.", 2016-01-19). > > Cc: Eric Dong > Cc: Jiewen Yao > Cc: Ladi Prosek > Cc: Star Zeng > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Laszlo Ersek > --- > MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h | 41 ++++++++++++++++++++ > MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c | 30 +++++++------- > MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c | 30 +++++++------- > MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c | 37 ------------------ > 4 files changed, 75 insertions(+), 63 deletions(-) > > diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h > index 0aa0d4f48f10..1118f4b52e49 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h > @@ -35,4 +35,45 @@ SecureBootHook ( > IN EFI_GUID *VendorGuid > ); > > +/** > + Initialization for MOR Control Lock. > + > + @retval EFI_SUCCESS MorLock initialization success. > + @return Others Some error occurs. > +**/ > +EFI_STATUS > +MorLockInit ( > + VOID > + ); > + > +/** > + This service is an MOR/MorLock checker handler for the SetVariable(). > + > + @param[in] VariableName the name of the vendor's variable, as a > + Null-Terminated Unicode String > + @param[in] VendorGuid Unify identifier for vendor. > + @param[in] Attributes Point to memory location to return the attributes of > + variable. If the point is NULL, the parameter would > + be ignored. > + @param[in] DataSize The size in bytes of Data-Buffer. > + @param[in] Data Point to the content of the variable. > + > + @retval EFI_SUCCESS The MOR/MorLock check pass, and Variable > + driver can store the variable data. > + @retval EFI_INVALID_PARAMETER The MOR/MorLock data or data size or > + attributes is not allowed for MOR variable. > + @retval EFI_ACCESS_DENIED The MOR/MorLock is locked. > + @retval EFI_ALREADY_STARTED The MorLock variable is handled inside this > + function. Variable driver can just return > + EFI_SUCCESS. > +**/ > +EFI_STATUS > +SetVariableCheckHandlerMor ( > + IN CHAR16 *VariableName, > + IN EFI_GUID *VendorGuid, > + IN UINT32 Attributes, > + IN UINTN DataSize, > + IN VOID *Data > + ); > + > #endif > diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c > index c32eb3b1ac4b..ab3e5d416cd4 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c > @@ -28,19 +28,23 @@ extern EDKII_VARIABLE_LOCK_PROTOCOL mVariableLock; > /** > This service is an MOR/MorLock checker handler for the SetVariable(). > > - @param VariableName the name of the vendor's variable, as a > - Null-Terminated Unicode String > - @param VendorGuid Unify identifier for vendor. > - @param Attributes Point to memory location to return the attributes of variable. If the point > - is NULL, the parameter would be ignored. > - @param DataSize The size in bytes of Data-Buffer. > - @param Data Point to the content of the variable. > + @param[in] VariableName the name of the vendor's variable, as a > + Null-Terminated Unicode String > + @param[in] VendorGuid Unify identifier for vendor. > + @param[in] Attributes Point to memory location to return the attributes of > + variable. If the point is NULL, the parameter would > + be ignored. > + @param[in] DataSize The size in bytes of Data-Buffer. > + @param[in] Data Point to the content of the variable. > > - @retval EFI_SUCCESS The MOR/MorLock check pass, and Variable driver can store the variable data. > - @retval EFI_INVALID_PARAMETER The MOR/MorLock data or data size or attributes is not allowed for MOR variable. > + @retval EFI_SUCCESS The MOR/MorLock check pass, and Variable > + driver can store the variable data. > + @retval EFI_INVALID_PARAMETER The MOR/MorLock data or data size or > + attributes is not allowed for MOR variable. > @retval EFI_ACCESS_DENIED The MOR/MorLock is locked. > - @retval EFI_ALREADY_STARTED The MorLock variable is handled inside this function. > - Variable driver can just return EFI_SUCCESS. > + @retval EFI_ALREADY_STARTED The MorLock variable is handled inside this > + function. Variable driver can just return > + EFI_SUCCESS. > **/ > EFI_STATUS > SetVariableCheckHandlerMor ( > @@ -58,9 +62,9 @@ SetVariableCheckHandlerMor ( } > > /** > - Initialization for MOR Lock Control. > + Initialization for MOR Control Lock. > > - @retval EFI_SUCEESS MorLock initialization success. > + @retval EFI_SUCCESS MorLock initialization success. > @return Others Some error occurs. > **/ > EFI_STATUS > diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c > index d06317ca9cf4..390c8fde4bd4 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c > @@ -309,19 +309,23 @@ SetVariableCheckHandlerMorLock ( > /** > This service is an MOR/MorLock checker handler for the SetVariable(). > > - @param VariableName the name of the vendor's variable, as a > - Null-Terminated Unicode String > - @param VendorGuid Unify identifier for vendor. > - @param Attributes Point to memory location to return the attributes of variable. If the point > - is NULL, the parameter would be ignored. > - @param DataSize The size in bytes of Data-Buffer. > - @param Data Point to the content of the variable. > + @param[in] VariableName the name of the vendor's variable, as a > + Null-Terminated Unicode String > + @param[in] VendorGuid Unify identifier for vendor. > + @param[in] Attributes Point to memory location to return the attributes of > + variable. If the point is NULL, the parameter would > + be ignored. > + @param[in] DataSize The size in bytes of Data-Buffer. > + @param[in] Data Point to the content of the variable. > > - @retval EFI_SUCCESS The MOR/MorLock check pass, and Variable driver can store the variable data. > - @retval EFI_INVALID_PARAMETER The MOR/MorLock data or data size or attributes is not allowed for MOR variable. > + @retval EFI_SUCCESS The MOR/MorLock check pass, and Variable > + driver can store the variable data. > + @retval EFI_INVALID_PARAMETER The MOR/MorLock data or data size or > + attributes is not allowed for MOR variable. > @retval EFI_ACCESS_DENIED The MOR/MorLock is locked. > - @retval EFI_ALREADY_STARTED The MorLock variable is handled inside this function. > - Variable driver can just return EFI_SUCCESS. > + @retval EFI_ALREADY_STARTED The MorLock variable is handled inside this > + function. Variable driver can just return > + EFI_SUCCESS. > **/ > EFI_STATUS > SetVariableCheckHandlerMor ( > @@ -377,9 +381,9 @@ SetVariableCheckHandlerMor ( } > > /** > - Initialization for MOR Lock Control. > + Initialization for MOR Control Lock. > > - @retval EFI_SUCEESS MorLock initialization success. > + @retval EFI_SUCCESS MorLock initialization success. > @return Others Some error occurs. > **/ > EFI_STATUS > diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c > index 28e4ac8f3819..d68dfbe648ce 100644 > --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c > +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c > @@ -97,43 +97,6 @@ AUTH_VAR_LIB_CONTEXT_IN mAuthContextIn = { > > AUTH_VAR_LIB_CONTEXT_OUT mAuthContextOut; > > -/** > - Initialization for MOR Lock Control. > - > - @retval EFI_SUCEESS MorLock initialization success. > - @return Others Some error occurs. > -**/ > -EFI_STATUS > -MorLockInit ( > - VOID > - ); > - > -/** > - This service is an MOR/MorLock checker handler for the SetVariable(). > - > - @param VariableName the name of the vendor's variable, as a > - Null-Terminated Unicode String > - @param VendorGuid Unify identifier for vendor. > - @param Attributes Point to memory location to return the attributes of variable. If the point > - is NULL, the parameter would be ignored. > - @param DataSize The size in bytes of Data-Buffer. > - @param Data Point to the content of the variable. > - > - @retval EFI_SUCCESS The MOR/MorLock check pass, and Variable driver can store the variable data. > - @retval EFI_INVALID_PARAMETER The MOR/MorLock data or data size or attributes is not allowed for MOR variable. > - @retval EFI_ACCESS_DENIED The MOR/MorLock is locked. > - @retval EFI_ALREADY_STARTED The MorLock variable is handled inside this function. > - Variable driver can just return EFI_SUCCESS. > -**/ > -EFI_STATUS > -SetVariableCheckHandlerMor ( > - IN CHAR16 *VariableName, > - IN EFI_GUID *VendorGuid, > - IN UINT32 Attributes, > - IN UINTN DataSize, > - IN VOID *Data > - ); > - > /** > Routine used to track statistical information about variable usage. > The data is stored in the EFI system table so it can be accessed later. > -- > 2.14.1.3.gb7cf6e02401b > >