mirror of https://github.com/acidanthera/audk.git
EmulatorPkg: 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 EmulatorPkg with: * Ubuntu GCC5 * Windows VS2019 Add PyTool based build of EmulatorPkg Add EmulatorPkg.ci.yaml for Core CI Add ReadMe.md for details and instructions Cc: Jordan Justen <jordan.l.justen@intel.com> Cc: Andrew Fish <afish@apple.com> Cc: Ray Ni <ray.ni@intel.com> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Reviewed-by: Shenglei Zhang <shenglei.zhang@intel.com> Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com> Reviewed-by: Liming Gao <liming.gao@intel.com> Acked-by: Ray Ni <ray.ni@intel.com>
This commit is contained in:
Sean Brogan
mergify[bot]
parent
0c7f189e60
commit
951a03536c
|
|
@ -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)
|
||||
}
|
||||
}
|
||||
|
|
@ -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)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "X64"
|
||||
Build.Flags: ""
|
||||
Build.Target: "DEBUG"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_X64_RELEASE:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "X64"
|
||||
Build.Flags: ""
|
||||
Build.Target: "RELEASE"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_X64_NOOPT:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "X64"
|
||||
Build.Flags: ""
|
||||
Build.Target: "NOOPT"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_IA32_DEBUG:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "IA32"
|
||||
Build.Flags: ""
|
||||
Build.Target: "DEBUG"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_IA32_RELEASE:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "IA32"
|
||||
Build.Flags: ""
|
||||
Build.Target: "RELEASE"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_IA32_NOOPT:
|
||||
Build.File: "$(package)/PlatformCI/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())
|
||||
|
|
@ -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)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "X64"
|
||||
Build.Flags: ""
|
||||
Build.Target: "DEBUG"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_X64_RELEASE:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "X64"
|
||||
Build.Flags: ""
|
||||
Build.Target: "RELEASE"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_X64_NOOPT:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "X64"
|
||||
Build.Flags: ""
|
||||
Build.Target: "NOOPT"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_IA32_DEBUG:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "IA32 "
|
||||
Build.Flags: ""
|
||||
Build.Target: "DEBUG"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_IA32_RELEASE:
|
||||
Build.File: "$(package)/PlatformCI/PlatformBuild.py"
|
||||
Build.Arch: "IA32 "
|
||||
Build.Flags: ""
|
||||
Build.Target: "RELEASE"
|
||||
Run.Flags: $(run_flags)
|
||||
Run: $(should_run)
|
||||
EmulatorPkg_IA32_NOOPT:
|
||||
Build.File: "$(package)/PlatformCI/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)
|
||||
|
|
@ -0,0 +1,272 @@
|
|||
# @file
|
||||
# Script to Build EmulatorPkg 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
|
||||
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 = []
|
||||
# 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>)
|
||||
'''
|
||||
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)
|
||||
|
|
@ -0,0 +1,128 @@
|
|||
# EmulatorPkg - Platform CI
|
||||
|
||||
This ReadMe.md describes the Azure DevOps based Platform CI for EmulatorPkg and how
|
||||
to use the same Pytools based build infrastructure locally.
|
||||
|
||||
## Supported Configuration Details
|
||||
|
||||
This solution for building and running EmulatorPkg has only been validated with Windows 10
|
||||
with VS2019 and Ubuntu 18.04 with GCC5 toolchain. Two different firmware builds are
|
||||
supported and are described below.
|
||||
|
||||
| Configuration name | Architectures | DSC File |Additional Flags |
|
||||
| :---- | :----- | :---- | :---- |
|
||||
| IA32 | IA32 | EmulatorPkg.dsc | None |
|
||||
| X64 | X64 | EmulatorPkg.dsc | None |
|
||||
|
||||
## EDK2 Developer environment
|
||||
|
||||
- [Python 3.8.x - Download & Install](https://www.python.org/downloads/)
|
||||
- [GIT - Download & Install](https://git-scm.com/download/)
|
||||
- [Edk2 Source](https://github.com/tianocore/edk2)
|
||||
- For building Basetools and other host applications
|
||||
|
||||
``` bash
|
||||
sudo apt-get update
|
||||
sudo apt-get install gcc g++ make uuid-dev
|
||||
```
|
||||
|
||||
- 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
|
||||
```
|
||||
|
||||
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 EmulatorPkg
|
||||
|
||||
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 EmulatorPkg/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 EmulatorPkg/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
|
||||
|
||||
``` bash
|
||||
stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
|
||||
```
|
||||
|
||||
- use `stuart_build -c EmulatorPkg/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 EmulatorPkg/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.
|
||||
|
||||
**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 the Emulator to the UEFI shell and then execute
|
||||
the contents of *startup.nsh*.
|
||||
|
||||
### 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 IP6 Network Stack, the stuart_build command-line would be:
|
||||
|
||||
`stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py BLD_*_NETWORK_IP6_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)
|
||||
Loading…
Reference in New Issue