From: Sean Brogan <sean.bro...@microsoft.com>
REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2570
Add new Azure Pipeline definitions to build and run OvmfPkg with:
* Ubuntu GCC5
* Windows VS2019
Add PyTool based build of OvmfPkg
Add extdep for managing the iasl dependency
Add OvmfPkg.ci.yaml for Core CI
Add README-pytools for details and instructions
Cc: Jordan Justen <jordan.l.jus...@intel.com>
Cc: Laszlo Ersek <ler...@redhat.com>
Cc: Ard Biesheuvel <ard.biesheu...@arm.com>
Signed-off-by: Sean Brogan <sean.bro...@microsoft.com>
---
OvmfPkg/.azurepipelines/Ubuntu-GCC5.yml | 133 +++++++++++
OvmfPkg/.azurepipelines/Windows-VS2019.yml | 138 +++++++++++
OvmfPkg/OvmfPkg.ci.yaml | 83 +++++++
OvmfPkg/PlatformBuild.py | 242 ++++++++++++++++++++
OvmfPkg/README-pytools.md | 238 +++++++++++++++++++
OvmfPkg/iasl_ext_dep.yaml | 21 ++
6 files changed, 855 insertions(+)
diff --git a/OvmfPkg/.azurepipelines/Ubuntu-GCC5.yml
b/OvmfPkg/.azurepipelines/Ubuntu-GCC5.yml
new file mode 100644
index 000000000000..c2da388aba78
--- /dev/null
+++ b/OvmfPkg/.azurepipelines/Ubuntu-GCC5.yml
@@ -0,0 +1,133 @@
+## @file
+# Azure Pipeline build file for building a platform.
+#
+# Platform: OVMF
+# OS: Ubuntu
+# Toolchain: GCC5
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+trigger:
+ - master
+pr:
+ - master
+
+jobs:
+ - job: Platform_CI
+ variables:
+ package: 'OvmfPkg'
+ vm_image: 'ubuntu-latest'
+ should_run: true
+ run_flags: "MAKE_STARTUP_NSH=TRUE QEMU_HEADLESS=TRUE"
+
+ #Use matrix to speed up the build process
+ strategy:
+ matrix:
+ OVMF_IA32_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+
+ OVMF_X64_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_X64_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_X64_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+
+ OVMF_IA32X64_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32X64_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32X64_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+
+ OVMF_IA32X64_FULL_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=1 BLD_*_SMM_REQUIRE=1
BLD_*_TPM_ENABLE=1 BLD_*_TPM_CONFIG_ENABLE=1 BLD_*_NETWORK_TLS_ENABLE=1
BLD_*_NETWORK_IP6_ENABLE=1 BLD_*_NETWORK_HTTP_BOOT_ENABLE=1"
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32X64_FULL_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=1 BLD_*_SMM_REQUIRE=1
BLD_*_TPM_ENABLE=1 BLD_*_TPM_CONFIG_ENABLE=1 BLD_*_NETWORK_TLS_ENABLE=1
BLD_*_NETWORK_IP6_ENABLE=1 BLD_*_NETWORK_HTTP_BOOT_ENABLE=1"
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32X64_FULL_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=1 BLD_*_SMM_REQUIRE=1
BLD_*_TPM_ENABLE=1 BLD_*_TPM_CONFIG_ENABLE=1 BLD_*_NETWORK_TLS_ENABLE=1
BLD_*_NETWORK_IP6_ENABLE=1 BLD_*_NETWORK_HTTP_BOOT_ENABLE=1"
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ workspace:
+ clean: all
+
+ pool:
+ vmImage: $(vm_image)
+
+ steps:
+ - template: ../../.azurepipelines/templates/platform-build-run-steps.yml
+ parameters:
+ tool_chain_tag: GCC5
+ build_pkg: $(package)
+ build_target: $(Build.Target)
+ build_arch: $(Build.Arch)
+ build_file: $(Build.File)
+ build_flags: $(Build.Flags)
+ run_flags: $(Run.Flags)
+ extra_install_step:
+ - bash: sudo apt-get install qemu
+ displayName: Install qemu
+ condition: and(gt(variables.pkg_count, 0), succeeded())
diff --git a/OvmfPkg/.azurepipelines/Windows-VS2019.yml
b/OvmfPkg/.azurepipelines/Windows-VS2019.yml
new file mode 100644
index 000000000000..0de24017a2a6
--- /dev/null
+++ b/OvmfPkg/.azurepipelines/Windows-VS2019.yml
@@ -0,0 +1,138 @@
+## @file
+# Azure Pipeline build file for building a platform.
+#
+# Platform: OVMF
+# OS: Windows
+# Toolchain: VS2019
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+trigger:
+ - master
+pr:
+ - master
+jobs:
+ - job: Platform_CI
+ variables:
+ package: 'OvmfPkg'
+ vm_image: 'windows-latest'
+ should_run: true
+ run_flags: "MAKE_STARTUP_NSH=TRUE QEMU_HEADLESS=TRUE"
+
+ #Use matrix to speed up the build process
+ strategy:
+ matrix:
+ OVMF_IA32_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+
+ OVMF_X64_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_X64_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_X64_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+
+ OVMF_IA32X64_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32X64_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32X64_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+
+ OVMF_IA32X64_FULL_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=1 BLD_*_SMM_REQUIRE=1
BLD_*_TPM_ENABLE=1 BLD_*_TPM_CONFIG_ENABLE=1 BLD_*_NETWORK_TLS_ENABLE=1
BLD_*_NETWORK_IP6_ENABLE=1 BLD_*_NETWORK_HTTP_BOOT_ENABLE=1"
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ OVMF_IA32X64_FULL_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32,X64"
+ Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=1 BLD_*_SMM_REQUIRE=1
BLD_*_TPM_ENABLE=1 BLD_*_TPM_CONFIG_ENABLE=1 BLD_*_NETWORK_TLS_ENABLE=1
BLD_*_NETWORK_IP6_ENABLE=1 BLD_*_NETWORK_HTTP_BOOT_ENABLE=1"
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+
+ # This currently creates a very large image which is too big for the FDF
declared range
+ # Ovmf maintainers suggest to skip this build for now.
+ #
+ # OVMF_IA32X64_FULL_NOOPT:
+ # Build.File: "$(package)/PlatformBuild.py"
+ # Build.Arch: "IA32,X64"
+ # Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=1 BLD_*_SMM_REQUIRE=1
BLD_*_TPM_ENABLE=1 BLD_*_TPM_CONFIG_ENABLE=1 BLD_*_NETWORK_TLS_ENABLE=1
BLD_*_NETWORK_IP6_ENABLE=1 BLD_*_NETWORK_HTTP_BOOT_ENABLE=1"
+ # Build.Target: "NOOPT"
+ # Run.Flags: $(run_flags)
+ # Run: $(should_run)
+
+ workspace:
+ clean: all
+
+ pool:
+ vmImage: $(vm_image)
+
+ steps:
+ - template: ../../.azurepipelines/templates/platform-build-run-steps.yml
+ parameters:
+ tool_chain_tag: VS2019
+ build_pkg: $(package)
+ build_target: $(Build.Target)
+ build_arch: $(Build.Arch)
+ build_file: $(Build.File)
+ build_flags: $(Build.Flags)
+ run_flags: $(Run.Flags)
+ extra_install_step:
+ - powershell: choco install qemu; Write-Host
"##vso[task.prependpath]c:\Program Files\qemu"
+ displayName: Install QEMU and Set QEMU on path # friendly name
displayed in the UI
+ condition: and(gt(variables.pkg_count, 0), succeeded())
+
diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml
new file mode 100644
index 000000000000..98992f0429ff
--- /dev/null
+++ b/OvmfPkg/OvmfPkg.ci.yaml
@@ -0,0 +1,83 @@
+## @file
+# Core CI configuration for OvmfPkg
+#
+# OvmfPkg is part of Platform Ci for builds so this is only
+# used for code analysis.
+#
+# Copyright (c) Microsoft Corporation
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+{
+ ## options defined .pytool/Plugin/CompilerPlugin
+ "CompilerPlugin": {
+ "DscPath": "" # Don't support this test
+ },
+
+ ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin
+ "HostUnitTestCompilerPlugin": {
+ "DscPath": "" # Don't support this test
+ },
+
+ ## options defined .pytool/Plugin/CharEncodingCheck
+ "CharEncodingCheck": {
+ "IgnoreFiles": []
+ },
+
+ ## options defined .pytool/Plugin/DependencyCheck
+ "DependencyCheck": {
+ "AcceptableDependencies": [
+ "MdePkg/MdePkg.dec",
+ "MdeModulePkg/MdeModulePkg.dec",
+ "OvmfPkg/OvmfPkg.dec",
+ "NetworkPkg/NetworkPkg.dec",
+ "SecurityPkg/SecurityPkg.dec",
+ "UefiCpuPkg/UefiCpuPkg.dec",
+ "ShellPkg/ShellPkg.dec",
+ "EmbeddedPkg/EmbeddedPkg.dec",
+ "SourceLevelDebugPkg/SourceLevelDebugPkg.dec"
+ ],
+ # For host based unit tests
+ "AcceptableDependencies-HOST_APPLICATION":[
+ "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
+ ],
+ # For UEFI shell based apps
+ "AcceptableDependencies-UEFI_APPLICATION":[],
+ "IgnoreInf": []
+ },
+
+ ## options defined .pytool/Plugin/DscCompleteCheck
+ "DscCompleteCheck": {
+ "IgnoreInf": [""],
+ "DscPath": "" # Don't support this test
+ },
+
+ ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck
+ "HostUnitTestDscCompleteCheck": {
+ "IgnoreInf": [""],
+ "DscPath": "" # Don't support this test
+ },
+
+ ## options defined .pytool/Plugin/GuidCheck
+ "GuidCheck": {
+ "IgnoreGuidName": ["ResetVector", "XenResetVector"], # Expected
duplication for gEfiFirmwareVolumeTopFileGuid
+ "IgnoreGuidValue": [],
+ "IgnoreFoldersAndFiles": [],
+ "IgnoreDuplicates": [],
+ },
+
+ ## options defined .pytool/Plugin/LibraryClassCheck
+ "LibraryClassCheck": {
+ "IgnoreHeaderFile": []
+ },
+
+ ## options defined .pytool/Plugin/SpellCheck
+ "SpellCheck": {
+ "AuditOnly": True, # Fails right now with over 270 errors
+ "IgnoreFiles": [], # use gitignore syntax to ignore errors
in matching files
+ "ExtendWords": [
+
+ ], # words to extend to the dictionary for this package
+ "IgnoreStandardPaths": [], # Standard Plugin defined paths that
should be ignore
+ "AdditionalIncludePaths": [] # Additional paths to spell check
(wildcards supported)
+ }
+}
diff --git a/OvmfPkg/PlatformBuild.py b/OvmfPkg/PlatformBuild.py
new file mode 100644
index 000000000000..bd7b342b6c00
--- /dev/null
+++ b/OvmfPkg/PlatformBuild.py
@@ -0,0 +1,242 @@
+# @file
+# Script to Build OVMF UEFI firmware
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+import os
+import logging
+
+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,
RequiredSubmodule
+from edk2toolext.invocables.edk2_update import UpdateSettingsManager
+from edk2toolext.invocables.edk2_pr_eval import PrEvalSettingsManager
+from edk2toollib.utility_functions import RunCmd
+
+
+ #
#######################################################################################
#
+ # Common Configuration
#
+ #
#######################################################################################
#
+class CommonPlatform():
+ ''' Common settings for this platform. Define static data here and use
+ for the different parts of stuart
+ '''
+ PackagesSupported = ("OvmfPkg",)
+ ArchSupported = ("IA32", "X64")
+ TargetsSupported = ("DEBUG", "RELEASE", "NOOPT")
+ Scopes = ('ovmf', 'edk2-build')
+ WorkspaceRoot = 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 = "OvmfPkg"
+ if "IA32" in ArchCsv.upper().split(","):
+ dsc += "Ia32"
+ if "X64" in ArchCsv.upper().split(","):
+ dsc += "X64"
+ dsc += ".dsc"
+ return dsc
+
+
+ #
#######################################################################################
#
+ # Configuration for Update & Setup
#
+ #
#######################################################################################
#
+class SettingsManager(UpdateSettingsManager, SetupSettingsManager,
PrEvalSettingsManager):
+
+ 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 = []
+ rs.append(RequiredSubmodule(
+ "ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3", False))
+ rs.append(RequiredSubmodule(
+ "CryptoPkg/Library/OpensslLib/openssl", False))
+ 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 supported
+ '''
+ unsupported = set(list_of_requested_architectures) -
set(self.GetArchitecturesSupported())
+ if(len(unsupported) > 0):
+ errorString = ( "Unsupported Architecture Requested: " + "
".join(unsupported))
+ logging.critical( errorString )
+ raise Exception( errorString )
+ self.ActualArchitectures = 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,
potentialPackagesList: 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 = []
+ possible_packages = 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 = possible_packages
+ break
+
+ # if the azure pipeline file changed
+ if ".azurepipelines" in f and "Ovmf" in f:
+ build_these_packages = possible_packages
+ break
+
+ # if the azure pipeline platform template file changed
+ if ".azurepipelines" in f and "platforms" in f and "templates" in
f:
+ build_these_packages = possible_packages
+ break
+
+ return build_these_packages
+
+ def GetPlatformDscAndConfig(self) -> tuple:
+ ''' If a platform desires to provide its DSC then Policy 4 will
evaluate if
+ any of the changes will be built in the dsc.
+
+ The tuple should be (<workspace relative path to dsc file>, <input
dictionary of dsc key value pairs>)
+ '''
+ dsc = CommonPlatform.GetDscName(",".join(self.ActualArchitectures))
+ 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="build_arch", type=str,
default="IA32,X64",
+ help="Optional - CSV of architecture to build. IA32 will use IA32
for Pei & Dxe. "
+ "X64 will use X64 for both PEI and DXE. IA32,X64 will use IA32
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(args.build_arch.upper().split(",")), "From CmdLine")
+ dsc = CommonPlatform.GetDscName(args.build_arch)
+ shell_environment.GetBuildVars().SetValue("ACTIVE_PLATFORM",
f"OvmfPkg/{dsc}", "From CmdLine")
+
+ def GetWorkspaceRoot(self):
+ ''' get WorkspacePath '''
+ return CommonPlatform.WorkspaceRoot
+
+ def GetPackagesPath(self):
+ ''' Return a list of workspace relative paths that should be mapped 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 running
+ # uses the stuart_build command.
+ if(shell_environment.GetBuildVars().GetValue("MAKE_STARTUP_NSH",
"FALSE") == "TRUE"):
+ return "OvmfPkg_With_Run"
+ return "OvmfPkg"
+
+ def GetLoggingLevel(self, loggerType):
+ ''' Get the logging level for a given type
+ base == lowest logging level supported
+ con == Screen logging
+ txt == plain text file logging
+ md == 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 = os.path.join(self.env.GetValue("BUILD_OUTPUT_BASE"),
"VirtualDrive")
+ os.makedirs(VirtualDrive, exist_ok=True)
+ OutputPath_FV = os.path.join(self.env.GetValue("BUILD_OUTPUT_BASE"),
"FV")
+
+ #
+ # QEMU must be on the path
+ #
+ cmd = "qemu-system-x86_64"
+ args = "-debugcon stdio" #
write messages to stdio
+ args += " -global isa-debugcon.iobase=0x402" #
debug messages out thru virtual io port
+ args += " -net none" #
turn off network
+ args += f" -drive file=fat:rw:{VirtualDrive},format=raw,media=disk" #
Mount disk with startup.nsh
+
+ if (self.env.GetValue("QEMU_HEADLESS").upper() == "TRUE"):
+ args += " -display none" # no graphics
+
+ if (self.env.GetBuildValue("SMM_REQUIRE") == "1"):
+ args += " -machine q35,smm=on" #,accel=(tcg|kvm)"
+ #args += " -m ..."
+ #args += " -smp ..."
+ args += " -global driver=cfi.pflash01,property=secure,value=on"
+ args += " -drive if=pflash,format=raw,unit=0,file=" +
os.path.join(OutputPath_FV, "OVMF_CODE.fd") + ",readonly=on"
+ args += " -drive if=pflash,format=raw,unit=1,file=" +
os.path.join(OutputPath_FV, "OVMF_VARS.fd")
+ else:
+ args += " -pflash " + os.path.join(OutputPath_FV, "OVMF.fd") #
path to firmware
+
+
+ if (self.env.GetValue("MAKE_STARTUP_NSH").upper() == "TRUE"):
+ f = open(os.path.join(VirtualDrive, "startup.nsh"), "w")
+ f.write("BOOT SUCCESS !!! \n")
+ ## add commands here
+ f.write("reset -s\n")
+ f.close()
+
+ ret = RunCmd(cmd, args)
+
+ if ret == 0xc0000005:
+ #for some reason getting a c0000005 on successful return
+ return 0
+
+ return ret
+
+
+
diff --git a/OvmfPkg/README-pytools.md b/OvmfPkg/README-pytools.md
new file mode 100644
index 000000000000..7d8689bc2336
--- /dev/null
+++ b/OvmfPkg/README-pytools.md
@@ -0,0 +1,238 @@
+# OvmfPkg
+
+This README-pytools.md summarizes the current state of Platform CI for OvmfPkg.
+It also describes how to _build_ OvmfPkg using the Pytools build system.
+For general documentation on OvmfPkg, refer to the [local README](./README).
+
+## Platform CI Current Status
+
+<table>
+ <tr>
+ <th>Config</th>
+ <th colspan="3">Build & Run</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <th></th>
+ <th>DEBUG</th>
+ <th>RELEASE</th>
+ <th>NOOPT</th>
+ <th></th>
+ </tr>
+ <tr>
+ <th colspan="5" align="left">
+ Windows VS2019
+ </th>
+ </tr>
+ <tr>
+ <td>IA32</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_NOOPT"/></a>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>X64</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_NOOPT"/></a>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>IA32X64</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_NOOPT"/></a>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>IA32X64 Full</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=38&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_RELEASE"/></a>
+ </td>
+ <td>
+ Image sizes too large. Skipping
+ </td>
+ <td>NOOPT build out of space in FD</td>
+ </tr>
+ <tr>
+ <th colspan="5" align="left">
+ Ubuntu 18.04 GCC5
+ </th>
+ </tr>
+ <tr>
+ <td>IA32</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32_NOOPT"/></a>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>X64</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_X64_NOOPT"/></a>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>IA32X64</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_NOOPT"/></a>
+ </td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>IA32X64 Full</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=37&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/OVMF/OVMF%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20OVMF_IA32X64_FULL_NOOPT"/></a>
+ </td>
+ <td></td>
+ </tr>
+</table>
+
+### Config Details
+
+| Config | Architectures |Additional Flags |
+| :---- | :----- | :---- |
+| IA32 | IA32 | None |
+| X64 | X64 | None |
+| IA32X64 | PEI: IA32 DXE: X64 | None |
+| IA32X64 FULL | PEI: IA32 DXE: X64 | SECURE_BOOT_ENABLE=1 SMM_REQUIRE=1
TPM_ENABLE=1 TPM_CONFIG_ENABLE=1 NETWORK_TLS_ENABLE=1 NETWORK_IP6_ENABLE=1
NETWORK_HTTP_BOOT_ENABLE=1 |
+
+## Setup
+
+### The Usual EDK2 Build Setup
+
+- [Python 3.8.x - Download & Install](https://www.python.org/downloads/)
+- [GIT - Download & Install](https://git-scm.com/download/)
+- [GIT - Configure for EDK
II](https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems#github-help)
+- [QEMU - Download, Install, and add to your
path](https://www.qemu.org/download/)
+- [EDKII Source - Download/Checkout from
Github](https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems#download)
+ - **NOTE:** Do _not_ follow the EDK II Compile Tools and Build instructions,
see below...
+
+### Differences from EDK Classic Build Setup
+
+- Build BaseTools using "`C:\git\edk2>python BaseTools\Edk2ToolsBuild.py [-t
<ToolChainTag>]`"
+ - This replaces "`edksetup Rebuild`" from the classic build system
+ - For Windows `<ToolChainTag>` examples, refer to [Windows ToolChain
Matrix](https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems-ToolChain-Matrix),
defaults to `VS2017` if not specified
+- **No Action:** Submodule initialization and manual installation/setup of
NASM and iASL is **not** required, it is handled by the Pytools build system
+
+### Install & Configure Pytools for OvmfPkg
+
+- Install Pytools
+ - `pip install --upgrade -r pip-requirements.txt`
+- Initialize & Update Submodules
+ - `stuart_setup -c OvmfPkg\PlatformBuild.py`
+- Initialize & Update Dependencies (e.g. iASL & NASM)
+ - `stuart_update -c OvmfPkg\PlatformBuild.py`
+
+## Building
+
+OVMF has [3
versions](https://github.com/tianocore/tianocore.github.io/wiki/How-to-build-OVMF#choosing-which-version-of-ovmf-to-build).
To build them using Pytools:
+
+First set the `TOOL_CHAIN_TAG` via environment variable, Conf/target.txt, or
pass it on the command-lines below using "`TOOL_CHAIN_TAG=<value>`" syntax.
+
+| Platform | Commandline
|
+| ------------------ |
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
+| OvmfPkgIa32X64.dsc | `stuart_build -c OvmfPkg\PlatformBuild.py
[TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>]`<BR>**OR**<BR>`stuart_build -c
OvmfPkg\PlatformBuild.py -a IA32,X64 [TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>]` |
+| OvmfPkgIa32.dsc | `stuart_build -c OvmfPkg\PlatformBuild.py -a IA32
[TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>]`
|
+| OvmfPkgX64.dsc | `stuart_build -c OvmfPkg\PlatformBuild.py -a X64
[TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>]`
|
+
+**NOTE:** configuring ACTIVE*PLATFORM and TARGET_ARCH in Conf/target.txt is
*not* required. This environment is set by PlatformBuild.py based upon the
"`[-a <TARGET_ARCH>]`" parameter.
+
+### Custom Build Options
+
+**MAKE_STARTUP_NSH=TRUE** will output a _startup.nsh_ file to the location
mapped as fs0. This is used in CI in combination with the --FlashOnly feature
to run QEMU to the UEFI shell and then execute the contents of startup.nsh.
+
+**QEMU_HEADLESS=TRUE** Since CI servers run headless QEMU must be told to run
with no display otherwise an error occurs. Locally you don't need to set this.
+
+### Passing Build Defines
+
+To pass build defines through stuart*build, prepend `BLD_*_`to the define name
and pass it on the commandline. stuart_build currently requires values to be
assigned, so add an `=1` suffix for bare defines.
+For example, to enable the Intel E1000 NIC, instead of the traditional "-D
E1000_ENABLE", the stuart_build command-line would be:
+
+`stuart_build -c OvmfPkg/PlatformBuild.py BLD_*_E1000_ENABLE=1`
+
+## Running QEMU Emulator
+
+QEMU can be automatically launched using stuart_build. This makes path
management and quick verification easy.
+QEMU must be added to your path. On Windows this is a manual process and not
part of the QEMU installer.
+
+1. To run as part of the build but after building add the `--FlashRom`
parameter.
+2. To run after the build process standalone use your build command mentioned
above plus `--FlashOnly`.
+
+**NOTE:** Logging the execution output will be in the normal stuart log as
well as to your console.
+
+## References
+
+- [Installing
Pytools](https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/using.md#installing)
+- For each workspace, consider creating & using a [Python Virtual
Environment](https://docs.python.org/3/library/venv.html). For example
<https://microsoft.github.io/mu/CodeDevelopment/prerequisites/#workspace-virtual-environment-setup-process>
+- [stuart_build commandline
parser](https://github.com/tianocore/edk2-pytool-extensions/blob/56f6a7aee09995c2f22da4765e8b0a29c1cbf5de/edk2toolext/edk2_invocable.py#L109)
diff --git a/OvmfPkg/iasl_ext_dep.yaml b/OvmfPkg/iasl_ext_dep.yaml
new file mode 100644
index 000000000000..cbee0e5a5a92
--- /dev/null
+++ b/OvmfPkg/iasl_ext_dep.yaml
@@ -0,0 +1,21 @@
+## @file
+# Download iasl executable tool from a nuget.org package
+# - package contains different binaries based on host
+# Add the folder with the tool to the path
+#
+# This is only downloaded for scope ovmf thus
+# should have no impact on the asl compiler used by any
+# other given platform to build.
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+{
+ "id": "iasl-ovmf-1",
+ "scope": "ovmf",
+ "type": "nuget",
+ "name": "iasl",
+ "source": "https://api.nuget.org/v3/index.json";,
+ "version": "20190215.0.0",
+ "flags": ["set_path", "host_specific"],
+}
--
2.16.3.windows.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#57080): https://edk2.groups.io/g/devel/message/57080
Mute This Topic: https://groups.io/mt/72880543/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
