[Patch] MdePkg/Include: Add enumeration size checks to Base.h

[Patch] MdePkg/Include: Add enumeration size checks to Base.h

[Michael Kinney]

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

Add size check for 8-bit, 16-bit, and 32-bit enums
to make sure they follow the UEFI Specification 2.3.1
Data Types.

<Enumerated Type>

Element of a standard ANSI C enum type declaration.
Type INT32.or UINT32.  ANSI C does not define the
size of sign of an enum so they should never be
used in structures. ANSI C integer promotion rules
make INT32 or UINT32 interchangeable when passed as
an argument to a function.

Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
---
 MdePkg/Include/Base.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index c666148..725d9c9 100644
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -63,6 +63,22 @@ VERIFY_SIZE_OF (UINT64, 8);
 VERIFY_SIZE_OF (CHAR8, 1);
 VERIFY_SIZE_OF (CHAR16, 2);
 
+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
-- 
2.6.3.windows.1

Re: [Patch] MdePkg/Include: Add enumeration size checks to Base.h

[Gao, Liming]

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

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Michael Kinney
> Sent: Thursday, October 27, 2016 5:46 AM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming <liming.gao@intel.com>
> Subject: [edk2] [Patch] MdePkg/Include: Add enumeration size checks to
> Base.h
> 
> https://bugzilla.tianocore.org/show_bug.cgi?id=181
> 
> Add size check for 8-bit, 16-bit, and 32-bit enums
> to make sure they follow the UEFI Specification 2.3.1
> Data Types.
> 
> <Enumerated Type>
> 
> Element of a standard ANSI C enum type declaration.
> Type INT32.or UINT32.  ANSI C does not define the
> size of sign of an enum so they should never be
> used in structures. ANSI C integer promotion rules
> make INT32 or UINT32 interchangeable when passed as
> an argument to a function.
> 
> Cc: Liming Gao <liming.gao@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
> ---
>  MdePkg/Include/Base.h | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
> index c666148..725d9c9 100644
> --- a/MdePkg/Include/Base.h
> +++ b/MdePkg/Include/Base.h
> @@ -63,6 +63,22 @@ VERIFY_SIZE_OF (UINT64, 8);
>  VERIFY_SIZE_OF (CHAR8, 1);
>  VERIFY_SIZE_OF (CHAR16, 2);
> 
> +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
> --
> 2.6.3.windows.1
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel