From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=66.187.233.73; helo=mx1.redhat.com; envelope-from=lersek@redhat.com; receiver=edk2-devel@lists.01.org Received: from mx1.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) (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 EE7E521B02845 for ; Tue, 24 Jul 2018 10:20:24 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 7BAE087A74; Tue, 24 Jul 2018 17:20:23 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-120-190.rdu2.redhat.com [10.10.120.190]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6DC0B7C5E; Tue, 24 Jul 2018 17:20:21 +0000 (UTC) From: Laszlo Ersek To: edk2-devel-01 Cc: Ruiyu Ni , Eric Dong , Liming Gao , Michael D Kinney , Jiaxin Wu , Jiewen Yao , Star Zeng , Jaben Carsey , Siyuan Fu , Chao Zhang References: <20180718205043.17574-1-lersek@redhat.com> <20180718205043.17574-2-lersek@redhat.com> Message-ID: <1f678436-1c1d-1e3a-8b65-ac203761c6be@redhat.com> Date: Tue, 24 Jul 2018 19:20:20 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.7.0 MIME-Version: 1.0 In-Reply-To: <20180718205043.17574-2-lersek@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.1]); Tue, 24 Jul 2018 17:20:23 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.1]); Tue, 24 Jul 2018 17:20:23 +0000 (UTC) for IP:'10.11.54.5' DOMAIN:'int-mx05.intmail.prod.int.rdu2.redhat.com' HELO:'smtp.corp.redhat.com' FROM:'lersek@redhat.com' RCPT:'' Subject: Re: [PATCH 1/6] MdePkg/UefiLib: introduce EfiOpenFileByDevicePath() X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 24 Jul 2018 17:20:25 -0000 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit On 07/18/18 22:50, Laszlo Ersek wrote: > The EfiOpenFileByDevicePath() function centralizes functionality from > > - MdeModulePkg/Universal/Disk/RamDiskDxe > - NetworkPkg/TlsAuthConfigDxe > - SecurityPkg/VariableAuthenticated/SecureBootConfigDxe > - ShellPkg/Library/UefiShellLib > > unifying the implementation and fixing various bugs. Mike, Liming: do you have comments on this patch? Thanks! Laszlo > > Cc: Chao Zhang > Cc: Eric Dong > Cc: Jaben Carsey > Cc: Jiaxin Wu > Cc: Jiewen Yao > Cc: Liming Gao > Cc: Michael D Kinney > Cc: Roman Bacik > Cc: Ruiyu Ni > Cc: Siyuan Fu > Cc: Star Zeng > Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1008 > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Laszlo Ersek > --- > MdePkg/Library/UefiLib/UefiLib.inf | 1 + > MdePkg/Include/Library/UefiLib.h | 86 ++++++++ > MdePkg/Library/UefiLib/UefiLib.c | 226 ++++++++++++++++++++ > 3 files changed, 313 insertions(+) > > diff --git a/MdePkg/Library/UefiLib/UefiLib.inf b/MdePkg/Library/UefiLib/UefiLib.inf > index f69f0a43b576..a6c739ef3d6d 100644 > --- a/MdePkg/Library/UefiLib/UefiLib.inf > +++ b/MdePkg/Library/UefiLib/UefiLib.inf > @@ -68,6 +68,7 @@ [Protocols] > gEfiSimpleTextOutProtocolGuid ## SOMETIMES_CONSUMES > gEfiGraphicsOutputProtocolGuid ## SOMETIMES_CONSUMES > gEfiHiiFontProtocolGuid ## SOMETIMES_CONSUMES > + gEfiSimpleFileSystemProtocolGuid ## SOMETIMES_CONSUMES > gEfiUgaDrawProtocolGuid | gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## SOMETIMES_CONSUMES # Consumes if gEfiGraphicsOutputProtocolGuid uninstalled > gEfiComponentNameProtocolGuid | NOT gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable ## SOMETIMES_PRODUCES # User chooses to produce it > gEfiComponentName2ProtocolGuid | NOT gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable ## SOMETIMES_PRODUCES # User chooses to produce it > diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h > index 7c6fde620c74..2468bf2aee80 100644 > --- a/MdePkg/Include/Library/UefiLib.h > +++ b/MdePkg/Include/Library/UefiLib.h > @@ -33,6 +33,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > #include > #include > #include > +#include > +#include > > #include > > @@ -1520,4 +1522,88 @@ EfiLocateProtocolBuffer ( > OUT UINTN *NoProtocols, > OUT VOID ***Buffer > ); > + > +/** > + Open or create a file or directory, possibly creating the chain of > + directories leading up to the directory. > + > + EfiOpenFileByDevicePath() first locates EFI_SIMPLE_FILE_SYSTEM_PROTOCOL on > + FilePath, and opens the root directory of that filesystem with > + EFI_SIMPLE_FILE_SYSTEM_PROTOCOL.OpenVolume(). > + > + On the remaining device path, the longest initial sequence of > + FILEPATH_DEVICE_PATH nodes is node-wise traversed with > + EFI_FILE_PROTOCOL.Open(). For the pathname fragment specified by each > + traversed FILEPATH_DEVICE_PATH node, EfiOpenFileByDevicePath() first masks > + EFI_FILE_MODE_CREATE out of OpenMode, and passes 0 for Attributes. If > + EFI_FILE_PROTOCOL.Open() fails, and OpenMode includes EFI_FILE_MODE_CREATE, > + then the operation is retried with the caller's OpenMode and Attributes > + unmodified. > + > + (As a consequence, if OpenMode includes EFI_FILE_MODE_CREATE, and Attributes > + includes EFI_FILE_DIRECTORY, and each FILEPATH_DEVICE_PATH specifies a single > + pathname component, then EfiOpenFileByDevicePath() ensures that the specified > + series of subdirectories exist on return.) > + > + The EFI_FILE_PROTOCOL identified by the last FILEPATH_DEVICE_PATH node is > + output to the caller; intermediate EFI_FILE_PROTOCOL instances are closed. If > + there are no FILEPATH_DEVICE_PATH nodes past the node that identifies the > + filesystem, then the EFI_FILE_PROTOCOL of the root directory of the > + filesystem is output to the caller. If a device path node that is different > + from FILEPATH_DEVICE_PATH is encountered relative to the filesystem, the > + traversal is stopped with an error, and a NULL EFI_FILE_PROTOCOL is output. > + > + @param[in,out] FilePath On input, the device path to the file or directory > + to open or create. On output, FilePath points one > + past the last node in the original device path that > + has been successfully processed. FilePath is set on > + output even if EfiOpenFileByDevicePath() returns an > + error. > + > + @param[out] File On error, File is set to NULL. On success, File is > + set to the EFI_FILE_PROTOCOL of the root directory > + of the filesystem, if there are no > + FILEPATH_DEVICE_PATH nodes in FilePath; otherwise, > + File is set to the EFI_FILE_PROTOCOL identified by > + the last node in FilePath. > + > + @param[in] OpenMode The OpenMode parameter to pass to > + EFI_FILE_PROTOCOL.Open(). For each > + FILEPATH_DEVICE_PATH node in FilePath, > + EfiOpenFileByDevicePath() first opens the specified > + pathname fragment with EFI_FILE_MODE_CREATE masked > + out of OpenMode and with Attributes set to 0, and > + only retries the operation with EFI_FILE_MODE_CREATE > + unmasked and Attributes propagated if the first open > + attempt fails. > + > + @param[in] Attributes The Attributes parameter to pass to > + EFI_FILE_PROTOCOL.Open(), when EFI_FILE_MODE_CREATE > + is propagated unmasked in OpenMode. > + > + @retval EFI_SUCCESS The file or directory has been opened or > + created. > + > + @retval EFI_INVALID_PARAMETER FilePath is NULL; or File is NULL; or FilePath > + contains a device path node, past the node > + that identifies > + EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, that is not a > + FILEPATH_DEVICE_PATH node. > + > + @retval EFI_OUT_OF_RESOURCES Memory allocation failed. > + > + @return Error codes propagated from the > + LocateDevicePath() and OpenProtocol() boot > + services, and from the > + EFI_SIMPLE_FILE_SYSTEM_PROTOCOL.OpenVolume() > + and EFI_FILE_PROTOCOL.Open() member functions. > +**/ > +EFI_STATUS > +EFIAPI > +EfiOpenFileByDevicePath ( > + IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath, > + OUT EFI_FILE_PROTOCOL **File, > + IN UINT64 OpenMode, > + IN UINT64 Attributes > + ); > #endif > diff --git a/MdePkg/Library/UefiLib/UefiLib.c b/MdePkg/Library/UefiLib/UefiLib.c > index 828a54ce7a97..d3e290178cd9 100644 > --- a/MdePkg/Library/UefiLib/UefiLib.c > +++ b/MdePkg/Library/UefiLib/UefiLib.c > @@ -1719,3 +1719,229 @@ EfiLocateProtocolBuffer ( > > return EFI_SUCCESS; > } > + > +/** > + Open or create a file or directory, possibly creating the chain of > + directories leading up to the directory. > + > + EfiOpenFileByDevicePath() first locates EFI_SIMPLE_FILE_SYSTEM_PROTOCOL on > + FilePath, and opens the root directory of that filesystem with > + EFI_SIMPLE_FILE_SYSTEM_PROTOCOL.OpenVolume(). > + > + On the remaining device path, the longest initial sequence of > + FILEPATH_DEVICE_PATH nodes is node-wise traversed with > + EFI_FILE_PROTOCOL.Open(). For the pathname fragment specified by each > + traversed FILEPATH_DEVICE_PATH node, EfiOpenFileByDevicePath() first masks > + EFI_FILE_MODE_CREATE out of OpenMode, and passes 0 for Attributes. If > + EFI_FILE_PROTOCOL.Open() fails, and OpenMode includes EFI_FILE_MODE_CREATE, > + then the operation is retried with the caller's OpenMode and Attributes > + unmodified. > + > + (As a consequence, if OpenMode includes EFI_FILE_MODE_CREATE, and Attributes > + includes EFI_FILE_DIRECTORY, and each FILEPATH_DEVICE_PATH specifies a single > + pathname component, then EfiOpenFileByDevicePath() ensures that the specified > + series of subdirectories exist on return.) > + > + The EFI_FILE_PROTOCOL identified by the last FILEPATH_DEVICE_PATH node is > + output to the caller; intermediate EFI_FILE_PROTOCOL instances are closed. If > + there are no FILEPATH_DEVICE_PATH nodes past the node that identifies the > + filesystem, then the EFI_FILE_PROTOCOL of the root directory of the > + filesystem is output to the caller. If a device path node that is different > + from FILEPATH_DEVICE_PATH is encountered relative to the filesystem, the > + traversal is stopped with an error, and a NULL EFI_FILE_PROTOCOL is output. > + > + @param[in,out] FilePath On input, the device path to the file or directory > + to open or create. On output, FilePath points one > + past the last node in the original device path that > + has been successfully processed. FilePath is set on > + output even if EfiOpenFileByDevicePath() returns an > + error. > + > + @param[out] File On error, File is set to NULL. On success, File is > + set to the EFI_FILE_PROTOCOL of the root directory > + of the filesystem, if there are no > + FILEPATH_DEVICE_PATH nodes in FilePath; otherwise, > + File is set to the EFI_FILE_PROTOCOL identified by > + the last node in FilePath. > + > + @param[in] OpenMode The OpenMode parameter to pass to > + EFI_FILE_PROTOCOL.Open(). For each > + FILEPATH_DEVICE_PATH node in FilePath, > + EfiOpenFileByDevicePath() first opens the specified > + pathname fragment with EFI_FILE_MODE_CREATE masked > + out of OpenMode and with Attributes set to 0, and > + only retries the operation with EFI_FILE_MODE_CREATE > + unmasked and Attributes propagated if the first open > + attempt fails. > + > + @param[in] Attributes The Attributes parameter to pass to > + EFI_FILE_PROTOCOL.Open(), when EFI_FILE_MODE_CREATE > + is propagated unmasked in OpenMode. > + > + @retval EFI_SUCCESS The file or directory has been opened or > + created. > + > + @retval EFI_INVALID_PARAMETER FilePath is NULL; or File is NULL; or FilePath > + contains a device path node, past the node > + that identifies > + EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, that is not a > + FILEPATH_DEVICE_PATH node. > + > + @retval EFI_OUT_OF_RESOURCES Memory allocation failed. > + > + @return Error codes propagated from the > + LocateDevicePath() and OpenProtocol() boot > + services, and from the > + EFI_SIMPLE_FILE_SYSTEM_PROTOCOL.OpenVolume() > + and EFI_FILE_PROTOCOL.Open() member functions. > +**/ > +EFI_STATUS > +EFIAPI > +EfiOpenFileByDevicePath ( > + IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath, > + OUT EFI_FILE_PROTOCOL **File, > + IN UINT64 OpenMode, > + IN UINT64 Attributes > + ) > +{ > + EFI_STATUS Status; > + EFI_HANDLE FileSystemHandle; > + EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *FileSystem; > + EFI_FILE_PROTOCOL *LastFile; > + > + if (File == NULL) { > + return EFI_INVALID_PARAMETER; > + } > + *File = NULL; > + > + if (FilePath == NULL) { > + return EFI_INVALID_PARAMETER; > + } > + > + // > + // Look up the filesystem. > + // > + Status = gBS->LocateDevicePath ( > + &gEfiSimpleFileSystemProtocolGuid, > + FilePath, > + &FileSystemHandle > + ); > + if (EFI_ERROR (Status)) { > + return Status; > + } > + Status = gBS->OpenProtocol ( > + FileSystemHandle, > + &gEfiSimpleFileSystemProtocolGuid, > + (VOID **)&FileSystem, > + gImageHandle, > + NULL, > + EFI_OPEN_PROTOCOL_GET_PROTOCOL > + ); > + if (EFI_ERROR (Status)) { > + return Status; > + } > + > + // > + // Open the root directory of the filesystem. After this operation succeeds, > + // we have to release LastFile on error. > + // > + Status = FileSystem->OpenVolume (FileSystem, &LastFile); > + if (EFI_ERROR (Status)) { > + return Status; > + } > + > + // > + // Traverse the device path nodes relative to the filesystem. > + // > + while (!IsDevicePathEnd (*FilePath)) { > + // > + // Keep local variables that relate to the current device path node tightly > + // scoped. > + // > + FILEPATH_DEVICE_PATH *FilePathNode; > + CHAR16 *AlignedPathName; > + CHAR16 *PathName; > + EFI_FILE_PROTOCOL *NextFile; > + > + if (DevicePathType (*FilePath) != MEDIA_DEVICE_PATH || > + DevicePathSubType (*FilePath) != MEDIA_FILEPATH_DP) { > + Status = EFI_INVALID_PARAMETER; > + goto CloseLastFile; > + } > + FilePathNode = (FILEPATH_DEVICE_PATH *)*FilePath; > + > + // > + // FilePathNode->PathName may be unaligned, and the UEFI specification > + // requires pointers that are passed to protocol member functions to be > + // aligned. Create an aligned copy of the pathname if necessary. > + // > + if ((UINTN)FilePathNode->PathName % sizeof *FilePathNode->PathName == 0) { > + AlignedPathName = NULL; > + PathName = FilePathNode->PathName; > + } else { > + AlignedPathName = AllocateCopyPool ( > + (DevicePathNodeLength (FilePathNode) - > + SIZE_OF_FILEPATH_DEVICE_PATH), > + FilePathNode->PathName > + ); > + if (AlignedPathName == NULL) { > + Status = EFI_OUT_OF_RESOURCES; > + goto CloseLastFile; > + } > + PathName = AlignedPathName; > + } > + > + // > + // Open the next pathname fragment with EFI_FILE_MODE_CREATE masked out and > + // with Attributes set to 0. > + // > + Status = LastFile->Open ( > + LastFile, > + &NextFile, > + PathName, > + OpenMode & ~(UINT64)EFI_FILE_MODE_CREATE, > + 0 > + ); > + > + // > + // Retry with EFI_FILE_MODE_CREATE and the original Attributes if the first > + // attempt failed, and the caller specified EFI_FILE_MODE_CREATE. > + // > + if (EFI_ERROR (Status) && (OpenMode & EFI_FILE_MODE_CREATE) != 0) { > + Status = LastFile->Open ( > + LastFile, > + &NextFile, > + PathName, > + OpenMode, > + Attributes > + ); > + } > + > + // > + // Release any AlignedPathName on both error and success paths; PathName is > + // no longer needed. > + // > + if (AlignedPathName != NULL) { > + FreePool (AlignedPathName); > + } > + if (EFI_ERROR (Status)) { > + goto CloseLastFile; > + } > + > + // > + // Advance to the next device path node. > + // > + LastFile->Close (LastFile); > + LastFile = NextFile; > + *FilePath = NextDevicePathNode (FilePathNode); > + } > + > + *File = LastFile; > + return EFI_SUCCESS; > + > +CloseLastFile: > + LastFile->Close (LastFile); > + > + ASSERT (EFI_ERROR (Status)); > + return Status; > +} >