public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael Kubacki" <mikuback@linux.microsoft.com>
To: "Kinney, Michael D" <michael.d.kinney@intel.com>,
	"devel@edk2.groups.io" <devel@edk2.groups.io>
Cc: Erich McMillan <emcmillan@microsoft.com>,
	"Gao, Liming" <gaoliming@byosoft.com.cn>,
	"Liu, Zhiguang" <zhiguang.liu@intel.com>
Subject: Re: [PATCH v1 06/12] MdePkg: Fix conditionally uninitialized variables
Date: Wed, 23 Nov 2022 20:59:13 -0500	[thread overview]
Message-ID: <9b4a11c3-5227-9cd8-a79b-2328d96dcb93@linux.microsoft.com> (raw)
In-Reply-To: <CO1PR11MB49291D25358587203F695751D20F9@CO1PR11MB4929.namprd11.prod.outlook.com>

Thanks. Responses inline.

On 11/23/2022 8:53 PM, Kinney, Michael D wrote:
> Hi Michael,
> 
> Comments below.
> 
> Mike
> 
>> -----Original Message-----
>> From: mikuback@linux.microsoft.com <mikuback@linux.microsoft.com>
>> Sent: Wednesday, November 9, 2022 9:33 AM
>> To: devel@edk2.groups.io
>> Cc: Erich McMillan <emcmillan@microsoft.com>; Gao, Liming <gaoliming@byosoft.com.cn>; Kinney, Michael D
>> <michael.d.kinney@intel.com>; Michael Kubacki <mikuback@linux.microsoft.com>; Liu, Zhiguang <zhiguang.liu@intel.com>
>> Subject: [PATCH v1 06/12] MdePkg: Fix conditionally uninitialized variables
>>
>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> Fixes CodeQL alerts for CWE-457:
>> https://cwe.mitre.org/data/definitions/457.html
>>
>> Cc: Erich McMillan <emcmillan@microsoft.com>
>> Cc: Liming Gao <gaoliming@byosoft.com.cn>
>> Cc: Michael D Kinney <michael.d.kinney@intel.com>
>> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
>> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
>> Co-authored-by: Erich McMillan <emcmillan@microsoft.com>
>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>> ---
>>   MdePkg/Library/BaseLib/String.c | 20 ++++++++++++--------
>>   1 file changed, 12 insertions(+), 8 deletions(-)
>>
>> diff --git a/MdePkg/Library/BaseLib/String.c b/MdePkg/Library/BaseLib/String.c
>> index 98e6d31463e0..0ff0454b9d98 100644
>> --- a/MdePkg/Library/BaseLib/String.c
>> +++ b/MdePkg/Library/BaseLib/String.c
>> @@ -6,6 +6,7 @@
>>
>>   **/
>>
>> +#include <Uefi/UefiBaseType.h>
> 
> Why is this change needed?
> 
> I think this should be <Base.h> for a library of type BASE
> and BaseLibInternals.h includes <Base.h>.  I see the use
> of EFI_ERROR() in changes below.  The BASE lib macro to use
> that does not require UEFI types is the RETURN_ERROR() macro.
> 

I'll double check it.

>>   #include "BaseLibInternals.h"
>>
>>   /**
>> @@ -408,7 +409,8 @@ StrDecimalToUintn (
>>   {
>>     UINTN  Result;
>>
>> -  StrDecimalToUintnS (String, (CHAR16 **)NULL, &Result);
>> +  Result = !EFI_ERROR (StrDecimalToUintnS (String, (CHAR16 **)NULL, &Result)) ? Result : MAX_UINTN;> +
> 
> I think RETURN_ERROR() should be used instead of EFI_ERROR()), and putting
> this on a single line makes it hard to understand.  Perhaps the following
> style:
> 
> 
>    if (RETURN_ERROR (StrDecimalToUintnS (String, (CHAR16 **)NULL, &Result))) {
>      return MAX_UINTN;
>    }
>    return Result;
> 
> I would also add more details to the commit message.  The current form would
> return an undefined Result value from the stack if StrDecimalToUintnS()
> returned an error.  This change now consistently returns MAX_UINTN.
> This may impact the caller of this API.
> 
> These comments apply to the similar changes below.
> 

I agree the suggested style is easier to read.

I will also add a note about the change in return value behavior.

>>     return Result;
>>   }
>>
>> @@ -454,7 +456,8 @@ StrDecimalToUint64 (
>>   {
>>     UINT64  Result;
>>
>> -  StrDecimalToUint64S (String, (CHAR16 **)NULL, &Result);
>> +  Result = !EFI_ERROR (StrDecimalToUint64S (String, (CHAR16 **)NULL, &Result)) ? Result : MAX_UINT64;
>> +
>>     return Result;
>>   }
>>
>> @@ -501,7 +504,8 @@ StrHexToUintn (
>>   {
>>     UINTN  Result;
>>
>> -  StrHexToUintnS (String, (CHAR16 **)NULL, &Result);
>> +  Result = !EFI_ERROR (StrHexToUintnS (String, (CHAR16 **)NULL, &Result)) ? Result : MAX_UINTN;
>> +
>>     return Result;
>>   }
>>
>> @@ -548,7 +552,7 @@ StrHexToUint64 (
>>   {
>>     UINT64  Result;
>>
>> -  StrHexToUint64S (String, (CHAR16 **)NULL, &Result);
>> +  Result = !EFI_ERROR (StrHexToUint64S (String, (CHAR16 **)NULL, &Result)) ? Result : MAX_UINT64;
>>     return Result;
>>   }
>>
>> @@ -989,7 +993,7 @@ AsciiStrDecimalToUintn (
>>   {
>>     UINTN  Result;
>>
>> -  AsciiStrDecimalToUintnS (String, (CHAR8 **)NULL, &Result);
>> +  Result = !EFI_ERROR (AsciiStrDecimalToUintnS (String, (CHAR8 **)NULL, &Result)) ? Result : MAX_UINTN;
>>     return Result;
>>   }
>>
>> @@ -1031,7 +1035,7 @@ AsciiStrDecimalToUint64 (
>>   {
>>     UINT64  Result;
>>
>> -  AsciiStrDecimalToUint64S (String, (CHAR8 **)NULL, &Result);
>> +  Result = !EFI_ERROR (AsciiStrDecimalToUint64S (String, (CHAR8 **)NULL, &Result)) ? Result : MAX_UINT64;
>>     return Result;
>>   }
>>
>> @@ -1077,7 +1081,7 @@ AsciiStrHexToUintn (
>>   {
>>     UINTN  Result;
>>
>> -  AsciiStrHexToUintnS (String, (CHAR8 **)NULL, &Result);
>> +  Result = !EFI_ERROR (AsciiStrHexToUintnS (String, (CHAR8 **)NULL, &Result)) ? Result : MAX_UINTN;
>>     return Result;
>>   }
>>
>> @@ -1123,7 +1127,7 @@ AsciiStrHexToUint64 (
>>   {
>>     UINT64  Result;
>>
>> -  AsciiStrHexToUint64S (String, (CHAR8 **)NULL, &Result);
>> +  Result = !EFI_ERROR (AsciiStrHexToUint64S (String, (CHAR8 **)NULL, &Result)) ? Result : MAX_UINT64;
>>     return Result;
>>   }
>>
>> --
>> 2.28.0.windows.1
> 

  reply	other threads:[~2022-11-24  1:59 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-09 17:32 [PATCH v1 00/12] Enable New CodeQL Queries Michael Kubacki
2022-11-09 17:32 ` [PATCH v1 01/12] MdeModulePkg/SmbiosDxe: Fix pointer and buffer overflow CodeQL alerts Michael Kubacki
2022-11-24  1:28   ` [edk2-devel] " Michael D Kinney
2022-11-24  1:46     ` Michael Kubacki
2022-11-09 17:32 ` [PATCH v1 02/12] BaseTools/PatchCheck.py: Add PCCTS to tab exemption list Michael Kubacki
2022-11-24  1:30   ` Michael D Kinney
2022-11-09 17:32 ` [PATCH v1 03/12] BaseTools/VfrCompile: Fix potential buffer overwrites Michael Kubacki
2022-11-24  1:32   ` [edk2-devel] " Michael D Kinney
2022-11-09 17:32 ` [PATCH v1 04/12] CryptoPkg: Fix conditionally uninitialized variable Michael Kubacki
2022-11-24  1:37   ` [edk2-devel] " Michael D Kinney
2022-11-24  1:47     ` Michael Kubacki
2022-11-09 17:32 ` [PATCH v1 05/12] MdeModulePkg: Fix conditionally uninitialized variables Michael Kubacki
2022-11-09 17:32 ` [PATCH v1 06/12] MdePkg: " Michael Kubacki
2022-11-24  1:53   ` Michael D Kinney
2022-11-24  1:59     ` Michael Kubacki [this message]
2022-11-09 17:32 ` [PATCH v1 07/12] NetworkPkg: " Michael Kubacki
2022-11-24  1:59   ` Michael D Kinney
2022-11-09 17:32 ` [PATCH v1 08/12] PcAtChipsetPkg: " Michael Kubacki
2022-11-24  2:00   ` Michael D Kinney
2022-11-24  5:01     ` Ni, Ray
2022-11-09 17:32 ` [PATCH v1 09/12] ShellPkg: " Michael Kubacki
2022-11-24  2:19   ` Gao, Zhichao
2022-11-24  2:36     ` [edk2-devel] " Michael Kubacki
2022-11-09 17:32 ` [PATCH v1 10/12] UefiCpuPkg: " Michael Kubacki
2022-11-24  2:04   ` [edk2-devel] " Michael D Kinney
2022-11-24  2:14     ` Michael Kubacki
2022-11-24  2:31       ` Michael D Kinney
2022-11-24  5:12         ` Ni, Ray
2022-11-28 22:50           ` Michael Kubacki
2022-11-09 17:32 ` [PATCH v1 11/12] .github/codeql/edk2.qls: Enable CWE 457, 676, and 758 queries Michael Kubacki
2022-11-24  2:05   ` [edk2-devel] " Michael D Kinney
2022-11-09 17:32 ` [PATCH v1 12/12] .github/codeql/edk2.qls: Enable CWE 120, 787, and 805 queries Michael Kubacki
2022-11-24  2:06   ` Michael D Kinney

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=9b4a11c3-5227-9cd8-a79b-2328d96dcb93@linux.microsoft.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox