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 EmulatorPkg with:
* Ubuntu GCC5
* Windows VS2019
Add PyTool based build of EmulatorPkg
Add EmulatorPkg.ci.yaml for Core CI
Add README-pytools for details and instructions
Cc: Jordan Justen <jordan.l.jus...@intel.com>
Cc: Andrew Fish <af...@apple.com>
Cc: Ray Ni <ray...@intel.com>
Signed-off-by: Sean Brogan <sean.bro...@microsoft.com>
---
EmulatorPkg/.azurepipelines/Ubuntu-GCC5.yml | 95 ++++++++
EmulatorPkg/.azurepipelines/Windows-VS2019.yml | 85 +++++++
EmulatorPkg/EmulatorPkg.ci.yaml | 85 +++++++
EmulatorPkg/PlatformBuild.py | 252 ++++++++++++++++++++
EmulatorPkg/README-pytools.md | 173 ++++++++++++++
5 files changed, 690 insertions(+)
diff --git a/EmulatorPkg/.azurepipelines/Ubuntu-GCC5.yml
b/EmulatorPkg/.azurepipelines/Ubuntu-GCC5.yml
new file mode 100644
index 000000000000..1aa5904bb379
--- /dev/null
+++ b/EmulatorPkg/.azurepipelines/Ubuntu-GCC5.yml
@@ -0,0 +1,95 @@
+## @file
+# Azure Pipeline build file for building a platform.
+#
+# Platform: EmulatorPkg
+# 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: 'EmulatorPkg'
+ vm_image: 'ubuntu-latest'
+ should_run: false
+ run_flags: "MAKE_STARTUP_NSH=TRUE"
+
+ #Use matrix to speed up the build process
+ strategy:
+ matrix:
+ EmulatorPkg_X64_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_X64_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_X64_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_IA32_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_IA32_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_IA32_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32"
+ Build.Flags: ""
+ 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)
+ # Add steps to install some IA32 only dependencies
+ extra_install_step:
+ - bash: sudo dpkg --add-architecture i386
+ displayName: Add i386 to dpkg
+ condition: and(gt(variables.pkg_count, 0),
eq(variables['Build.Arch'], 'IA32'), succeeded())
+ - bash: sudo apt-get update
+ displayName: do apt-get update
+ condition: and(gt(variables.pkg_count, 0),
eq(variables['Build.Arch'], 'IA32'), succeeded())
+ - bash: sudo apt-get install libc6-dev:i386 libx11-dev:i386
libxext-dev:i386 lib32gcc-7-dev
+ displayName: Add additional i386 packages
+ condition: and(gt(variables.pkg_count, 0),
eq(variables['Build.Arch'], 'IA32'), succeeded())
diff --git a/EmulatorPkg/.azurepipelines/Windows-VS2019.yml
b/EmulatorPkg/.azurepipelines/Windows-VS2019.yml
new file mode 100644
index 000000000000..e73eb910e04b
--- /dev/null
+++ b/EmulatorPkg/.azurepipelines/Windows-VS2019.yml
@@ -0,0 +1,85 @@
+## @file
+# Azure Pipeline build file for building a platform.
+#
+# Platform: EMULATORPKG
+# 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: 'EmulatorPkg'
+ vm_image: 'windows-latest'
+ should_run: true
+ run_flags: "MAKE_STARTUP_NSH=TRUE"
+
+ #Use matrix to speed up the build process
+ strategy:
+ matrix:
+ EmulatorPkg_X64_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_X64_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_X64_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "X64"
+ Build.Flags: ""
+ Build.Target: "NOOPT"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_IA32_DEBUG:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32 "
+ Build.Flags: ""
+ Build.Target: "DEBUG"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_IA32_RELEASE:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32 "
+ Build.Flags: ""
+ Build.Target: "RELEASE"
+ Run.Flags: $(run_flags)
+ Run: $(should_run)
+ EmulatorPkg_IA32_NOOPT:
+ Build.File: "$(package)/PlatformBuild.py"
+ Build.Arch: "IA32 "
+ Build.Flags: ""
+ 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)
diff --git a/EmulatorPkg/EmulatorPkg.ci.yaml b/EmulatorPkg/EmulatorPkg.ci.yaml
new file mode 100644
index 000000000000..81f81780ec76
--- /dev/null
+++ b/EmulatorPkg/EmulatorPkg.ci.yaml
@@ -0,0 +1,85 @@
+## @file
+# Core CI configuration for EmulatorPkg
+#
+# EmulatorPkg 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": [
+ # For this platform all packages are allowed???
+ "MdePkg/MdePkg.dec",
+ "MdeModulePkg/MdeModulePkg.dec",
+ "EmulatorPkg/EmulatorPkg.dec",
+ "NetworkPkg/NetworkPkg.dec",
+ "EmbeddedPkg/EmbeddedPkg.dec", ## is this one OK??
+ ],
+ # 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": [],
+ "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": [
+ "setjump",
+ "plong",
+ "lparam",
+ "lpdword",
+ "lpthread",
+ "lresult",
+ ], # 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/EmulatorPkg/PlatformBuild.py b/EmulatorPkg/PlatformBuild.py
new file mode 100644
index 000000000000..4ed87f58e14d
--- /dev/null
+++ b/EmulatorPkg/PlatformBuild.py
@@ -0,0 +1,252 @@
+# @file
+# Script to Build EmulatorPkg 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
+from edk2toollib.utility_functions import GetHostInfo
+
+#
#######################################################################################
#
+# Common Configuration
#
+#
#######################################################################################
#
+
+
+class CommonPlatform():
+ ''' Common settings for this platform. Define static data here and use
+ for the different parts of stuart
+ '''
+ PackagesSupported = ("EmulatorPkg",)
+ ArchSupported = ("X64", "IA32")
+ TargetsSupported = ("DEBUG", "RELEASE", "NOOPT")
+ Scopes = ('emulatorpkg', 'edk2-build')
+ WorkspaceRoot = os.path.realpath(os.path.join(
+ os.path.dirname(os.path.abspath(__file__)), ".."))
+
+ #
#######################################################################################
#
+ # 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
+ 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>)
+ '''
+ return (os.path.join("EmulatorPkg", "EmulatorPkg.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="X64",
+ help="Optional - architecture to build. IA32
will use IA32 for Pei & Dxe. "
+ "X64 will use X64 for both PEI and DXE.")
+
+ def RetrieveCommandLineOptions(self, args):
+ ''' Retrieve command line options from the argparser '''
+
+ shell_environment.GetBuildVars().SetValue(
+ "TARGET_ARCH", args.build_arch.upper(), "From CmdLine")
+ shell_environment.GetBuildVars().SetValue(
+ "ACTIVE_PLATFORM", "EmulatorPkg/EmulatorPkg.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 "EmulatorPkg_With_Run"
+ return "EmulatorPkg"
+
+ 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", "EmulatorPkg", "Platform Hardcoded")
+ self.env.SetValue("TOOL_CHAIN_TAG", "VS2019", "Default Toolchain")
+
+ # Add support for using the correct Platform Headers, tools, and Libs
based on emulator architecture
+ # requested to be built when building VS2019 or VS2017
+ if self.env.GetValue("TOOL_CHAIN_TAG") == "VS2019" or
self.env.GetValue("TOOL_CHAIN_TAG") == "VS2017":
+ key = self.env.GetValue("TOOL_CHAIN_TAG") + "_HOST"
+ if self.env.GetValue("TARGET_ARCH") == "IA32":
+ shell_environment.ShellEnvironment().set_shell_var(key, "x86")
+ elif self.env.GetValue("TARGET_ARCH") == "X64":
+ shell_environment.ShellEnvironment().set_shell_var(key, "x64")
+
+ # Add support for using the correct Platform Headers, tools, and Libs
based on emulator architecture
+ # requested to be built when building on linux.
+ if GetHostInfo().os.upper() == "LINUX":
+ self.ConfigureLinuxDLinkPath()
+
+ if GetHostInfo().os.upper() == "WINDOWS":
+ self.env.SetValue("BLD_*_WIN_HOST_BUILD", "TRUE",
+ "Trigger Windows host build")
+
+ self.env.SetValue("MAKE_STARTUP_NSH", "FALSE", "Default to false")
+
+ # I don't see what this does but it is in build.sh
+ key = "BLD_*_BUILD_" + self.env.GetValue("TARGET_ARCH")
+ self.env.SetValue(key, "TRUE", "match script in build.sh")
+ return 0
+
+ def PlatformPreBuild(self):
+ return 0
+
+ def PlatformPostBuild(self):
+ return 0
+
+ def FlashRomImage(self):
+ ''' Use the FlashRom Function to run the emulator. This gives an easy
stuart command line to
+ activate the emulator. '''
+
+ OutputPath = os.path.join(self.env.GetValue(
+ "BUILD_OUTPUT_BASE"), self.env.GetValue("TARGET_ARCH"))
+
+ if (self.env.GetValue("MAKE_STARTUP_NSH") == "TRUE"):
+ f = open(os.path.join(OutputPath, "startup.nsh"), "w")
+ f.write("BOOT SUCCESS !!! \n")
+ # add commands here
+ f.write("reset\n")
+ f.close()
+
+ if GetHostInfo().os.upper() == "WINDOWS":
+ cmd = "WinHost.exe"
+ elif GetHostInfo().os.upper() == "LINUX":
+ cmd = "./Host"
+ else:
+ logging.critical("Unsupported Host")
+ return -1
+ return RunCmd(cmd, "", workingdir=OutputPath)
+
+ def ConfigureLinuxDLinkPath(self):
+ '''
+ logic copied from build.sh to setup the correct libraries
+ '''
+ if self.env.GetValue("TARGET_ARCH") == "IA32":
+ LIB_NAMES = ["ld-linux.so.2", "libdl.so.2 crt1.o", "crti.o crtn.o"]
+ LIB_SEARCH_PATHS = ["/usr/lib/i386-linux-gnu",
+ "/usr/lib32", "/lib32", "/usr/lib", "/lib"]
+ elif self.env.GetValue("TARGET_ARCH") == "X64":
+ LIB_NAMES = ["ld-linux-x86-64.so.2",
+ "libdl.so.2", "crt1.o", "crti.o", "crtn.o"]
+ LIB_SEARCH_PATHS = ["/usr/lib/x86_64-linux-gnu",
+ "/usr/lib64", "/lib64", "/usr/lib", "/lib"]
+
+ HOST_DLINK_PATHS = ""
+ for lname in LIB_NAMES:
+ logging.debug(f"Looking for {lname}")
+ for dname in LIB_SEARCH_PATHS:
+ logging.debug(f"In {dname}")
+ if os.path.isfile(os.path.join(dname, lname)):
+ logging.debug(f"Found {lname} in {dname}")
+ HOST_DLINK_PATHS += os.path.join(
+ os.path.join(dname, lname)) + os.pathsep
+ break
+ HOST_DLINK_PATHS = HOST_DLINK_PATHS.rstrip(os.pathsep)
+ logging.critical(f"Setting HOST_DLINK_PATHS to {HOST_DLINK_PATHS}")
+ shell_environment.ShellEnvironment().set_shell_var(
+ "HOST_DLINK_PATHS", HOST_DLINK_PATHS)
diff --git a/EmulatorPkg/README-pytools.md b/EmulatorPkg/README-pytools.md
new file mode 100644
index 000000000000..a99b050bfa65
--- /dev/null
+++ b/EmulatorPkg/README-pytools.md
@@ -0,0 +1,173 @@
+# EmulatorPkg
+
+This README-pytools.md summarizes the current state of Platform CI for
EmulatorPkg.
+It also describes how to _build_ EmulatorPkg using the Pytools build system.
+For general documentation on EmulatorPkg, 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=40&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=40&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=40&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Windows%20VS2019?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_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=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_NOOPT"/></a>
+ </td>
+ <td></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=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_IA32_NOOPT"/></a>
+ </td>
+ <td>Run to shell disabled due to SegFault</td>
+ </tr>
+ <tr>
+ <td>X64</td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_DEBUG"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_RELEASE"/></a>
+ </td>
+ <td>
+ <a
href="https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=39&branchName=master";>
+ <img
src="https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/EmulatorPkg/EmulatorPkg%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20EmulatorPkg_X64_NOOPT"/></a>
+ </td>
+ <td>Run to shell disabled due to SegFault</td>
+ </tr>
+</table>
+
+### Config Details
+
+| Config | Architectures |Additional Flags |
+| :---- | :----- | :---- |
+| IA32 | IA32 | None |
+| X64 | X64 | None |
+
+## Setup
+
+### The Usual EDK2 Build Setup
+
+- [Download & Install Python 3.x](https://www.python.org/downloads/)
+- [Download & Install git](https://git-scm.com/download/)
+- [Configure Git for EDK
II](https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems#github-help)
+- [Download/Checkout the EDK II source tree 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...
+
+### Install the necessary development packages for your distribution
+
+This varies by distribution, toolchain, and your configuration but here are a
few hints.
+
+- For building ARCH IA32 on X64 Ubuntu 18.04 LTS these steps where needed.
+
+ ``` bash
+ sudo dpkg --add-architecture i386
+ sudo apt-get update
+ sudo apt-get install libc6-dev:i386 libx11-dev:i386 libxext-dev:i386
lib32gcc-7-dev
+ ```
+
+- For building Basetools and other host applications
+
+ ``` bash
+ sudo apt-get update
+ sudo apt-get install gcc g++ make uuid-dev
+
+ ```
+
+### 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 EmulatorPkg
+
+- Install Pytools
+ - `pip install --upgrade -r pip-requirements.txt`
+- Initialize & Update Submodules
+ - `stuart_setup -c EmulatorPkg\PlatformBuild.py`
+- Initialize & Update Dependencies (e.g. iASL & NASM)
+ - `stuart_update -c EmulatorPkg\PlatformBuild.py`
+- Compile (IA32 or X64 supported)
+ - `stuart_build -c EmulatorPkg\PlatformBuild.py
[TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>] -a <TARGET_ARCH>`
+- 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 like `stuart_build -c
EmulatorPkg\PlatformBuild.py [TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>] -a <TARGET_ARCH>
--FlashOnly` to just run the emulator.
+
+**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 the emulator to the UEFI shell and then execute the contents of
startup.nsh.
+
+## Passing Build Defines
+
+To pass build defines through stuart*build to the edk2 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 IP6 Network Stack, the stuart_build command-line
would be:
+
+`stuart_build -c EmulatorPkg/PlatformBuild.py BLD_*_NETWORK_IP6_ENABLE=1`
+
+## 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 command-line
parser](https://github.com/tianocore/edk2-pytool-extensions/blob/56f6a7aee09995c2f22da4765e8b0a29c1cbf5de/edk2toolext/edk2_invocable.py#L109)
--
2.16.3.windows.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#57079): https://edk2.groups.io/g/devel/message/57079
Mute This Topic: https://groups.io/mt/72880541/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
