[PATCH] MdeModulePkg VarCheckHii: Make sure the bin at required alignment

[PATCH] MdeModulePkg VarCheckHii: Make sure the bin at required alignment

[Star Zeng]

According to UEFI/PI spec, the AllocateXXXPool() interfaces should
return eight-byte aligned buffer that satisfies the required
HEADER_ALIGNMENT which is 4.

This patch adds ASSERT to make sure the bin at required alignment,
that can help catch the issue earlier about incorrect aligned buffer
returned from AllocateXXXPool().

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c b/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c
index c0efed450bfb..0db1383491f7 100644
--- a/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c
+++ b/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c
@@ -1518,6 +1518,10 @@ BuildVarCheckHiiBin (
   //
   Data = AllocateRuntimeZeroPool (BinSize);
   ASSERT (Data != NULL);
+  //
+  // Make sure the allocated buffer for VarCheckHiiBin at required alignment.
+  //
+  ASSERT ((((UINTN) Data) & (HEADER_ALIGNMENT - 1)) == 0);
   DEBUG ((DEBUG_INFO, "VarCheckHiiBin - built at 0x%x\n", Data));
 
   //
-- 
2.7.0.windows.1

Re: [PATCH] MdeModulePkg VarCheckHii: Make sure the bin at required alignment

[Wang, Jian J]

Reviewed-by: Jian J Wang <jian.j.wang@intel.com>


> -----Original Message-----
> From: Zeng, Star
> Sent: Friday, December 29, 2017 6:14 PM
> To: edk2-devel@lists.01.org
> Cc: Zeng, Star <star.zeng@intel.com>; Wang, Jian J <jian.j.wang@intel.com>;
> Yao, Jiewen <jiewen.yao@intel.com>
> Subject: [PATCH] MdeModulePkg VarCheckHii: Make sure the bin at required
> alignment
> 
> According to UEFI/PI spec, the AllocateXXXPool() interfaces should
> return eight-byte aligned buffer that satisfies the required
> HEADER_ALIGNMENT which is 4.
> 
> This patch adds ASSERT to make sure the bin at required alignment,
> that can help catch the issue earlier about incorrect aligned buffer
> returned from AllocateXXXPool().
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Star Zeng <star.zeng@intel.com>
> ---
>  MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c
> b/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c
> index c0efed450bfb..0db1383491f7 100644
> --- a/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c
> +++ b/MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c
> @@ -1518,6 +1518,10 @@ BuildVarCheckHiiBin (
>    //
>    Data = AllocateRuntimeZeroPool (BinSize);
>    ASSERT (Data != NULL);
> +  //
> +  // Make sure the allocated buffer for VarCheckHiiBin at required alignment.
> +  //
> +  ASSERT ((((UINTN) Data) & (HEADER_ALIGNMENT - 1)) == 0);
>    DEBUG ((DEBUG_INFO, "VarCheckHiiBin - built at 0x%x\n", Data));
> 
>    //
> --
> 2.7.0.windows.1