From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.93; helo=mga11.intel.com; envelope-from=ruiyu.ni@intel.com; receiver=edk2-devel@lists.01.org Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) (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 4E151203B8CCD for ; Tue, 22 May 2018 22:33:43 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 22 May 2018 22:33:42 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.49,432,1520924400"; d="scan'208";a="44027660" Received: from ray-dev.ccr.corp.intel.com ([10.239.9.4]) by orsmga006.jf.intel.com with ESMTP; 22 May 2018 22:33:41 -0700 From: Ruiyu Ni To: edk2-devel@lists.01.org Cc: Liming Gao , Michael D Kinney Date: Wed, 23 May 2018 13:33:48 +0800 Message-Id: <20180523053348.175228-1-ruiyu.ni@intel.com> X-Mailer: git-send-email 2.16.1.windows.1 Subject: [PATCH] MdePkg/BaseLib: Add GenerateGuid() to BaseLib X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 23 May 2018 05:33:43 -0000 Per RFC4122, there are five versions of UUID (GUID). The version 4 only depends on truly random or pseudo-random number generation. So GenerateGuid () can be added to BaseLib. It uses the GetRandomNumber128() services exposed from MdePkg/RngLib. This API can be used by some EFI utilities which needs the guidgen services, e.g.: utility that partitions the disk in GPT format needs to fill the generated GUID in partition table. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ruiyu Ni Cc: Liming Gao Cc: Michael D Kinney --- MdePkg/Include/Library/BaseLib.h | 18 ++++++++- MdePkg/Library/BaseLib/BaseLibInternals.h | 3 +- MdePkg/Library/BaseLib/GenerateGuid.c | 64 +++++++++++++++++++++++++++++++ 3 files changed, 83 insertions(+), 2 deletions(-) create mode 100644 MdePkg/Library/BaseLib/GenerateGuid.c diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index eb2899f852..272596d64c 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -2,7 +2,7 @@ Provides string functions, linked list functions, math functions, synchronization functions, file path functions, and CPU architecture-specific functions. -Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License @@ -5104,6 +5104,22 @@ EFIAPI CpuDeadLoop ( VOID ); + +/** + Generate a raw 128-bit (16-byte) GUID. + + If Guid is NULL, then ASSERT(). + + @param Guid Receive the 128-bit (16-byte) GUID. + + @retval TRUE The GUID is generated successfully. + @retval FALSE The GUID is not generated. +**/ +BOOLEAN +EFIAPI +GenerateGuid ( + OUT GUID *Guid + ); #if defined (MDE_CPU_IPF) diff --git a/MdePkg/Library/BaseLib/BaseLibInternals.h b/MdePkg/Library/BaseLib/BaseLibInternals.h index 9dca97a0dc..427eb44eba 100644 --- a/MdePkg/Library/BaseLib/BaseLibInternals.h +++ b/MdePkg/Library/BaseLib/BaseLibInternals.h @@ -1,7 +1,7 @@ /** @file Declaration of internal functions in BaseLib. - Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -20,6 +20,7 @@ #include #include #include +#include // // Math functions diff --git a/MdePkg/Library/BaseLib/GenerateGuid.c b/MdePkg/Library/BaseLib/GenerateGuid.c new file mode 100644 index 0000000000..b90f7c5a83 --- /dev/null +++ b/MdePkg/Library/BaseLib/GenerateGuid.c @@ -0,0 +1,64 @@ +/** @file + Generate GUID implementation. + + Copyright (c) 2018, Intel Corporation. All rights reserved.
+ This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php. + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#include "BaseLibInternals.h" + +/** + Generate a raw 128-bit (16-byte) GUID. + + If Guid is NULL, then ASSERT(). + + @param Guid Receive the generated 128-bit (16-byte) GUID. + + @retval TRUE The GUID is generated successfully. + @retval FALSE The GUID is not generated. +**/ +BOOLEAN +EFIAPI +GenerateGuid ( + OUT GUID *Guid + ) +{ + ASSERT (Guid != NULL); + + // + // A GUID is encoded as a 128-bit object as follows: + // 0 1 2 3 + // 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + // | time_low | + // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + // | time_mid | time_hi_and_version | + // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + // |clk_seq_hi_res | clk_seq_low | node (0-1) | + // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + // | node (2-5) | + // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + // The below algorithm generates version 4 GUID from truly-random or pseudo-random numbers. + // The algorithm is as follows (per RFC 4122): + // > Set all the bits to randomly (or pseudo-randomly) values. + // > Set the two most significant bits (bits 6 and 7) of clk_seq_hi_res field to zero and one, respectively. + // > Set the four most significant bits (bits 12 through 15) of time_hi_and_version field to 4 (4-bit version number). + // + if (!GetRandomNumber128 ((UINT64 *)Guid)) { + return FALSE; + } + + // + // Version 4 (Random GUID) + // + Guid->Data4[0] = BitFieldWrite8 (Guid->Data4[0], 6, 7, 0b10); + Guid->Data3 = BitFieldWrite16 (Guid->Data3, 12, 15, 4); +} + -- 2.16.1.windows.1