From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 893CF1A1E29 for ; Thu, 27 Oct 2016 01:49:27 -0700 (PDT) Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id A029BC0567A3; Thu, 27 Oct 2016 08:49:26 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-24.phx2.redhat.com [10.3.116.24]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u9R8nLPU015878; Thu, 27 Oct 2016 04:49:22 -0400 To: Jordan Justen , edk2-devel-01 References: <20161026190504.9888-1-lersek@redhat.com> <147754834759.8915.16019621269123697387@jljusten-ivb> Cc: Ruiyu Ni , Tim He , Feng Tian , Michael D Kinney , Eric Dong , Cecil Sheng , Ard Biesheuvel , Liming Gao , Dandan Bi , Jiaxin Wu , Gary Lin , Star Zeng , Daryl McDaniel , Jaben Carsey , Siyuan Fu , Jeff Fan , Chao Zhang , David Wei From: Laszlo Ersek Message-ID: <44954933-cebe-a5f3-2466-c5e92547611e@redhat.com> Date: Thu, 27 Oct 2016 10:49:20 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.4.0 MIME-Version: 1.0 In-Reply-To: <147754834759.8915.16019621269123697387@jljusten-ivb> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.32]); Thu, 27 Oct 2016 08:49:27 +0000 (UTC) Subject: Re: [PATCH 00/47] edk2: centralize and adopt ARRAY_SIZE() X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 27 Oct 2016 08:49:27 -0000 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit On 10/27/16 08:05, Jordan Justen wrote: > On 2016-10-26 12:04:17, Laszlo Ersek wrote: >> I'm sure most of us have wished at some point that ARRAY_SIZE() >> had existed in a central header file, like it does in many other >> open source projects. > > Indeed! > >> This series implements that. >> >> Patches 01-04 round up the modules that #define ARRAY_SIZE() just >> for themselves, and wrap their definitions in #ifndef ARRAY_SIZE. >> >> Patch 05 defines ARRAY_SIZE() in "MdePkg/Include/Base.h". This >> flips the previously modified modules to MdePkg's macro definition. >> >> Patches 06-09 modify the same set of modules as patches 01-04 do; this >> time the (now unused) module-local ARRAY_SIZE() macro definitions are >> eliminated. >> >> The rest of the patches (10-47) migrate the edk2 tree to ARRAY_SIZE(), >> covering the most obvious open-coded ARRAY_SIZE() expressions. These >> expressions were located and converted with the following shell >> pipeline: >> >> git ls-files \ >> | xargs --no-run-if-empty -- \ >> sed --regexp-extended --in-place \ >> --expression='s,sizeof \(([a-zA-Z0-9_]+)\) / sizeof \((\*\1|\1\[0\])\),ARRAY_SIZE (\1),g' \ >> -- >> >> This pipeline lists all tracked files with "git". The pathnames are then >> composed with "xargs" into maximal length "sed" command lines, and those >> "sed" commands are run. >> >> Here the "sed" stream editor filters and modifies all the listed files >> in place. The extended regular expression replaces the following two >> patterns: >> >> sizeof (ArrayName) / sizeof (*ArrayName) >> sizeof (ArrayName) / sizeof (ArrayName[0]) >> >> with >> >> ARRAY_SIZE (ArrayName) >> >> The regexp uses a backreference in the match, ensuring that the sizeof >> operator in the dividend and the sizeof operator in the divisor both >> refer to the same ArrayName. If there are multiple occurrences on the >> same line, the sed command replaces all of them. >> >> I collected the changes into patches manually, and I reviewed them all. >> >> I test-built all of the modified packages, repeating the command >> >> build -a X64 -t GCC48 -b DEBUG -p FooPkg/FooPkg.dsc >> >> as many times as necessary. Two packages were impossible to build like >> this: Nt32Pkg and Vlv2TbltDevicePkg, so I couldn't build-test them. >> >> I did some light-weight testing with OVMF: boot with Secure Boot >> enabled, S3 suspend/resume with and without SMM. I also booted >> ArmVirtQemu once. >> >> Repository: https://github.com/lersek/edk2.git >> Branch: array_size >> >> Cc: Ard Biesheuvel >> Cc: Cecil Sheng >> Cc: Chao Zhang >> Cc: Dandan Bi >> Cc: Daryl McDaniel >> Cc: David Wei >> Cc: Eric Dong >> Cc: Feng Tian >> Cc: Gary Lin >> Cc: Jaben Carsey >> Cc: Jeff Fan >> Cc: Jiaxin Wu >> Cc: Jordan Justen >> Cc: Liming Gao >> Cc: Michael D Kinney >> Cc: Ruiyu Ni >> Cc: Siyuan Fu >> Cc: Star Zeng >> Cc: Tim He >> >> Thanks >> Laszlo >> >> Laszlo Ersek (47): >> MdeModulePkg/RegularExpressionDxe: guard the definition of ARRAY_SIZE >> NetworkPkg/IpsecConfig: guard the definition of ARRAY_SIZE >> OvmfPkg/PlatformBootManagerLib: guard the definition of ARRAY_SIZE >> OvmfPkg/XenBusDxe: guard the definition of ARRAY_SIZE >> MdePkg/Include/Base.h: introduce the ARRAY_SIZE() function-like macro >> MdeModulePkg/RegularExpressionDxe: remove module-local ARRAY_SIZE >> macro >> NetworkPkg/IpsecConfig: remove module-local ARRAY_SIZE macro >> OvmfPkg/PlatformBootManagerLib: remove module-local ARRAY_SIZE macro >> OvmfPkg/XenBusDxe: remove module-local ARRAY_SIZE macro >> ArmVirtPkg/NorFlashQemuLib: rebase to ARRAY_SIZE() > > Maybe "Make use of" or something like that might be preferable to > "rebase to", but it is not a big deal. Yes, "utilize" and "adopt" crossed my mind at some point, but then I had been quite into the middle of the series. Oh well. :) > > I think I also saw some 'after' lines longer than 80 columns, but sed > can only invoke a limited level of magic after all. :) I think you > fixed *many* overly long lines in this series. Thanks for that as > well! :) Right, I was happy to see that as well. The shortening seemed especially useful for: - the new safe string functions, where ARRAY_SIZE() got applied to a CHAR16 array, - controlling expressions of "if" and "for" statements, - assertions. I saw that some lines remained that were still too long, but one wants to get only so clever in a SED regexp, like you say :) > Series Reviewed-by: Jordan Justen Thank you! Laszlo > >> DuetPkg/DuetBdsLib: rebase to ARRAY_SIZE() >> EdkCompatibilityPkg/FrameworkHiiOnUefiHiiThunk: rebase to ARRAY_SIZE() >> EdkCompatibilityPkg/Sample/Tools: rebase to ARRAY_SIZE() >> FatPkg/EnhancedFatDxe: rebase to ARRAY_SIZE() >> IntelFrameworkModulePkg/LegacyBootManagerLib: rebase to ARRAY_SIZE() >> IntelFrameworkModulePkg/BdsDxe: rebase to ARRAY_SIZE() >> MdeModulePkg/MemoryProfileInfo: rebase to ARRAY_SIZE() >> MdeModulePkg/PciBusDxe: rebase to ARRAY_SIZE() >> MdeModulePkg/PciHostBridgeDxe: rebase to ARRAY_SIZE() >> MdeModulePkg/UsbBusDxe: rebase to ARRAY_SIZE() >> MdeModulePkg/Core/Dxe: rebase to ARRAY_SIZE() >> MdeModulePkg/Core/PiSmmCore: rebase to ARRAY_SIZE() >> MdeModulePkg/BootMaintenanceManagerUiLib: rebase to ARRAY_SIZE() >> MdeModulePkg/BootManagerUiLib: rebase to ARRAY_SIZE() >> MdeModulePkg/UefiBootManagerLib: rebase to ARRAY_SIZE() >> MdeModulePkg/VarCheckHiiLib: rebase to ARRAY_SIZE() >> MdeModulePkg/Logo: rebase to ARRAY_SIZE() >> MdeModulePkg/BdsDxe: rebase to ARRAY_SIZE() >> MdeModulePkg/DisplayEngineDxe: rebase to ARRAY_SIZE() >> MdeModulePkg/EbcDxe: rebase to ARRAY_SIZE() >> MdeModulePkg/Tcp4Dxe: rebase to ARRAY_SIZE() >> MdeModulePkg/Variable/RuntimeDxe: rebase to ARRAY_SIZE() >> NetworkPkg/IScsiDxe: rebase to ARRAY_SIZE() >> NetworkPkg/TcpDxe: rebase to ARRAY_SIZE() >> Nt32Pkg/WinNtSerialIoDxe: rebase to ARRAY_SIZE() >> OptionRomPkg/AtapiPassThruDxe: rebase to ARRAY_SIZE() >> OvmfPkg/QemuBootOrderLib: rebase to ARRAY_SIZE() >> OvmfPkg/QemuVideoDxe: rebase to ARRAY_SIZE() >> PerformancePkg/Dp_App: rebase to ARRAY_SIZE() >> SecurityPkg/AuthVariableLib: rebase to ARRAY_SIZE() >> ShellPkg/UefiDpLib: rebase to ARRAY_SIZE() >> ShellPkg/UefiShellLevel2CommandsLib: rebase to ARRAY_SIZE() >> Vlv2TbltDevicePkg/FirmwareUpdate: rebase to ARRAY_SIZE() >> Vlv2TbltDevicePkg/PlatformInitPei: rebase to ARRAY_SIZE() >> Vlv2TbltDevicePkg/PlatformPei: rebase to ARRAY_SIZE() >> Vlv2TbltDevicePkg/PlatformSetupDxe: rebase to ARRAY_SIZE() >> Vlv2TbltDevicePkg/SmBiosMiscDxe: rebase to ARRAY_SIZE() >> >> ArmVirtPkg/Library/NorFlashQemuLib/NorFlashQemuLib.c | 2 +- >> DuetPkg/Library/DuetBdsLib/BdsPlatform.c | 2 +- >> EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/OpcodeCreation.c | 2 +- >> EdkCompatibilityPkg/Sample/Tools/Source/EfiRom/EfiRom.c | 4 ++-- >> EdkCompatibilityPkg/Sample/Tools/Source/HiiPack/IfrParse.c | 2 +- >> FatPkg/EnhancedFatDxe/DirectoryManage.c | 4 ++-- >> FatPkg/EnhancedFatDxe/FileName.c | 4 ++-- >> FatPkg/EnhancedFatDxe/Hash.c | 4 ++-- >> IntelFrameworkModulePkg/Library/LegacyBootManagerLib/LegacyBm.c | 2 +- >> IntelFrameworkModulePkg/Universal/BdsDxe/BdsEntry.c | 2 +- >> IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c | 4 ++-- >> IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootMaint.c | 8 ++++---- >> IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BootOption.c | 2 +- >> IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/ConsoleOption.c | 6 +++--- >> IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/UpdatePage.c | 10 +++++----- >> IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/Variable.c | 2 +- >> IntelFrameworkModulePkg/Universal/BdsDxe/BootMngr/BootManager.c | 2 +- >> MdeModulePkg/Application/MemoryProfileInfo/MemoryProfileInfo.c | 6 +++--- >> MdeModulePkg/Bus/Pci/PciBusDxe/PciLib.c | 2 +- >> MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciHostBridge.c | 2 +- >> MdeModulePkg/Bus/Usb/UsbBusDxe/UsbHub.c | 4 ++-- >> MdeModulePkg/Core/Dxe/Mem/Pool.c | 2 +- >> MdeModulePkg/Core/PiSmmCore/Pool.c | 2 +- >> MdeModulePkg/Core/PiSmmCore/SmramProfileRecord.c | 6 +++--- >> MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c | 8 ++++---- >> MdeModulePkg/Library/BootMaintenanceManagerUiLib/ConsoleOption.c | 8 ++++---- >> MdeModulePkg/Library/BootMaintenanceManagerUiLib/UpdatePage.c | 12 ++++++------ >> MdeModulePkg/Library/BootMaintenanceManagerUiLib/Variable.c | 2 +- >> MdeModulePkg/Library/BootManagerUiLib/BootManager.c | 6 +++--- >> MdeModulePkg/Library/UefiBootManagerLib/BmBootDescription.c | 2 +- >> MdeModulePkg/Library/UefiBootManagerLib/BmConsole.c | 2 +- >> MdeModulePkg/Library/UefiBootManagerLib/BmHotkey.c | 2 +- >> MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c | 4 ++-- >> MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiGen.c | 4 ++-- >> MdeModulePkg/Library/VarCheckHiiLib/VarCheckHiiLibNullClass.c | 2 +- >> MdeModulePkg/Logo/Logo.c | 2 +- >> MdeModulePkg/Universal/BdsDxe/BdsEntry.c | 2 +- >> MdeModulePkg/Universal/DisplayEngineDxe/FormDisplay.c | 4 ++-- >> MdeModulePkg/Universal/DisplayEngineDxe/InputHandler.c | 6 +++--- >> MdeModulePkg/Universal/EbcDxe/EbcExecute.c | 2 +- >> MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Output.c | 2 +- >> MdeModulePkg/Universal/RegularExpressionDxe/RegularExpressionDxe.h | 2 -- >> MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c | 2 +- >> MdePkg/Include/Base.h | 13 +++++++++++++ >> NetworkPkg/Application/IpsecConfig/IpSecConfig.h | 2 -- >> NetworkPkg/IScsiDxe/IScsiConfig.c | 4 ++-- >> NetworkPkg/IScsiDxe/IScsiDriver.c | 2 +- >> NetworkPkg/IScsiDxe/IScsiMisc.c | 6 +++--- >> NetworkPkg/TcpDxe/TcpOutput.c | 2 +- >> Nt32Pkg/WinNtSerialIoDxe/WinNtSerialIo.c | 2 +- >> OptionRomPkg/AtapiPassThruDxe/AtapiPassThru.c | 4 ++-- >> OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.c | 5 ----- >> OvmfPkg/Library/QemuBootOrderLib/QemuBootOrderLib.c | 12 ++++++------ >> OvmfPkg/QemuVideoDxe/Initialize.c | 4 ++-- >> OvmfPkg/XenBusDxe/XenStore.c | 1 - >> PerformancePkg/Dp_App/Dp.c | 2 +- >> PerformancePkg/Dp_App/DpTrace.c | 10 +++++----- >> SecurityPkg/Library/AuthVariableLib/AuthVariableLib.c | 4 ++-- >> ShellPkg/Library/UefiDpLib/DpTrace.c | 10 +++++----- >> ShellPkg/Library/UefiShellLevel2CommandsLib/TimeDate.c | 2 +- >> Vlv2TbltDevicePkg/Application/FirmwareUpdate/FirmwareUpdate.c | 2 +- >> Vlv2TbltDevicePkg/PlatformInitPei/FlashMap.c | 2 +- >> Vlv2TbltDevicePkg/PlatformPei/BootMode.c | 6 +++--- >> Vlv2TbltDevicePkg/PlatformSetupDxe/SetupInfoRecords.c | 2 +- >> Vlv2TbltDevicePkg/SmBiosMiscDxe/MiscOemType0x94Function.c | 2 +- >> 65 files changed, 131 insertions(+), 128 deletions(-) >> >> -- >> 2.9.2 >> > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel >