[PATCH v1 0/3] Replace VERIFY_SIZE_OF with STATIC_ASSERT

[PATCH v1 0/3] Replace VERIFY_SIZE_OF with STATIC_ASSERT

[Vitaly Cheptsov]

[-- Attachment #1: Type: text/plain, Size: 777 bytes --]

Things to note:

- This patchset should go after STATIC_ASSERT implementation:
  https://edk2.groups.io/g/devel/topic/32917749
- It is suggested that unlike the previous patch, which in my
  opinion should appear in edk2-stable201908, this patchset should
  land in edk2-stable2019011. This will let more people to comment
  whether they are ready to use it as is.

Vitaly Cheptsov (3):
  MdeModulePkg/ResetUtilityLib: Use STATIC_ASSERT macro
  MdePkg: Use STATIC_ASSERT macro
  MdePkg: Drop VERIFY_SIZE_OF in favour of STATIC_ASSERT

 MdePkg/Include/Base.h                               | 92 +++++++++-----------
 MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c |  5 +-
 2 files changed, 44 insertions(+), 53 deletions(-)

-- 
2.20.1 (Apple Git-117)


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 489 bytes --]

[PATCH v1 1/3] MdeModulePkg/ResetUtilityLib: Use STATIC_ASSERT macro

[Vitaly Cheptsov]

[-- Attachment #1: Type: text/plain, Size: 1017 bytes --]

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2048

Use new STATIC_ASSERT macro instead of VERIFY_SIZE_OF.

Signed-off-by: Vitaly Cheptsov <vit9696@protonmail.com>
---
 MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c b/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
index 2b5af4b95a..bb151d0331 100644
--- a/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
+++ b/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
@@ -20,7 +20,10 @@ typedef struct {
 } RESET_UTILITY_GUID_SPECIFIC_RESET_DATA;
 #pragma pack()
 
-VERIFY_SIZE_OF (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA, 18);
+STATIC_ASSERT (
+  sizeof (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA) == 18,
+  "sizeof (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA) is expected to be 18 bytes"
+  );
 
 /**
   This is a shorthand helper function to reset with reset type and a subtype
-- 
2.20.1 (Apple Git-117)


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 489 bytes --]

[PATCH v1 2/3] MdePkg: Use STATIC_ASSERT macro

[Vitaly Cheptsov]

[-- Attachment #1: Type: text/plain, Size: 4706 bytes --]

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2048

Use new STATIC_ASSERT macro instead of VERIFY_SIZE_OF.

Signed-off-by: Vitaly Cheptsov <vit9696@protonmail.com>
---
 MdePkg/Include/Base.h | 79 ++++++++++----------
 1 file changed, 40 insertions(+), 39 deletions(-)

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index ec096133ba..d871422cd6 100644
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -41,45 +41,6 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 **/
 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
 
-//
-// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
-// Section 2.3.1 of the UEFI 2.3 Specification.
-//
-VERIFY_SIZE_OF (BOOLEAN, 1);
-VERIFY_SIZE_OF (INT8, 1);
-VERIFY_SIZE_OF (UINT8, 1);
-VERIFY_SIZE_OF (INT16, 2);
-VERIFY_SIZE_OF (UINT16, 2);
-VERIFY_SIZE_OF (INT32, 4);
-VERIFY_SIZE_OF (UINT32, 4);
-VERIFY_SIZE_OF (INT64, 8);
-VERIFY_SIZE_OF (UINT64, 8);
-VERIFY_SIZE_OF (CHAR8, 1);
-VERIFY_SIZE_OF (CHAR16, 2);
-
-//
-// The following three enum types are used to verify that the compiler
-// configuration for enum types is compliant with Section 2.3.1 of the
-// UEFI 2.3 Specification. These enum types and enum values are not
-// intended to be used. A prefix of '__' is used avoid conflicts with
-// other types.
-//
-typedef enum {
-  __VerifyUint8EnumValue = 0xff
-} __VERIFY_UINT8_ENUM_SIZE;
-
-typedef enum {
-  __VerifyUint16EnumValue = 0xffff
-} __VERIFY_UINT16_ENUM_SIZE;
-
-typedef enum {
-  __VerifyUint32EnumValue = 0xffffffff
-} __VERIFY_UINT32_ENUM_SIZE;
-
-VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);
-VERIFY_SIZE_OF (__VERIFY_UINT16_ENUM_SIZE, 4);
-VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);
-
 //
 // The Microsoft* C compiler can removed references to unreferenced data items
 //  if the /OPT:REF linker option is used. We defined a macro as this is a
@@ -857,6 +818,46 @@ typedef UINTN  *BASE_LIST;
   #define STATIC_ASSERT _Static_assert
 #endif
 
+//
+// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
+// Section 2.3.1 of the UEFI 2.3 Specification.
+//
+
+STATIC_ASSERT (sizeof (BOOLEAN) == 1, "sizeof (BOOLEAN) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (INT8)    == 1, "sizeof (INT8) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (UINT8)   == 1, "sizeof (UINT8) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (INT16)   == 2, "sizeof (INT16) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (UINT16)  == 2, "sizeof (UINT16) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (INT32)   == 4, "sizeof (INT32) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (UINT32)  == 4, "sizeof (UINT32) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (INT64)   == 8, "sizeof (INT64) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (UINT64)  == 8, "sizeof (UINT64) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (CHAR8)   == 1, "sizeof (CHAR8) does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (CHAR16)  == 2, "sizeof (CHAR16) does not meet UEFI Specification Data Type requirements");
+
+//
+// The following three enum types are used to verify that the compiler
+// configuration for enum types is compliant with Section 2.3.1 of the
+// UEFI 2.3 Specification. These enum types and enum values are not
+// intended to be used. A prefix of '__' is used avoid conflicts with
+// other types.
+//
+typedef enum {
+  __VerifyUint8EnumValue = 0xff
+} __VERIFY_UINT8_ENUM_SIZE;
+
+typedef enum {
+  __VerifyUint16EnumValue = 0xffff
+} __VERIFY_UINT16_ENUM_SIZE;
+
+typedef enum {
+  __VerifyUint32EnumValue = 0xffffffff
+} __VERIFY_UINT32_ENUM_SIZE;
+
+STATIC_ASSERT (sizeof (__VERIFY_UINT8_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (__VERIFY_UINT16_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
+STATIC_ASSERT (sizeof (__VERIFY_UINT32_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
+
 /**
   Macro that returns a pointer to the data structure that contains a specified field of
   that data structure.  This is a lightweight method to hide information by placing a
-- 
2.20.1 (Apple Git-117)


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 489 bytes --]

[PATCH v1 3/3] MdePkg: Drop VERIFY_SIZE_OF in favour of STATIC_ASSERT

[Vitaly Cheptsov]

[-- Attachment #1: Type: text/plain, Size: 1274 bytes --]

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2048

New STATIC_ASSERT macro supersedes VERIFY_SIZE_OF as being more functional.

Signed-off-by: Vitaly Cheptsov <vit9696@protonmail.com>
---
 MdePkg/Include/Base.h | 13 -------------
 1 file changed, 13 deletions(-)

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index d871422cd6..ed85b98318 100644
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -28,19 +28,6 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #pragma warning ( disable : 4200 )
 #endif
 
-/**
-  Verifies the storage size of a given data type.
-
-  This macro generates a divide by zero error or a zero size array declaration in
-  the preprocessor if the size is incorrect.  These are declared as "extern" so
-  the space for these arrays will not be in the modules.
-
-  @param  TYPE  The date type to determine the size of.
-  @param  Size  The expected size for the TYPE.
-
-**/
-#define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
-
 //
 // The Microsoft* C compiler can removed references to unreferenced data items
 //  if the /OPT:REF linker option is used. We defined a macro as this is a
-- 
2.20.1 (Apple Git-117)


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 489 bytes --]

Re: [edk2-devel] [PATCH v1 0/3] Replace VERIFY_SIZE_OF with STATIC_ASSERT

[Liming Gao]

Reviewed-by: Liming Gao <liming.gao@intel.com>

>-----Original Message-----
>From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
>Vitaly Cheptsov via Groups.Io
>Sent: Saturday, August 17, 2019 7:58 AM
>To: devel@edk2.groups.io
>Subject: [edk2-devel] [PATCH v1 0/3] Replace VERIFY_SIZE_OF with
>STATIC_ASSERT
>
>Things to note:
>
>- This patchset should go after STATIC_ASSERT implementation:
>  https://edk2.groups.io/g/devel/topic/32917749
>- It is suggested that unlike the previous patch, which in my
>  opinion should appear in edk2-stable201908, this patchset should
>  land in edk2-stable2019011. This will let more people to comment
>  whether they are ready to use it as is.
>
>Vitaly Cheptsov (3):
>  MdeModulePkg/ResetUtilityLib: Use STATIC_ASSERT macro
>  MdePkg: Use STATIC_ASSERT macro
>  MdePkg: Drop VERIFY_SIZE_OF in favour of STATIC_ASSERT
>
> MdePkg/Include/Base.h                               | 92 +++++++++-----------
> MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c |  5 +-
> 2 files changed, 44 insertions(+), 53 deletions(-)
>
>--
>2.20.1 (Apple Git-117)
>
>
>-=-=-=-=-=-=
>Groups.io Links: You receive all messages sent to this group.
>
>View/Reply Online (#45871): https://edk2.groups.io/g/devel/message/45871
>Mute This Topic: https://groups.io/mt/32918010/1759384
>Group Owner: devel+owner@edk2.groups.io
>Unsubscribe: https://edk2.groups.io/g/devel/unsub  [liming.gao@intel.com]
>-=-=-=-=-=-=

Re: [edk2-devel] [PATCH v1 1/3] MdeModulePkg/ResetUtilityLib: Use STATIC_ASSERT macro

[Wu, Hao A]

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Vitaly Cheptsov via Groups.Io
> Sent: Saturday, August 17, 2019 7:58 AM
> To: devel@edk2.groups.io
> Subject: [edk2-devel] [PATCH v1 1/3] MdeModulePkg/ResetUtilityLib: Use
> STATIC_ASSERT macro
> 
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2048
> 
> Use new STATIC_ASSERT macro instead of VERIFY_SIZE_OF.
> 
> Signed-off-by: Vitaly Cheptsov <vit9696@protonmail.com>
> ---
>  MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> b/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> index 2b5af4b95a..bb151d0331 100644
> --- a/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> +++ b/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> @@ -20,7 +20,10 @@ typedef struct {
>  } RESET_UTILITY_GUID_SPECIFIC_RESET_DATA;
>  #pragma pack()
> 
> -VERIFY_SIZE_OF (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA, 18);
> +STATIC_ASSERT (
> +  sizeof (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA) == 18,
> +  "sizeof (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA) is expected to be
> 18 bytes"
> +  );


Thanks for the patch,
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu


> 
>  /**
>    This is a shorthand helper function to reset with reset type and a subtype
> --
> 2.20.1 (Apple Git-117)
> 
> 
> -=-=-=-=-=-=
> Groups.io Links: You receive all messages sent to this group.
> 
> View/Reply Online (#45870): https://edk2.groups.io/g/devel/message/45870
> Mute This Topic: https://groups.io/mt/32918009/1768737
> Group Owner: devel+owner@edk2.groups.io
> Unsubscribe: https://edk2.groups.io/g/devel/unsub  [hao.a.wu@intel.com]
> -=-=-=-=-=-=

Re: [edk2-devel] [PATCH v1 1/3] MdeModulePkg/ResetUtilityLib: Use STATIC_ASSERT macro

[Gao, Zhichao]

Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Vitaly Cheptsov via Groups.Io
> Sent: Saturday, August 17, 2019 7:58 AM
> To: devel@edk2.groups.io
> Subject: [edk2-devel] [PATCH v1 1/3] MdeModulePkg/ResetUtilityLib: Use
> STATIC_ASSERT macro
> 
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2048
> 
> Use new STATIC_ASSERT macro instead of VERIFY_SIZE_OF.
> 
> Signed-off-by: Vitaly Cheptsov <vit9696@protonmail.com>
> ---
>  MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> b/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> index 2b5af4b95a..bb151d0331 100644
> --- a/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> +++ b/MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c
> @@ -20,7 +20,10 @@ typedef struct {
>  } RESET_UTILITY_GUID_SPECIFIC_RESET_DATA;
>  #pragma pack()
> 
> -VERIFY_SIZE_OF (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA, 18);
> +STATIC_ASSERT (
> +  sizeof (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA) == 18,
> +  "sizeof (RESET_UTILITY_GUID_SPECIFIC_RESET_DATA) is expected to be
> 18 bytes"
> +  );
> 
>  /**
>    This is a shorthand helper function to reset with reset type and a subtype
> --
> 2.20.1 (Apple Git-117)
> 
> 
> -=-=-=-=-=-=
> Groups.io Links: You receive all messages sent to this group.
> 
> View/Reply Online (#45870): https://edk2.groups.io/g/devel/message/45870
> Mute This Topic: https://groups.io/mt/32918009/1768756
> Group Owner: devel+owner@edk2.groups.io
> Unsubscribe: https://edk2.groups.io/g/devel/unsub
> [zhichao.gao@intel.com]
> -=-=-=-=-=-=

Re: [edk2-devel] [PATCH v1 0/3] Replace VERIFY_SIZE_OF with STATIC_ASSERT

[Liming Gao]

Push @0d85e67714e31e0dbe4241ab2ebb7c423aba174d..d8c4b87ec460233d2c6f3e1343b6638f8b4a1ddf

>-----Original Message-----
>From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
>Liming Gao
>Sent: Monday, September 09, 2019 8:54 AM
>To: devel@edk2.groups.io; vit9696@protonmail.com
>Subject: Re: [edk2-devel] [PATCH v1 0/3] Replace VERIFY_SIZE_OF with
>STATIC_ASSERT
>
>Reviewed-by: Liming Gao <liming.gao@intel.com>
>
>>-----Original Message-----
>>From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
>>Vitaly Cheptsov via Groups.Io
>>Sent: Saturday, August 17, 2019 7:58 AM
>>To: devel@edk2.groups.io
>>Subject: [edk2-devel] [PATCH v1 0/3] Replace VERIFY_SIZE_OF with
>>STATIC_ASSERT
>>
>>Things to note:
>>
>>- This patchset should go after STATIC_ASSERT implementation:
>>  https://edk2.groups.io/g/devel/topic/32917749
>>- It is suggested that unlike the previous patch, which in my
>>  opinion should appear in edk2-stable201908, this patchset should
>>  land in edk2-stable2019011. This will let more people to comment
>>  whether they are ready to use it as is.
>>
>>Vitaly Cheptsov (3):
>>  MdeModulePkg/ResetUtilityLib: Use STATIC_ASSERT macro
>>  MdePkg: Use STATIC_ASSERT macro
>>  MdePkg: Drop VERIFY_SIZE_OF in favour of STATIC_ASSERT
>>
>> MdePkg/Include/Base.h                               | 92 +++++++++-----------
>> MdeModulePkg/Library/ResetUtilityLib/ResetUtility.c |  5 +-
>> 2 files changed, 44 insertions(+), 53 deletions(-)
>>
>>--
>>2.20.1 (Apple Git-117)
>>
>>
>>-=-=-=-=-=-=
>>Groups.io Links: You receive all messages sent to this group.
>>
>>View/Reply Online (#45871):
>https://edk2.groups.io/g/devel/message/45871
>>Mute This Topic: https://groups.io/mt/32918010/1759384
>>Group Owner: devel+owner@edk2.groups.io
>>Unsubscribe: https://edk2.groups.io/g/devel/unsub  [liming.gao@intel.com]
>>-=-=-=-=-=-=
>
>
>