diff --git a/UefiPayloadPkg/PlatformCI/PlatformBuild.py b/UefiPayloadPkg/PlatformCI/PlatformBuild.py new file mode 100644 index 0000000000..b25045870f --- /dev/null +++ b/UefiPayloadPkg/PlatformCI/PlatformBuild.py @@ -0,0 +1,225 @@ +# @file +# Script to Build UefiPayloadPkg UEFI firmware +# +# Copyright (c) Microsoft Corporation. +# Copyright (c) 2025 Intel Corporation +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +import os +import logging +import io +import sys + +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 +sys.path.append("./UefiPayloadPkg") +from UniversalPayloadBuild import UniversalPayloadFullBuild, InitArgumentParser + +# ####################################################################################### # +# Common Configuration # +# ####################################################################################### # + + +class CommonPlatform(): + ''' Common settings for this platform. Define static data here and use + for the different parts of stuart + ''' + PackagesSupported = ("UefiPayloadPkg",) + ArchSupported = ("X64", "IA32") + TargetsSupported = ("DEBUG", "RELEASE", "NOOPT") + Scopes = ('uefipayloadpkg', '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 (, ) + ''' + return (os.path.join("UefiPayloadPkg", "UefiPayloadPkg.dsc"), {}) + + # ####################################################################################### # + # Actual Configuration for Platform Build # + # ####################################################################################### # + + +class PlatformBuilder(UefiBuilder, BuildSettingsManager): + def __init__(self): + UefiBuilder.__init__(self) + self.args = None + + 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", "UefiPayloadPkg/UefiPayloadPkg.dsc", "From CmdLine") + self.args = args + + + 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 "UefiPayloadPkg_With_Run" + return "UefiPayloadPkg" + + 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", "UefiPayloadPkg", "Platform Hardcoded") + self.env.SetValue("TOOL_CHAIN_TAG", "VS2022", "Default Toolchain") + + # Add support for using the correct Platform Headers, tools, and Libs based on architecture + # requested to be built when building VS2022 or VS2019 + if self.env.GetValue("TOOL_CHAIN_TAG").startswith ('VS'): + 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") + if os.name == 'nt': + shell_environment.ShellEnvironment().set_shell_var("CLANG_HOST_BIN", "n") + self.env.SetValue ("BLD_*_BUILD_ARCH", self.args.build_arch, "build_arch") + self.env.SetValue ("BLD_*_UNIVERSAL_PAYLOAD", "TRUE", "build UPL") + + return 0 + + def PlatformPreBuild(self): + return 0 + + def PlatformPostBuild(self): + # + # Additional UPL build step to generate ELF entry and merge with common build FD. + # + default_args = InitArgumentParser(True) + default_args.Arch = self.args.build_arch + default_args.ToolChain = self.env.GetValue("TOOL_CHAIN_TAG") + default_args.Fit = self.env.GetValue("FIT_BUILD", "FALSE") != "FALSE" + default_args.CiBuild = True + return UniversalPayloadFullBuild(default_args) diff --git a/UefiPayloadPkg/PlatformCI/ReadMe.md b/UefiPayloadPkg/PlatformCI/ReadMe.md new file mode 100644 index 0000000000..a7cad0f581 --- /dev/null +++ b/UefiPayloadPkg/PlatformCI/ReadMe.md @@ -0,0 +1,107 @@ +# UefiPayloadPkg - Platform CI + +This ReadMe.md describes the Azure DevOps based Platform CI for UefiPayloadPkg and how +to use the same Pytools based build infrastructure locally. + +## Supported Configuration Details + +This solution for building UefiPayloadPkg has only been validated with Windows 11 +with VS2019 + CLANG/LLVM. Different firmware builds are +supported and are described below. + +| Configuration name | Architectures | DSC File |Additional Flags | +| :---- | :----- | :---- | :---- | +| IA32 | IA32 | UefiPayloadPkg.dsc | None | +| X64 | X64 | UefiPayloadPkg.dsc | None | + +More build configuration detail are in [UPL ReadMe](https://github.com/tianocore/edk2/blob/master/UefiPayloadPkg/Readme.md) + +## EDK2 Developer environment + +![Minimum Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Ftianocore%2Fedk2-pytool-extensions%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=%24.%5B'requires-python'%5D&style=for-the-badge&logo=python&logoColor=ffd343&label=Minimum%20Python%20Version%20for%20CI&color=3776ab&link=https%3A%2F%2Fwww.python.org%2Fdownloads%2F) + +- [GIT - Download & Install](https://git-scm.com/download/) +- [Edk2 Source](https://github.com/tianocore/edk2) + +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 UefiPayloadPkg + +If you are unfamiliar with Pytools, it is recommended to first read through +the generic set of edk2 [Build Instructions](https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions). + +1. [Optional] Create a Python Virtual Environment - generally once per workspace + + ``` bash + python -m venv + ``` + +2. [Optional] Activate Virtual Environment - each time new shell opened + - Linux + + ```bash + source /bin/activate + ``` + + - Windows + + ``` bash + /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 UefiPayloadPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + ``` + +5. Initialize & Update Dependencies - only as needed when ext_deps change + + ``` bash + stuart_update -c UefiPayloadPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + ``` + +6. Compile the basetools if necessary - only when basetools C source files change + + ``` bash + python BaseTools/Edk2ToolsBuild.py -t + ``` + +7. Compile Firmware + + ``` bash + stuart_build -c UefiPayloadPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + ``` + + - use `stuart_build -c UefiPayloadPkg/PlatformCI/PlatformBuild.py -h` option to see additional + options like `--clean` + +### 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 ]` parameter. + +**NOTE:** Logging the execution output will be in the normal stuart log as well as to your console. + +### Custom Build Options + +### 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 UefiPayloadPkg/PlatformCI/PlatformBuild.py BLD_*_NETWORK_DRIVER_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/UefiPayloadPkg/UefiPayloadPkg.dsc b/UefiPayloadPkg/UefiPayloadPkg.dsc index 25406fce5e..29edae6b4f 100644 --- a/UefiPayloadPkg/UefiPayloadPkg.dsc +++ b/UefiPayloadPkg/UefiPayloadPkg.dsc @@ -23,6 +23,7 @@ SUPPORTED_ARCHITECTURES = IA32|X64|AARCH64 BUILD_TARGETS = DEBUG|RELEASE|NOOPT SKUID_IDENTIFIER = DEFAULT + BUILD_ARCH = Legacy OUTPUT_DIRECTORY = Build/UefiPayloadPkg$(BUILD_ARCH) FLASH_DEFINITION = UefiPayloadPkg/UefiPayloadPkg.fdf PCD_DYNAMIC_AS_DYNAMICEX = TRUE diff --git a/UefiPayloadPkg/UniversalPayloadBuild.py b/UefiPayloadPkg/UniversalPayloadBuild.py index 65c841632c..35ef1b16f8 100644 --- a/UefiPayloadPkg/UniversalPayloadBuild.py +++ b/UefiPayloadPkg/UniversalPayloadBuild.py @@ -174,8 +174,9 @@ def BuildUniversalPayload(Args): # # Building DXE core and DXE drivers as DXEFV. + # In edk2 CI build this step will be done by CI common build step. # - if Args.BuildEntryOnly == False: + if Args.BuildEntryOnly == False and Args.CiBuild == False: BuildPayload = "build -p {} -b {} -a {} -t {} -y {} {}".format (DscPath, BuildTarget, BuildArch, ToolChain, PayloadReportPath, Quiet) BuildPayload += Pcds BuildPayload += Defines @@ -319,7 +320,7 @@ def BuildUniversalPayload(Args): else: return MultiFvList, os.path.join(BuildDir, 'UniversalPayload.elf') -def main(): +def InitArgumentParser(LoadDefault): parser = argparse.ArgumentParser(description='For building Universal Payload') parser.add_argument('-t', '--ToolChain') parser.add_argument('-b', '--Target', default='DEBUG') @@ -339,10 +340,14 @@ def main(): parser.add_argument('-l', "--LoadAddress", type=int, help='Specify payload load address', default =0x000800000) parser.add_argument('-c', '--DscPath', type=str, default="UefiPayloadPkg/UefiPayloadPkg.dsc", help='Path to the DSC file') parser.add_argument('-ac', '--add_cc_flags', action='append', help='Add specified CC compile flags') + parser.add_argument('-ci','--CiBuild', action='store_true', help='Call from edk2 CI Build Process or not', default=False) + if LoadDefault: + args, _ = parser.parse_known_args() + else: + args = parser.parse_args() + return args - args = parser.parse_args() - - +def UniversalPayloadFullBuild(args): MultiFvList = [] UniversalPayloadBinary = args.PreBuildUplBinary if (args.SkipBuild == False): @@ -374,6 +379,12 @@ def main(): return status print ("\nSuccessfully build Universal Payload") + return 0 + +def main(): + + args = InitArgumentParser(False) + return UniversalPayloadFullBuild(args) if __name__ == '__main__': main()