Re: [edk2-devel] [PATCH v1 0/7] Add DebugMacroCheck

Re: [edk2-devel] [PATCH v1 0/7] Add DebugMacroCheck

[Michael Kubacki]

Hi all,

Now that the stable tag is out, I would appreciate reviews for this series.

Thanks,
Michael

On 8/14/2023 4:48 PM, Michael Kubacki wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
> 
> Adds a new script and build plugin called DebugMacroCheck.
> 
> The script verifies that the number of print specifiers match the
> number of arguments in DEBUG() calls.
> 
> Overview:
> 
> - Build plugin: BuildPlugin/DebugMacroCheckBuildPlugin.py
>    - Runs on any build target that is not NO-TARGET
> - Standalone script: DebugMacroCheck.py
>    - Run `DebugMacroCheck.py --help` to see command line options
> - Unit tests:
>    - Tests/test_DebugMacroCheck.py
>    - Can be run with:
>      `python -m unittest discover -s ./.pytool/Plugin/DebugMacroCheck/tests -v`
>    - Also visible in VS Code Test Explorer
> 
> Background:
> 
> The tool has been constantly run against edk2 derived code for about
> a year now. During that time, its found over 20 issues in edk2, over
> 50 issues in various vendor code, and numerous other issues specific
> to Project Mu.
> 
> See the following series for a batch of issues previously fixed in
> edk2 discovered by the tool:
> 
>    https://edk2.groups.io/g/devel/message/93104
> 
> I've received interest from vendors to place it in edk2 to
> immediately find issues in the upstream and make it easier for edk2
> consumers to directly acquire it. That led to this patch series.
> 
> This would run in edk2 as a build plugin. All issues in the edk2
> codebase have been resolved so this would find new issues before
> they are merged into the codebase.
> 
> The script is meant to be portable so it can be run as a build plugin
> or dropped as a standalone script into other environments alongside
> the unit tests.
> 
> Series Overview:
> 
> - Fixes outstanding issues in RedfishPkg
> - Adds the `regex` PIP module to pip-requirements.txt
> - Adds exceptions for debug macro usage in ArmVirtPkg,
>    DynamicTablesPkg, and SecurityPkg
> - Disables the plugin in OvmfPkg per maintainer's previous
>    preferences
> - Adds the plugin
> 
> The plugin (this series) is running with passing CI results as shown
> in this PR:
>    https://github.com/tianocore/edk2/pull/4736
> 
> Cc: Abner Chang <abner.chang@amd.com>
> Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Igor Kulchytskyy <igork@ami.com>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Nickle Wang <nicklew@nvidia.com>
> Cc: Pierre Gondois <pierre.gondois@arm.com>
> Cc: Sami Mujawar <Sami.Mujawar@arm.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> 
> Michael Kubacki (7):
>    RedfishPkg/PlatformHostInterfaceBmcUsbNicLib: Fix DEBUG macro args
>    pip-requirements.txt: Add regex
>    SecurityPkg.ci.yaml: Add debug macro exception
>    ArmVirtPkg.ci.yaml: Add debug macro exception
>    DynamicTablesPkg.ci.yaml: Add debug macro exception
>    OvmfPkg/PlatformCI: Disable DebugMacroCheck
>    .pytool/Plugin: Add DebugMacroCheck
> 
>   RedfishPkg/Library/PlatformHostInterfaceBmcUsbNicLib/PlatformHostInterfaceBmcUsbNicLib.c |   8 +-
>   .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheckBuildPlugin.py                 | 127 +++
>   .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheck_plug_in.yaml                  |  11 +
>   .pytool/Plugin/DebugMacroCheck/DebugMacroCheck.py                                        | 859 ++++++++++++++++++++
>   .pytool/Plugin/DebugMacroCheck/Readme.md                                                 | 253 ++++++
>   .pytool/Plugin/DebugMacroCheck/tests/DebugMacroDataSet.py                                | 674 +++++++++++++++
>   .pytool/Plugin/DebugMacroCheck/tests/MacroTest.py                                        | 131 +++
>   .pytool/Plugin/DebugMacroCheck/tests/__init__.py                                         |   0
>   .pytool/Plugin/DebugMacroCheck/tests/test_DebugMacroCheck.py                             | 201 +++++
>   ArmVirtPkg/ArmVirtPkg.ci.yaml                                                            |   8 +
>   DynamicTablesPkg/DynamicTablesPkg.ci.yaml                                                |   8 +
>   OvmfPkg/PlatformCI/PlatformBuildLib.py                                                   |   1 +
>   SecurityPkg/SecurityPkg.ci.yaml                                                          |   9 +
>   pip-requirements.txt                                                                     |   2 +-
>   14 files changed, 2287 insertions(+), 5 deletions(-)
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheckBuildPlugin.py
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheck_plug_in.yaml
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/DebugMacroCheck.py
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/Readme.md
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/tests/DebugMacroDataSet.py
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/tests/MacroTest.py
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/tests/__init__.py
>   create mode 100644 .pytool/Plugin/DebugMacroCheck/tests/test_DebugMacroCheck.py
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108102): https://edk2.groups.io/g/devel/message/108102
Mute This Topic: https://groups.io/mt/100745693/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

回复: [edk2-devel] [PATCH v1 0/7] Add DebugMacroCheck

[gaoliming via groups.io]

Michael:
  I think this change is helpful. For this patch set, Acked-by: Liming Gao <gaoliming@byosoft.com.cn>

Thanks
Liming
> -----邮件原件-----
> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Michael
> Kubacki
> 发送时间: 2023年8月30日 7:27
> 收件人: devel@edk2.groups.io
> 抄送: Abner Chang <abner.chang@amd.com>; Alexei Fedorov
> <Alexei.Fedorov@arm.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>;
> Gerd Hoffmann <kraxel@redhat.com>; Igor Kulchytskyy <igork@ami.com>;
> Jian J Wang <jian.j.wang@intel.com>; Jiewen Yao <jiewen.yao@intel.com>;
> Jordan Justen <jordan.l.justen@intel.com>; Leif Lindholm
> <quic_llindhol@quicinc.com>; Liming Gao <gaoliming@byosoft.com.cn>;
> Michael D Kinney <michael.d.kinney@intel.com>; Nickle Wang
> <nicklew@nvidia.com>; Pierre Gondois <pierre.gondois@arm.com>; Sami
> Mujawar <Sami.Mujawar@arm.com>; Sean Brogan
> <sean.brogan@microsoft.com>
> 主题: Re: [edk2-devel] [PATCH v1 0/7] Add DebugMacroCheck
> 
> Hi all,
> 
> Now that the stable tag is out, I would appreciate reviews for this series.
> 
> Thanks,
> Michael
> 
> On 8/14/2023 4:48 PM, Michael Kubacki wrote:
> > From: Michael Kubacki <michael.kubacki@microsoft.com>
> >
> > Adds a new script and build plugin called DebugMacroCheck.
> >
> > The script verifies that the number of print specifiers match the
> > number of arguments in DEBUG() calls.
> >
> > Overview:
> >
> > - Build plugin: BuildPlugin/DebugMacroCheckBuildPlugin.py
> >    - Runs on any build target that is not NO-TARGET
> > - Standalone script: DebugMacroCheck.py
> >    - Run `DebugMacroCheck.py --help` to see command line options
> > - Unit tests:
> >    - Tests/test_DebugMacroCheck.py
> >    - Can be run with:
> >      `python -m unittest discover
> -s ./.pytool/Plugin/DebugMacroCheck/tests -v`
> >    - Also visible in VS Code Test Explorer
> >
> > Background:
> >
> > The tool has been constantly run against edk2 derived code for about
> > a year now. During that time, its found over 20 issues in edk2, over
> > 50 issues in various vendor code, and numerous other issues specific
> > to Project Mu.
> >
> > See the following series for a batch of issues previously fixed in
> > edk2 discovered by the tool:
> >
> >    https://edk2.groups.io/g/devel/message/93104
> >
> > I've received interest from vendors to place it in edk2 to
> > immediately find issues in the upstream and make it easier for edk2
> > consumers to directly acquire it. That led to this patch series.
> >
> > This would run in edk2 as a build plugin. All issues in the edk2
> > codebase have been resolved so this would find new issues before
> > they are merged into the codebase.
> >
> > The script is meant to be portable so it can be run as a build plugin
> > or dropped as a standalone script into other environments alongside
> > the unit tests.
> >
> > Series Overview:
> >
> > - Fixes outstanding issues in RedfishPkg
> > - Adds the `regex` PIP module to pip-requirements.txt
> > - Adds exceptions for debug macro usage in ArmVirtPkg,
> >    DynamicTablesPkg, and SecurityPkg
> > - Disables the plugin in OvmfPkg per maintainer's previous
> >    preferences
> > - Adds the plugin
> >
> > The plugin (this series) is running with passing CI results as shown
> > in this PR:
> >    https://github.com/tianocore/edk2/pull/4736
> >
> > Cc: Abner Chang <abner.chang@amd.com>
> > Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
> > Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> > Cc: Gerd Hoffmann <kraxel@redhat.com>
> > Cc: Igor Kulchytskyy <igork@ami.com>
> > Cc: Jian J Wang <jian.j.wang@intel.com>
> > Cc: Jiewen Yao <jiewen.yao@intel.com>
> > Cc: Jordan Justen <jordan.l.justen@intel.com>
> > Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> > Cc: Liming Gao <gaoliming@byosoft.com.cn>
> > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > Cc: Nickle Wang <nicklew@nvidia.com>
> > Cc: Pierre Gondois <pierre.gondois@arm.com>
> > Cc: Sami Mujawar <Sami.Mujawar@arm.com>
> > Cc: Sean Brogan <sean.brogan@microsoft.com>
> >
> > Michael Kubacki (7):
> >    RedfishPkg/PlatformHostInterfaceBmcUsbNicLib: Fix DEBUG macro
> args
> >    pip-requirements.txt: Add regex
> >    SecurityPkg.ci.yaml: Add debug macro exception
> >    ArmVirtPkg.ci.yaml: Add debug macro exception
> >    DynamicTablesPkg.ci.yaml: Add debug macro exception
> >    OvmfPkg/PlatformCI: Disable DebugMacroCheck
> >    .pytool/Plugin: Add DebugMacroCheck
> >
> >
> RedfishPkg/Library/PlatformHostInterfaceBmcUsbNicLib/PlatformHostInterfa
> ceBmcUsbNicLib.c |   8 +-
> >   .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheckBuildPl
> ugin.py                 | 127 +++
> >   .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheck_plug_
> in.yaml                  |  11 +
> >   .pytool/Plugin/DebugMacroCheck/DebugMacroCheck.py
> | 859 ++++++++++++++++++++
> >   .pytool/Plugin/DebugMacroCheck/Readme.md
> | 253 ++++++
> >   .pytool/Plugin/DebugMacroCheck/tests/DebugMacroDataSet.py
> | 674 +++++++++++++++
> >   .pytool/Plugin/DebugMacroCheck/tests/MacroTest.py
> | 131 +++
> >   .pytool/Plugin/DebugMacroCheck/tests/__init__.py
> |   0
> >   .pytool/Plugin/DebugMacroCheck/tests/test_DebugMacroCheck.py
> | 201 +++++
> >   ArmVirtPkg/ArmVirtPkg.ci.yaml
> |   8 +
> >   DynamicTablesPkg/DynamicTablesPkg.ci.yaml
> |   8 +
> >   OvmfPkg/PlatformCI/PlatformBuildLib.py
> |   1 +
> >   SecurityPkg/SecurityPkg.ci.yaml
> |   9 +
> >   pip-requirements.txt
> |   2 +-
> >   14 files changed, 2287 insertions(+), 5 deletions(-)
> >   create mode
> 100644 .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheckBuil
> dPlugin.py
> >   create mode
> 100644 .pytool/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheck_pl
> ug_in.yaml
> >   create mode
> 100644 .pytool/Plugin/DebugMacroCheck/DebugMacroCheck.py
> >   create mode 100644 .pytool/Plugin/DebugMacroCheck/Readme.md
> >   create mode
> 100644 .pytool/Plugin/DebugMacroCheck/tests/DebugMacroDataSet.py
> >   create mode
> 100644 .pytool/Plugin/DebugMacroCheck/tests/MacroTest.py
> >   create mode
> 100644 .pytool/Plugin/DebugMacroCheck/tests/__init__.py
> >   create mode
> 100644 .pytool/Plugin/DebugMacroCheck/tests/test_DebugMacroCheck.py
> >
> 
> 
> 
> 





-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108247): https://edk2.groups.io/g/devel/message/108247
Mute This Topic: https://groups.io/mt/101142278/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-