From nobody Mon Feb 9 16:35:10 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+84676+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+84676+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1639383297; cv=none; d=zohomail.com; s=zohoarc; b=OkGSDa4sT3Jm7gAF3YjWas7DjUfLYXiN/PQF4zULdddhp3Q5seonmeRyCqCAZymggaUXTATLbQRXJLOeOxH6BTuZUW62v6MzIEKsI+lDdIokdkiCV2ZxUDRzWMmSfUWrIrHGTEW4+8YR8i/QSbBYX723NXeQpo3LxS2lCzfJWhU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1639383297; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=Q88C6cV6//7epSb6jvRhs/+1nMvIcbeN+LV0C75dlIQ=; b=mC+BBTdAemT2gaET22XPO5g8XRFzCr457e2i2nRGUesS1PUPlHPki+Qvh/JkxkU1tntx88NScWjhdIVGdW/7LNrB1ilfb8YUtMEXqOnlgDn6Tg0ctnHA7/+BfKE1tCfm8voT2p+bP4OFgJ3ibNvGYcJj9VshiAxzB2zVHmYZJHE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+84676+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1639383297092886.9073870757761; Mon, 13 Dec 2021 00:14:57 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id qEilYY1788612xHPcFyEDjnW; Mon, 13 Dec 2021 00:14:56 -0800 X-Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.groups.io with SMTP id smtpd.web09.8722.1639383295468547366 for ; Mon, 13 Dec 2021 00:14:55 -0800 X-Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-333-kFZgsPC8PGaa7jbJO6IgMw-1; Mon, 13 Dec 2021 03:14:51 -0500 X-MC-Unique: kFZgsPC8PGaa7jbJO6IgMw-1 X-Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id A61CE64083; Mon, 13 Dec 2021 08:14:49 +0000 (UTC) X-Received: from sirius.home.kraxel.org (unknown [10.39.192.14]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9C13513AB3; Mon, 13 Dec 2021 08:14:45 +0000 (UTC) X-Received: by sirius.home.kraxel.org (Postfix, from userid 1000) id 2BE4A1800609; Mon, 13 Dec 2021 09:14:43 +0100 (CET) From: "Gerd Hoffmann" To: devel@edk2.groups.io Cc: Michael D Kinney , dovmurik@linux.ibm.com, Jiewen Yao , Liming Gao , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Gerd Hoffmann , Ard Biesheuvel , Sean Brogan , Jordan Justen , Pawel Polawski , Bret Barkelew , Jiewen Yao , Ard Biesheuvel Subject: [edk2-devel] [PATCH v4 1/7] OvmfPkg/PlatformCI: factor out PlatformBuildLib.py Date: Mon, 13 Dec 2021 09:14:37 +0100 Message-Id: <20211213081443.3534714-2-kraxel@redhat.com> In-Reply-To: <20211213081443.3534714-1-kraxel@redhat.com> References: <20211213081443.3534714-1-kraxel@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,kraxel@redhat.com X-Gm-Message-State: OaGU8xnT2ynX4SY7Tr8xjaxCx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1639383296; bh=mSZsoYom7bAnojub7fZz8Bgvka0w/w4pJbNvdG3qMT8=; h=Cc:Content-Type:Date:From:Reply-To:Subject:To; b=S/WqC/bNhNPp/AT0JbkxcH0P6m7+uvWhVyMc9d325bU3vXVseewqvC6TRksNmBtvL1q tq4hxkJQEYIZbwk+Uv6D00Cu+/L8oIa8wXKgcclzoMPeq6LFWe4ZiradIomXFCXtwBRsd 6GOTjuVCX9B4YmboTeuse4FMFgsA0YxRw9s= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1639383299371100002 Content-Type: text/plain; charset="utf-8" Move SettingsManager and PlatformBuilder classes to PlatformBuildLib.py file, keep only CommonPlatform class in PlatformBuild.py. Allows reusing these classes for other builds. Pure code motion, no functional change. Signed-off-by: Gerd Hoffmann Acked-by: Jiewen Yao Acked-by: Ard Biesheuvel --- OvmfPkg/PlatformCI/PlatformBuild.py | 223 +----------------- .../{PlatformBuild.py =3D> PlatformBuildLib.py} | 32 --- 2 files changed, 6 insertions(+), 249 deletions(-) copy OvmfPkg/PlatformCI/{PlatformBuild.py =3D> PlatformBuildLib.py} (87%) diff --git a/OvmfPkg/PlatformCI/PlatformBuild.py b/OvmfPkg/PlatformCI/Platf= ormBuild.py index 627bb7b992db..6c541cdea4a5 100644 --- a/OvmfPkg/PlatformCI/PlatformBuild.py +++ b/OvmfPkg/PlatformCI/PlatformBuild.py @@ -5,17 +5,11 @@ # SPDX-License-Identifier: BSD-2-Clause-Patent ## import os -import logging -import io - -from edk2toolext.environment import shell_environment -from edk2toolext.environment.uefi_build import UefiBuilder -from edk2toolext.invocables.edk2_platform_build import BuildSettingsManager -from edk2toolext.invocables.edk2_setup import SetupSettingsManager, Requir= edSubmodule -from edk2toolext.invocables.edk2_update import UpdateSettingsManager -from edk2toolext.invocables.edk2_pr_eval import PrEvalSettingsManager -from edk2toollib.utility_functions import RunCmd +import sys =20 +sys.path.append(os.path.dirname(os.path.abspath(__file__))) +from PlatformBuildLib import SettingsManager +from PlatformBuildLib import PlatformBuilder =20 # ####################################################################= ################### # # Common Configuration = # @@ -45,210 +39,5 @@ class CommonPlatform(): dsc +=3D ".dsc" return dsc =20 - - # ####################################################################= ################### # - # Configuration for Update & Setup = # - # ####################################################################= ################### # -class SettingsManager(UpdateSettingsManager, SetupSettingsManager, PrEvalS= ettingsManager): - - def GetPackagesSupported(self): - ''' return iterable of edk2 packages supported by this build. - These should be edk2 workspace relative paths ''' - return CommonPlatform.PackagesSupported - - def GetArchitecturesSupported(self): - ''' return iterable of edk2 architectures supported by this build = ''' - return CommonPlatform.ArchSupported - - def GetTargetsSupported(self): - ''' return iterable of edk2 target tags supported by this build ''' - return CommonPlatform.TargetsSupported - - def GetRequiredSubmodules(self): - ''' return iterable containing RequiredSubmodule objects. - If no RequiredSubmodules return an empty iterable - ''' - rs =3D [] - - # intentionally declare this one with recursive false to avoid ove= rhead - rs.append(RequiredSubmodule( - "CryptoPkg/Library/OpensslLib/openssl", False)) - - # To avoid maintenance of this file for every new submodule - # lets just parse the .gitmodules and add each if not already in l= ist. - # The GetRequiredSubmodules is designed to allow a build to optimi= ze - # the desired submodules but it isn't necessary for this repositor= y. - result =3D io.StringIO() - ret =3D RunCmd("git", "config --file .gitmodules --get-regexp path= ", workingdir=3Dself.GetWorkspaceRoot(), outstream=3Dresult) - # Cmd output is expected to look like: - # submodule.CryptoPkg/Library/OpensslLib/openssl.path CryptoPkg/Li= brary/OpensslLib/openssl - # submodule.SoftFloat.path ArmPkg/Library/ArmSoftFloatLib/berkeley= -softfloat-3 - if ret =3D=3D 0: - for line in result.getvalue().splitlines(): - _, _, path =3D line.partition(" ") - if path is not None: - if path not in [x.path for x in rs]: - rs.append(RequiredSubmodule(path, True)) # add it = with recursive since we don't know - return rs - - def SetArchitectures(self, list_of_requested_architectures): - ''' Confirm the requests architecture list is valid and configure = SettingsManager - to run only the requested architectures. - - Raise Exception if a list_of_requested_architectures is not suppor= ted - ''' - unsupported =3D set(list_of_requested_architectures) - set(self.Ge= tArchitecturesSupported()) - if(len(unsupported) > 0): - errorString =3D ( "Unsupported Architecture Requested: " + " "= .join(unsupported)) - logging.critical( errorString ) - raise Exception( errorString ) - self.ActualArchitectures =3D list_of_requested_architectures - - def GetWorkspaceRoot(self): - ''' get WorkspacePath ''' - return CommonPlatform.WorkspaceRoot - - def GetActiveScopes(self): - ''' return tuple containing scopes that should be active for this = process ''' - return CommonPlatform.Scopes - - def FilterPackagesToTest(self, changedFilesList: list, potentialPackag= esList: list) -> list: - ''' Filter other cases that this package should be built - based on changed files. This should cover things that can't - be detected as dependencies. ''' - build_these_packages =3D [] - possible_packages =3D potentialPackagesList.copy() - for f in changedFilesList: - # BaseTools files that might change the build - if "BaseTools" in f: - if os.path.splitext(f) not in [".txt", ".md"]: - build_these_packages =3D possible_packages - break - - # if the azure pipeline platform template file changed - if "platform-build-run-steps.yml" in f: - build_these_packages =3D possible_packages - break - - return build_these_packages - - def GetPlatformDscAndConfig(self) -> tuple: - ''' If a platform desires to provide its DSC then Policy 4 will ev= aluate if - any of the changes will be built in the dsc. - - The tuple should be (, ) - ''' - dsc =3D CommonPlatform.GetDscName(",".join(self.ActualArchitecture= s)) - return (f"OvmfPkg/{dsc}", {}) - - - # ####################################################################= ################### # - # Actual Configuration for Platform Build = # - # ####################################################################= ################### # -class PlatformBuilder( UefiBuilder, BuildSettingsManager): - def __init__(self): - UefiBuilder.__init__(self) - - def AddCommandLineOptions(self, parserObj): - ''' Add command line options to the argparser ''' - parserObj.add_argument('-a', "--arch", dest=3D"build_arch", type= =3Dstr, default=3D"IA32,X64", - help=3D"Optional - CSV of architecture to build. IA32 will us= e IA32 for Pei & Dxe. " - "X64 will use X64 for both PEI and DXE. IA32,X64 will use IA3= 2 for PEI and " - "X64 for DXE. default is IA32,X64") - - def RetrieveCommandLineOptions(self, args): - ''' Retrieve command line options from the argparser ''' - - shell_environment.GetBuildVars().SetValue("TARGET_ARCH"," ".join(a= rgs.build_arch.upper().split(",")), "From CmdLine") - dsc =3D CommonPlatform.GetDscName(args.build_arch) - shell_environment.GetBuildVars().SetValue("ACTIVE_PLATFORM", f"Ovm= fPkg/{dsc}", "From CmdLine") - - def GetWorkspaceRoot(self): - ''' get WorkspacePath ''' - return CommonPlatform.WorkspaceRoot - - def GetPackagesPath(self): - ''' Return a list of workspace relative paths that should be mappe= d as edk2 PackagesPath ''' - return () - - def GetActiveScopes(self): - ''' return tuple containing scopes that should be active for this = process ''' - return CommonPlatform.Scopes - - def GetName(self): - ''' Get the name of the repo, platform, or product being build ''' - ''' Used for naming the log file, among others ''' - # check the startup nsh flag and if set then rename the log file. - # this helps in CI so we don't overwrite the build log since runni= ng - # uses the stuart_build command. - if(shell_environment.GetBuildVars().GetValue("MAKE_STARTUP_NSH", "= FALSE") =3D=3D "TRUE"): - return "OvmfPkg_With_Run" - return "OvmfPkg" - - def GetLoggingLevel(self, loggerType): - ''' Get the logging level for a given type - base =3D=3D lowest logging level supported - con =3D=3D Screen logging - txt =3D=3D plain text file logging - md =3D=3D markdown file logging - ''' - return logging.DEBUG - - def SetPlatformEnv(self): - logging.debug("PlatformBuilder SetPlatformEnv") - self.env.SetValue("PRODUCT_NAME", "OVMF", "Platform Hardcoded") - self.env.SetValue("MAKE_STARTUP_NSH", "FALSE", "Default to false") - self.env.SetValue("QEMU_HEADLESS", "FALSE", "Default to false") - return 0 - - def PlatformPreBuild(self): - return 0 - - def PlatformPostBuild(self): - return 0 - - def FlashRomImage(self): - VirtualDrive =3D os.path.join(self.env.GetValue("BUILD_OUTPUT_BASE= "), "VirtualDrive") - os.makedirs(VirtualDrive, exist_ok=3DTrue) - OutputPath_FV =3D os.path.join(self.env.GetValue("BUILD_OUTPUT_BAS= E"), "FV") - - # - # QEMU must be on the path - # - cmd =3D "qemu-system-x86_64" - args =3D "-debugcon stdio" = # write messages to stdio - args +=3D " -global isa-debugcon.iobase=3D0x402" = # debug messages out thru virtual io port - args +=3D " -net none" = # turn off network - args +=3D f" -drive file=3Dfat:rw:{VirtualDrive},format=3Draw,medi= a=3Ddisk" # Mount disk with startup.nsh - - if (self.env.GetValue("QEMU_HEADLESS").upper() =3D=3D "TRUE"): - args +=3D " -display none" # no graphics - - if (self.env.GetBuildValue("SMM_REQUIRE") =3D=3D "1"): - args +=3D " -machine q35,smm=3Don" #,accel=3D(tcg|kvm)" - #args +=3D " -m ..." - #args +=3D " -smp ..." - args +=3D " -global driver=3Dcfi.pflash01,property=3Dsecure,va= lue=3Don" - args +=3D " -drive if=3Dpflash,format=3Draw,unit=3D0,file=3D" = + os.path.join(OutputPath_FV, "OVMF_CODE.fd") + ",readonly=3Don" - args +=3D " -drive if=3Dpflash,format=3Draw,unit=3D1,file=3D" = + os.path.join(OutputPath_FV, "OVMF_VARS.fd") - else: - args +=3D " -pflash " + os.path.join(OutputPath_FV, "OVMF.fd")= # path to firmware - - - if (self.env.GetValue("MAKE_STARTUP_NSH").upper() =3D=3D "TRUE"): - f =3D open(os.path.join(VirtualDrive, "startup.nsh"), "w") - f.write("BOOT SUCCESS !!! \n") - ## add commands here - f.write("reset -s\n") - f.close() - - ret =3D RunCmd(cmd, args) - - if ret =3D=3D 0xc0000005: - #for some reason getting a c0000005 on successful return - return 0 - - return ret - - - +import PlatformBuildLib +PlatformBuildLib.CommonPlatform =3D CommonPlatform diff --git a/OvmfPkg/PlatformCI/PlatformBuild.py b/OvmfPkg/PlatformCI/Platf= ormBuildLib.py similarity index 87% copy from OvmfPkg/PlatformCI/PlatformBuild.py copy to OvmfPkg/PlatformCI/PlatformBuildLib.py index 627bb7b992db..90ac0b29a892 100644 --- a/OvmfPkg/PlatformCI/PlatformBuild.py +++ b/OvmfPkg/PlatformCI/PlatformBuildLib.py @@ -17,35 +17,6 @@ from edk2toolext.invocables.edk2_pr_eval import PrEvalSe= ttingsManager from edk2toollib.utility_functions import RunCmd =20 =20 - # ####################################################################= ################### # - # Common Configuration = # - # ####################################################################= ################### # -class CommonPlatform(): - ''' Common settings for this platform. Define static data here and use - for the different parts of stuart - ''' - PackagesSupported =3D ("OvmfPkg",) - ArchSupported =3D ("IA32", "X64") - TargetsSupported =3D ("DEBUG", "RELEASE", "NOOPT") - Scopes =3D ('ovmf', 'edk2-build') - WorkspaceRoot =3D os.path.realpath(os.path.join( - os.path.dirname(os.path.abspath(__file__)), "..", "..")) - - @classmethod - def GetDscName(cls, ArchCsv: str) -> str: - ''' return the DSC given the architectures requested. - - ArchCsv: csv string containing all architectures to build - ''' - dsc =3D "OvmfPkg" - if "IA32" in ArchCsv.upper().split(","): - dsc +=3D "Ia32" - if "X64" in ArchCsv.upper().split(","): - dsc +=3D "X64" - dsc +=3D ".dsc" - return dsc - - # ####################################################################= ################### # # Configuration for Update & Setup = # # ####################################################################= ################### # @@ -249,6 +220,3 @@ class PlatformBuilder( UefiBuilder, BuildSettingsManage= r): return 0 =20 return ret - - - --=20 2.33.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#84676): https://edk2.groups.io/g/devel/message/84676 Mute This Topic: https://groups.io/mt/87693631/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-