OvmfPkg: Add Platform CI and configuration for Core CI

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.md for details and instructions

Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>

Acked-by: Laszlo Ersek <lersek@redhat.com>
Acked-by: Ard Biesheuvel <ard.biesheuvel@arm.com>
Reviewed-by: Shenglei Zhang <shenglei.zhang@intel.com>
Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>

6 files changed, 766 insertions, 0 deletions

diff --git a/OvmfPkg/OvmfPkg.ci.yaml b/OvmfPkg/OvmfPkg.ci.yaml
new file mode 100644
index 0000000000..98992f0429
--- /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/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml b/OvmfPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml
new file mode 100644
index 0000000000..a47d273217
--- /dev/null
+++ b/OvmfPkg/PlatformCI/.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)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32"

+            Build.Flags: ""

+            Build.Target: "DEBUG"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32_RELEASE:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32"

+            Build.Flags: ""

+            Build.Target: "RELEASE"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32_NOOPT:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32"

+            Build.Flags: ""

+            Build.Target: "NOOPT"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+

+          OVMF_X64_DEBUG:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "X64"

+            Build.Flags: ""

+            Build.Target: "DEBUG"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_X64_RELEASE:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "X64"

+            Build.Flags: ""

+            Build.Target: "RELEASE"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_X64_NOOPT:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "X64"

+            Build.Flags: ""

+            Build.Target: "NOOPT"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+

+          OVMF_IA32X64_DEBUG:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32,X64"

+            Build.Flags: ""

+            Build.Target: "DEBUG"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32X64_RELEASE:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32,X64"

+            Build.Flags: ""

+            Build.Target: "RELEASE"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32X64_NOOPT:

+            Build.File: "$(package)/PlatformCI/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)/PlatformCI/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)/PlatformCI/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)/PlatformCI/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/PlatformCI/.azurepipelines/Windows-VS2019.yml b/OvmfPkg/PlatformCI/.azurepipelines/Windows-VS2019.yml
new file mode 100644
index 0000000000..02ed233fdb
--- /dev/null
+++ b/OvmfPkg/PlatformCI/.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)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32"

+            Build.Flags: ""

+            Build.Target: "DEBUG"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32_RELEASE:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32"

+            Build.Flags: ""

+            Build.Target: "RELEASE"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32_NOOPT:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32"

+            Build.Flags: ""

+            Build.Target: "NOOPT"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+

+          OVMF_X64_DEBUG:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "X64"

+            Build.Flags: ""

+            Build.Target: "DEBUG"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_X64_RELEASE:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "X64"

+            Build.Flags: ""

+            Build.Target: "RELEASE"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_X64_NOOPT:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "X64"

+            Build.Flags: ""

+            Build.Target: "NOOPT"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+

+          OVMF_IA32X64_DEBUG:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32,X64"

+            Build.Flags: ""

+            Build.Target: "DEBUG"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32X64_RELEASE:

+            Build.File: "$(package)/PlatformCI/PlatformBuild.py"

+            Build.Arch: "IA32,X64"

+            Build.Flags: ""

+            Build.Target: "RELEASE"

+            Run.Flags: $(run_flags)

+            Run: $(should_run)

+          OVMF_IA32X64_NOOPT:

+            Build.File: "$(package)/PlatformCI/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)/PlatformCI/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)/PlatformCI/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)/PlatformCI/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/PlatformCI/PlatformBuild.py b/OvmfPkg/PlatformCI/PlatformBuild.py
new file mode 100644
index 0000000000..627bb7b992
--- /dev/null
+++ b/OvmfPkg/PlatformCI/PlatformBuild.py
@@ -0,0 +1,254 @@
+# @file

+# Script to Build OVMF UEFI firmware

+#

+# Copyright (c) Microsoft Corporation.

+# 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, 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 = []

+

+        # intentionally declare this one with recursive false to avoid overhead

+        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 list.

+        # The GetRequiredSubmodules is designed to allow a build to optimize

+        # the desired submodules but it isn't necessary for this repository.

+        result = io.StringIO()

+        ret = RunCmd("git", "config --file .gitmodules --get-regexp path", workingdir=self.GetWorkspaceRoot(), outstream=result)

+        # Cmd output is expected to look like:

+        # submodule.CryptoPkg/Library/OpensslLib/openssl.path CryptoPkg/Library/OpensslLib/openssl

+        # submodule.SoftFloat.path ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3

+        if ret == 0:

+            for line in result.getvalue().splitlines():

+                _, _, path = 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 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 platform template file changed

+            if "platform-build-run-steps.yml" 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/PlatformCI/ReadMe.md b/OvmfPkg/PlatformCI/ReadMe.md
new file mode 100644
index 0000000000..2ce9007dbe
--- /dev/null
+++ b/OvmfPkg/PlatformCI/ReadMe.md
@@ -0,0 +1,137 @@
+# OvmfPkg - Platform CI

+

+This ReadMe.md describes the Azure DevOps based Platform CI for OvmfPkg and how

+to use the same Pytools based build infrastructure locally.

+

+## Supported Configuration Details

+

+This solution for building and running OvmfPkg has only been validated with Windows 10

+with VS2019 and Ubuntu 18.04 with GCC5 toolchain. Four different firmware builds are

+supported and are described below.

+

+| Configuration name      | Architectures      | DSC File            |Additional Flags |

+| :----                   | :-----             | :----               | :----           |

+| IA32                    | IA32               | OvmfPkgIa32.dsc     | None            |

+| X64                     | X64                | OvmfPkgIa64.dsc     | None            |

+| IA32 X64                | PEI-IA32 DXE-X64   | OvmfPkgIa32X64.dsc  | None            |

+| IA32 X64 Full           | PEI-IA32 DXE-X64   | OvmfPkgIa32X64.dsc  | 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 |

+

+## EDK2 Developer environment

+

+- [Python 3.8.x - Download & Install](https://www.python.org/downloads/)

+- [GIT - Download & Install](https://git-scm.com/download/)

+- [QEMU - Download, Install, and add to your path](https://www.qemu.org/download/)

+- [Edk2 Source](https://github.com/tianocore/edk2)

+- Additional packages found necessary for Ubuntu 18.04

+  - apt-get install gcc g++ make uuid-dev

+

+Note: edksetup, Submodule initialization and manual installation of NASM, iASL, or

+the required cross-compiler toolchains are **not** required, this is handled by the

+Pytools build system.

+

+## Building with Pytools for OvmfPkg

+

+1. [Optional] Create a Python Virtual Environment - generally once per workspace

+

+    ``` bash

+    python -m venv <name of virtual environment>

+    ```

+

+2. [Optional] Activate Virtual Environment - each time new shell opened

+    - Linux

+

+      ```bash

+      source <name of virtual environment>/bin/activate

+      ```

+

+    - Windows

+

+      ``` bash

+      <name of virtual environment>/Scripts/activate.bat

+      ```

+

+3. Install Pytools - generally once per virtual env or whenever pip-requirements.txt changes

+

+    ``` bash

+    pip install --upgrade -r pip-requirements.txt

+    ```

+

+4. Initialize & Update Submodules - only when submodules updated

+

+    ``` bash

+    stuart_setup -c OvmfPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>

+    ```

+

+5. Initialize & Update Dependencies - only as needed when ext_deps change

+

+    ``` bash

+    stuart_update -c OvmfPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>

+    ```

+

+6. Compile the basetools if necessary - only when basetools C source files change

+

+    ``` bash

+    python BaseTools/Edk2ToolsBuild.py -t <ToolChainTag>

+    ```

+

+7. Compile Firmware

+    - To build IA32

+

+    ``` bash

+    stuart_build -c OvmfPkg/PlatformCI/PlatformBuild.py -a IA32 TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>

+    ```

+

+    - To build X64

+

+    ``` bash

+    stuart_build -c OvmfPkg/PlatformCI/PlatformBuild.py -a X64 TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>

+    ```

+

+    - To build IA32 X64

+

+    ``` bash

+    stuart_build -c OvmfPkg/PlatformCI/PlatformBuild.py -a IA32,X64 TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>

+    ```

+

+    - use `stuart_build -c OvmfPkg/PlatformCI/PlatformBuild.py -h` option to see additional

+    options like `--clean`

+

+8. Running Emulator

+    - You can add `--FlashRom` to the end of your build command and the emulator will run after the

+    build is complete.

+    - or use the `--FlashOnly` feature to just run the emulator.

+

+      ``` bash

+      stuart_build -c OvmfPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH> --FlashOnly

+      ```

+

+### Notes

+

+1. 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.

+2. QEMU must be on your path.  On Windows this is a manual process and not part of the QEMU installer.

+

+**NOTE:** Logging the execution output will be in the normal stuart log as well as to your console.

+

+### 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

+command-line. _stuart_build_ currently requires values to be assigned, so add an`=1` suffix for bare defines.

+For example, to enable the TPM2 support, instead of the traditional "-D E1000_ENABLE", the stuart_build

+command-line would be:

+

+`stuart_build -c OvmfPkg/PlatformCI/PlatformBuild.py BLD_*_E1000_ENABLE=1`

+

+## References

+

+- [Installing and using Pytools](https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/using.md#installing)

+- More on [python virtual environments](https://docs.python.org/3/library/venv.html)

diff --git a/OvmfPkg/PlatformCI/iasl_ext_dep.yaml b/OvmfPkg/PlatformCI/iasl_ext_dep.yaml
new file mode 100644
index 0000000000..cbee0e5a5a
--- /dev/null
+++ b/OvmfPkg/PlatformCI/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"],

+}