From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.120]) by mx.groups.io with SMTP id smtpd.web09.1674.1573633627190437280 for ; Wed, 13 Nov 2019 00:27:07 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=jFRA0UD9; spf=pass (domain: redhat.com, ip: 205.139.110.120, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1573633626; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=tEuc6i/rQhcFDjwbm1TB/MCTdqmhyIx96H0z3neQLZg=; b=jFRA0UD9db4a8kVCepeXwKZxmUdm/XTHQJJ0GF1jAyX5JZZjIYwK/xz/iKsDwjzvnPOD+B cB7vbeJ2pQE8yj/0kEJABwJnI0JgIIt0cbd5l/+/f/clEniIpeLEkHKZgXN7ZsnTo7uL7e uYCIG/skL9sp1AbAbU7QDAxQufoWs/Q= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-202-Jg9pmzl6PSq1TdLjLRU9WQ-1; Wed, 13 Nov 2019 03:27:02 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 8C110802402; Wed, 13 Nov 2019 08:27:01 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-243.ams2.redhat.com [10.36.116.243]) by smtp.corp.redhat.com (Postfix) with ESMTP id E884E1D0; Wed, 13 Nov 2019 08:26:59 +0000 (UTC) Subject: Re: [PATCH v2] MdePkg: add null version of RngLib To: Jian J Wang , devel@edk2.groups.io Cc: Michael D Kinney , Liming Gao , Ard Biesheuvel , Ray Ni References: <20191113053529.7768-1-jian.j.wang@intel.com> From: "Laszlo Ersek" Message-ID: <7468e8dc-8eb6-a433-903e-23a014d2dc36@redhat.com> Date: Wed, 13 Nov 2019 09:26:59 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: <20191113053529.7768-1-jian.j.wang@intel.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-MC-Unique: Jg9pmzl6PSq1TdLjLRU9WQ-1 X-Mimecast-Spam-Score: 0 Content-Language: en-US Content-Type: text/plain; charset=WINDOWS-1252 Content-Transfer-Encoding: quoted-printable Hi Jian, thanks for the update. Comments below: On 11/13/19 06:35, Jian J Wang wrote: >> v2: >> - Change the name from RngLibNull to BaseRngLibNull according to Laszlo= 's >> comments >> - Move the module from SecurityPkg to MdePkg according to Laszlo's comm= ents >> - Update commit message according to Laszlo and Ray's comments >=20 > This is null version of RngLib which should be used with modules that > inherit an (indirect) dependency on the RngLib class, but never actually > call RngLib APIs for consuming randomness. >=20 >=20 > Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3D1871 > Cc: Michael D Kinney > Cc: Liming Gao > Cc: Laszlo Ersek > Cc: Ard Biesheuvel > Cc: Ray Ni > Signed-off-by: Jian J Wang > --- > .../Library/BaseRngLibNull/BaseRngLibNull.c | 95 +++++++++++++++++++ > .../Library/BaseRngLibNull/BaseRngLibNull.inf | 31 ++++++ > .../Library/BaseRngLibNull/BaseRngLibNull.uni | 14 +++ > MdePkg/MdePkg.dsc | 1 + > 4 files changed, 141 insertions(+) > create mode 100644 MdePkg/Library/BaseRngLibNull/BaseRngLibNull.c > create mode 100644 MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf > create mode 100644 MdePkg/Library/BaseRngLibNull/BaseRngLibNull.uni >=20 > diff --git a/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.c b/MdePkg/Libr= ary/BaseRngLibNull/BaseRngLibNull.c > new file mode 100644 > index 0000000000..13677abc84 > --- /dev/null > +++ b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.c > @@ -0,0 +1,95 @@ > +/** @file > + Null version of Random number generator services. > + > +Copyright (c) 2019, Intel Corporation. All rights reserved.
> +SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > +#include (1) I think we can drop BaseLib. > +#include > +#include > + > +/** > + Generates a 16-bit random number. > + > + if Rand is NULL, then ASSERT(). > + > + @param[out] Rand Buffer pointer to store the 16-bit random value. > + > + @retval TRUE Random number generated successfully. > + @retval FALSE Failed to generate the random number. > + > +**/ > +BOOLEAN > +EFIAPI > +GetRandomNumber16 ( > + OUT UINT16 *Rand > + ) > +{ > + ASSERT (FALSE); > + return FALSE; > +} > + > +/** > + Generates a 32-bit random number. > + > + if Rand is NULL, then ASSERT(). > + > + @param[out] Rand Buffer pointer to store the 32-bit random value. > + > + @retval TRUE Random number generated successfully. > + @retval FALSE Failed to generate the random number. > + > +**/ > +BOOLEAN > +EFIAPI > +GetRandomNumber32 ( > + OUT UINT32 *Rand > + ) > +{ > + ASSERT (FALSE); > + return FALSE; > +} > + > +/** > + Generates a 64-bit random number. > + > + if Rand is NULL, then ASSERT(). > + > + @param[out] Rand Buffer pointer to store the 64-bit random value. > + > + @retval TRUE Random number generated successfully. > + @retval FALSE Failed to generate the random number. > + > +**/ > +BOOLEAN > +EFIAPI > +GetRandomNumber64 ( > + OUT UINT64 *Rand > + ) > +{ > + ASSERT (FALSE); > + return FALSE; > +} > + > +/** > + Generates a 128-bit random number. > + > + if Rand is NULL, then ASSERT(). > + > + @param[out] Rand Buffer pointer to store the 128-bit random value. > + > + @retval TRUE Random number generated successfully. > + @retval FALSE Failed to generate the random number. > + > +**/ > +BOOLEAN > +EFIAPI > +GetRandomNumber128 ( > + OUT UINT64 *Rand > + ) > +{ > + ASSERT (FALSE); > + return FALSE; > +} > diff --git a/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf b/MdePkg/Li= brary/BaseRngLibNull/BaseRngLibNull.inf > new file mode 100644 > index 0000000000..f456df1dae > --- /dev/null > +++ b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf > @@ -0,0 +1,31 @@ > +## @file > +# Null instance of RNG (Random Number Generator) Library. > +# > +# Copyright (c) 2019, Intel Corporation. All rights reserved.
> +# > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +# > +## > + > +[Defines] > + INF_VERSION =3D 0x00010005 (2) When adding a new library instance, I seem to remember that we recommend referring to the latest published INF spec version (and using a decimal version reference). That would be "1.29" at this point. https://edk2-docs.gitbooks.io/edk-ii-inf-specification/content/#edk-ii-modu= le-information-inf-file-specification I defer to the MdePkg maintainers on this, I just wanted to raise this. > + BASE_NAME =3D BaseRngLibNull > + MODULE_UNI_FILE =3D BaseRngLibNull.uni > + FILE_GUID =3D CD8991F8-2061-4084-8C9E-9C6F352DC58= D > + MODULE_TYPE =3D BASE > + VERSION_STRING =3D 1.0 > + LIBRARY_CLASS =3D RngLib > + > +# > +# VALID_ARCHITECTURES =3D IA32 X64 ARM AARCH64 > +# (3) Again, just another idea that I'd like the MdePkg reviewers to comment on: I don't see why this library instance would not work with EBC. However, I can also imagine we should not add EBC unless we at least build-test the lib instance for EBC. What is the general approach here? (Note that I would never consider adding EBC in OvmfPkg or ArmVirtPkg INF files, simply because I don't even know what EBC compilers exist. But this is MdePkg, and a Null instance, so EBC *could* make sense.) > + > +[Sources] > + BaseRngLibNull.c > + > +[Packages] > + MdePkg/MdePkg.dec > + > +[LibraryClasses] > + BaseLib (4) Same as (1). > + DebugLib > diff --git a/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.uni b/MdePkg/Li= brary/BaseRngLibNull/BaseRngLibNull.uni > new file mode 100644 > index 0000000000..f32be6a617 > --- /dev/null > +++ b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.uni > @@ -0,0 +1,14 @@ > +// /** @file > +// Null Instance of RNG (Random Number Generator) Library. > +// > +// Copyright (c) 2019, Intel Corporation. All rights reserved.
> +// > +// SPDX-License-Identifier: BSD-2-Clause-Patent > +// > +// **/ > + > + > +#string STR_MODULE_ABSTRACT #language en-US "Null Instance o= f RNG Library" > + > +#string STR_MODULE_DESCRIPTION #language en-US "This library in= stance should be used with modules that inherit an (indirect) dependency on= the RngLib class, but never actually call RngLib APIs for consuming random= ness." > + > diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc > index c1278e7907..0aeafaaacc 100644 > --- a/MdePkg/MdePkg.dsc > +++ b/MdePkg/MdePkg.dsc > @@ -61,6 +61,7 @@ > MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib.= inf > MdePkg/Library/BaseSmbusLibNull/BaseSmbusLibNull.inf > MdePkg/Library/BaseSafeIntLib/BaseSafeIntLib.inf > + MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf OK, so this actually seems to confirm my question (3). This hunk modifies the [Components] section in the DSC file, and not the - [Components.IA32, Components.X64], - [Components.ARM, Components.AARCH64] sections. Furthermore, there is even a [Components.EBC] section in the DSC file. So I think "EBC" is still considered a viable ARCH in MdePkg, and we're actually enabling this lib instance for the EBC arch. Therefore, EBC should be listed in VALID_ARCHITECTURES, in the INF File -- as long as we care to add a VALID_ARCHITECTURES comment at all, that is. If you agree to fix (1) through (4), you can immediately add: Reviewed-by: Laszlo Ersek Thanks! Laszlo > =20 > MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.inf > MdePkg/Library/DxeCoreHobLib/DxeCoreHobLib.inf >=20