From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from NAM11-CO1-obe.outbound.protection.outlook.com (NAM11-CO1-obe.outbound.protection.outlook.com [40.92.18.57]) by mx.groups.io with SMTP id smtpd.web12.1173.1587409979874420724 for ; Mon, 20 Apr 2020 12:13:00 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@outlook.com header.s=selector1 header.b=bVhGxyx7; spf=pass (domain: outlook.com, ip: 40.92.18.57, mailfrom: michael.kubacki@outlook.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ek5WZ6c80N3JBe2+WUkHuAfu5hESVHlzn7pXTSXJ9deZ3YOMD0ayg3TF7GbEPCHuRK+QDX35tkzshyfeEiKxcywnOdVve++1ph388Gw8aqE2a1PBX4kxaaGTfrWvZ7WpZmrIxDo3UZVwwN8zt4lrsoN/bhpFmNy8CNx4LzwtrZwhoH83iiLgjJh/C5T0WsG73gRbXUBQi3HOL+xcOMY9+qSwMe3J13LfN7EdUywfl4YQkHPMlrU68YPOyuUDq05h1+9R8hYQeIvEVrlU0GukEROc7EkatrZklbv9rHOTGMDIgt/imoTQ2eSz8ovGsJYxXkbNMmJkMyQs2uvmkB0faA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=0GCs1421B9DqUurCcat4kXnmv0h6BHhuQMeOEUXa2uk=; b=MeBHUhBx5k6zPkKPSIfU5cAJ4wrrjfZ6UEZjQZIhGfszaHXbPy8YwPPG2cMRuKRGUIMApnTVBHCVd349TJHFLZVClEtcMher0BXu08xxxZkze30r2vv8mqKuOy0W3tQ17EO6zPKBRKZMyo7fw0bZ8Oz+AyZuIBO7wyHgoEyfo5Tat/bwshSn3TehhS9fBBY6BQ+RZ1QZRk0yH1svTX6R5hW6eg8yaA+wCiB4Y1BomDNH1c1fpC4Y9G9Jg/kExFPmP9froA6iykRstOmdGwSgHUiE7bJIIp5WDvvtKuV/3ATUxoOav8aGcM3MhB61Oe5zGJuMVtRPkaur0KL5ifZ2+Q== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=outlook.com; dmarc=pass action=none header.from=outlook.com; dkim=pass header.d=outlook.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=outlook.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=0GCs1421B9DqUurCcat4kXnmv0h6BHhuQMeOEUXa2uk=; b=bVhGxyx74fa6XIP4NNrw1DhWim10Dq82vAUKwR0rK/SkpIcIf7sc9kOpxqgc5J7nghlUfhREw0Q5eM0U/I9RKPfTpJ4FqEUYCqFxUdY+KeJYz6yW6Dcub+d4nzZs0EqfYzbnXHJUxi585e4KUFHH3p4n+4HzKxZCF6bKy0GBIYtY1Z2OVdrx+pSdUZbYU+UNHSt+kNE6lXOmI6Y8HD/rLWWsvxsG+H+EnEwn8BGg6j78DL/qmNJeUmP92CVHi4//+l6AoH5H+323TLDa/M8i7DvVDG00+tISHn3U4G7QdEujbJm9UzJd/RmzpTs6RJaGNgohc4SAsPMfFwck6k0QoQ== Received: from CO1NAM11FT028.eop-nam11.prod.protection.outlook.com (2a01:111:e400:3861::41) by CO1NAM11HT106.eop-nam11.prod.protection.outlook.com (2a01:111:e400:3861::436) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2921.25; Mon, 20 Apr 2020 19:12:57 +0000 Received: from MWHPR07MB3440.namprd07.prod.outlook.com (2a01:111:e400:3861::4c) by CO1NAM11FT028.mail.protection.outlook.com (2a01:111:e400:3861::470) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2921.25 via Frontend Transport; Mon, 20 Apr 2020 19:12:57 +0000 X-IncomingTopHeaderMarker: OriginalChecksum:C891FCA376343D83F44D9C5446781E94A8CFD8108DDAF4C39396131D2F0B52DD;UpperCasedChecksum:5FB07EAA89FA440ABAF801828BE261B07DA1FFDE6BA47CEF6C485927DA8CB794;SizeAsReceived:7796;Count:49 Received: from MWHPR07MB3440.namprd07.prod.outlook.com ([fe80::bcc9:271b:20db:52e3]) by MWHPR07MB3440.namprd07.prod.outlook.com ([fe80::bcc9:271b:20db:52e3%6]) with mapi id 15.20.2921.030; Mon, 20 Apr 2020 19:12:57 +0000 From: "Michael Kubacki" To: devel@edk2.groups.io Cc: Laszlo Ersek , Ard Biesheuvel , Leif Lindholm Subject: [PATCH v2 2/6] ArmVirtPkg: Add Platform CI and configuration for Core CI Date: Mon, 20 Apr 2020 12:12:12 -0700 Message-ID: X-Mailer: git-send-email 2.16.3.windows.1 In-Reply-To: <20200420191216.24572-1-michael.kubacki@outlook.com> References: <20200420191216.24572-1-michael.kubacki@outlook.com> X-ClientProxiedBy: MWHPR10CA0062.namprd10.prod.outlook.com (2603:10b6:300:2c::24) To MWHPR07MB3440.namprd07.prod.outlook.com (2603:10b6:301:69::28) Return-Path: michael.kubacki@outlook.com X-Microsoft-Original-Message-ID: <20200420191216.24572-3-michael.kubacki@outlook.com> MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from localhost.localdomain (2001:4898:80e8:0:2dea:92b4:e0b5:1ad3) by MWHPR10CA0062.namprd10.prod.outlook.com (2603:10b6:300:2c::24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2921.25 via Frontend Transport; Mon, 20 Apr 2020 19:12:48 +0000 X-Mailer: git-send-email 2.16.3.windows.1 X-Microsoft-Original-Message-ID: <20200420191216.24572-3-michael.kubacki@outlook.com> X-TMN: [i8703ETa0Pk0sgl76fa4xYg8EqoYYXLKFZnUMDnUiILWlgCN/LVCmrW5elTBJ+Mv] X-MS-PublicTrafficType: Email X-IncomingHeaderCount: 49 X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-Correlation-Id: 4336911c-c6f6-4978-ff8d-08d7e55ed088 X-MS-TrafficTypeDiagnostic: CO1NAM11HT106: X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: lh0rqKmN+nTT9vQ6wgVpg1qEHJIfpPwuhBuJ0IsCDA3mW/OZrbV3zBWsZ/4CcVvrjHYd0CLvfCpiRG3wpMDWGr2SmBHduLuTgJbft2+aiJylSKx8V5DePx7APKZ++yK8/8hBeGY9QRarZmhxnQ4MnXDPMgY63sEUM3+JOCbxpOt3Rp8oQ2LlpBGMZo+D8IGclSEsbvr8BkN5pYpluW5MXK9w8NVfHNLHyWXtqcXj8fA37bMHqrAa+krFinymt4mk X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:0;SRV:;IPV:NLI;SFV:NSPM;H:MWHPR07MB3440.namprd07.prod.outlook.com;PTR:;CAT:NONE;SFTY:;SFS:;DIR:OUT;SFP:1901; X-MS-Exchange-AntiSpam-MessageData: TFyJb6/oBUV7UHluyV1SN75DYuJwQQPpElBbKep9Qw0f/iN8eH4MGaAMfrQEH4OIH0eajm1QR1j9fdqidtVLfBqn1BofOqdD369Phct+VQ0DLGAOFZ8rcfnnezqOAdhXFzphfz2Xb8P4Tx0iDp9BJQIZDcLPZ9Yo9DopJZqIEs4tYXAnk+aiK1LRGdnevfZU5PFfuy8ArvJHb8j4L5kALg== X-OriginatorOrg: outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 4336911c-c6f6-4978-ff8d-08d7e55ed088 X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Apr 2020 19:12:48.7728 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-FromEntityHeader: Internet X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO1NAM11HT106 Content-Type: text/plain From: Sean Brogan REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2570 Add new Azure Pipeline definitions to build and run ArmVirtPkg with: * Ubuntu GCC5 Add PyTool based build of ArmVirtPkg Add extdep for managing the iasl dependency Add ArmVirtPkg.ci.yaml for Core CI Add ReadMe.rst for status, details, and instructions Cc: Laszlo Ersek Cc: Ard Biesheuvel Cc: Leif Lindholm Signed-off-by: Sean Brogan Signed-off-by: Michael Kubacki --- ArmVirtPkg/ArmVirtPkg.ci.yaml | 103 ++++++++ ArmVirtPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml | 89 +++++++ ArmVirtPkg/PlatformCI/PlatformBuild.py | 276 ++++++++++++++++++++ ArmVirtPkg/PlatformCI/iasl_ext_dep.yaml | 21 ++ ArmVirtPkg/ReadMe.rst | 139 ++++++++++ 5 files changed, 628 insertions(+) diff --git a/ArmVirtPkg/ArmVirtPkg.ci.yaml b/ArmVirtPkg/ArmVirtPkg.ci.yaml new file mode 100644 index 000000000000..4553725ee528 --- /dev/null +++ b/ArmVirtPkg/ArmVirtPkg.ci.yaml @@ -0,0 +1,103 @@ +## @file +# Core CI configuration for ArmVirtPkg +# +# ArmVirtPkg 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", + "ArmVirtPkg/ArmVirtPkg.dec", + "NetworkPkg/NetworkPkg.dec", + "ArmPkg/ArmPkg.dec", + "OvmfPkg/OvmfPkg.dec", + "EmbeddedPkg/EmbeddedPkg.dec", + "ArmPlatformPkg/ArmPlatformPkg.dec", + "SecurityPkg/SecurityPkg.dec", + "ShellPkg/ShellPkg.dec" #Is this 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": False, # Fails right now with over 270 errors + "IgnoreFiles": [], # use gitignore syntax to ignore errors in matching files + "ExtendWords": [ + "setjump", + "plong", + "lparam", + "lpdword", + "lpthread", + "lresult", + "bootable", + "bsymbolic", + "endiannness", + "fvmain", + "multiboot", + "qemu's", + "ramdisk", + "ramfb", + "unbootable", + "virt's", + "werror", + "xenio" + ], # 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/ArmVirtPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml b/ArmVirtPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml new file mode 100644 index 000000000000..b9452ec5bfaf --- /dev/null +++ b/ArmVirtPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml @@ -0,0 +1,89 @@ +## @file +# Azure Pipeline build file for building a platform. +# +# Platform: ArmVirtQemu +# 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: 'ArmVirtPkg' + 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: + QEMU_AARCH64_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "AARCH64" + Build.Flags: "" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + QEMU_AARCH64_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "AARCH64" + Build.Flags: "" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + QEMU_AARCH64_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "AARCH64" + Build.Flags: "" + Build.Target: "NOOPT" + Run.Flags: $(run_flags) + Run: $(should_run) + QEMU_ARM_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "ARM" + Build.Flags: "" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + QEMU_ARM_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "ARM" + Build.Flags: "" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + QEMU_ARM_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "ARM" + 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) + extra_install_step: + - bash: sudo apt-get install qemu + displayName: Install qemu + condition: and(gt(variables.pkg_count, 0), succeeded()) diff --git a/ArmVirtPkg/PlatformCI/PlatformBuild.py b/ArmVirtPkg/PlatformCI/PlatformBuild.py new file mode 100644 index 000000000000..dff653e919eb --- /dev/null +++ b/ArmVirtPkg/PlatformCI/PlatformBuild.py @@ -0,0 +1,276 @@ +# @file +# Script to Build ArmVirtPkg 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 = ("ArmVirtPkg",) + ArchSupported = ("AARCH64", "ARM") + TargetsSupported = ("DEBUG", "RELEASE", "NOOPT") + Scopes = ('armvirt', '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 ''' + + scopes = CommonPlatform.Scopes + ActualToolChainTag = shell_environment.GetBuildVars().GetValue("TOOL_CHAIN_TAG", "") + + if GetHostInfo().os.upper() == "LINUX" and ActualToolChainTag.upper().startswith("GCC"): + if "AARCH64" in self.ActualArchitectures: + scopes += ("gcc_aarch64_linux",) + if "ARM" in self.ActualArchitectures: + scopes += ("gcc_arm_linux",) + return 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("ArmVirtPkg", "ArmVirtQemu.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="AARCH64", + help="Optional - Architecture to build. Default = AARCH64") + + 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", "ArmVirtPkg/ArmVirtQemu.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 ''' + scopes = CommonPlatform.Scopes + ActualToolChainTag = shell_environment.GetBuildVars().GetValue("TOOL_CHAIN_TAG", "") + Arch = shell_environment.GetBuildVars().GetValue("TARGET_ARCH", "") + + if GetHostInfo().os.upper() == "LINUX" and ActualToolChainTag.upper().startswith("GCC"): + if "AARCH64" == Arch: + scopes += ("gcc_aarch64_linux",) + elif "ARM" == Arch: + scopes += ("gcc_arm_linux",) + return 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 "ArmVirtPkg_With_Run" + return "ArmVirtPkg" + + 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", "ArmVirtQemu", "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") + Built_FV = os.path.join(OutputPath_FV, "QEMU_EFI.fd") + + # pad fd to 64mb + with open(Built_FV, "ab") as fvfile: + fvfile.seek(0, os.SEEK_END) + additional = b'\0' * ((64 * 1024 * 1024)-fvfile.tell()) + fvfile.write(additional) + + # QEMU must be on that path + + # Unique Command and Args parameters per ARCH + if (self.env.GetValue("TARGET_ARCH").upper() == "AARCH64"): + cmd = "qemu-system-aarch64" + args = "-M virt" + args += " -cpu cortex-a57" # emulate cpu + elif(self.env.GetValue("TARGET_ARCH").upper() == "ARM"): + cmd = "qemu-system-arm" + args = "-M virt" + args += " -cpu cortex-a15" # emulate cpu + else: + raise NotImplementedError() + + # Common Args + args += " -pflash " + Built_FV # path to fw + args += " -m 1024" # 1gb memory + # turn off network + args += " -net none" + # Serial messages out + args += " -serial stdio" + # Mount disk with startup.nsh + args += f" -drive file=fat:rw:{VirtualDrive},format=raw,media=disk" + + # Conditional Args + if (self.env.GetValue("QEMU_HEADLESS").upper() == "TRUE"): + args += " -display none" # no graphics + + 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/ArmVirtPkg/PlatformCI/iasl_ext_dep.yaml b/ArmVirtPkg/PlatformCI/iasl_ext_dep.yaml new file mode 100644 index 000000000000..8869ed3ecef1 --- /dev/null +++ b/ArmVirtPkg/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 armvirt thus +# should have no impact on the asl compiler used by any +# other platform build +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +{ + "id": "iasl-armvirt-1", + "scope": "armvirt", + "type": "nuget", + "name": "iasl", + "source": "https://api.nuget.org/v3/index.json", + "version": "20190215.0.0", + "flags": ["set_path", "host_specific"], +} diff --git a/ArmVirtPkg/ReadMe.rst b/ArmVirtPkg/ReadMe.rst new file mode 100644 index 000000000000..6149bff7032d --- /dev/null +++ b/ArmVirtPkg/ReadMe.rst @@ -0,0 +1,139 @@ +========== +ArmVirtPkg +========== + +This ReadMe.rst summarizes the current state of Azure DevOps based Platform CI +for ArmVirtPkg. It also describes how to *build* ArmVirtPkg locally using the Pytools build system. + +Platform CI Current Status +-------------------------- + +AARCH64 Configuration +````````````````````` +=============== ============= ============= ============= + Toolchain DEBUG RELEASE NOOPT +=============== ============= ============= ============= +`Ubuntu GCC5`_ |apAArch64du| |apAArch64ru| |apAArch64nu| +=============== ============= ============= ============= + +ARM Configuration +````````````````` +=============== ============= ============= ============= + Toolchain DEBUG RELEASE NOOPT +=============== ============= ============= ============= +`Ubuntu GCC5`_ |apArmdu| |apArmru| |apArmnu| +=============== ============= ============= ============= + +Setup +----- + +The Usual EDK2 Build Setup +`````````````````````````` + +- `Python 3.8.x - Download & Install `_ +- `GIT - Download & Install `_ +- `GIT - Configure for EDK II `_ +- `QEMU - Download, Install, and add to your path `_ +- `EDKII Source - Download/Checkout from Github `_ + +**NOTE:** Do *not* follow the EDK II Compile Tools and Build instructions, see below... + +Differences from EDK Classic Build Setup +```````````````````````````````````````` + +- Build BaseTools using `python BaseTools/Edk2ToolsBuild.py [-t ]` + + - This replaces `edksetup Rebuild`" from the classic build system + +- **No Action:** edksetup, Submodule initialization and manual installation of NASM and iASL are **not** + required, it is handled by the Pytools build system. + +Building with Pytools for ArmVirtPkg +```````````````````````````````````` + +* Install Pytools + + .. code-block:: bash + + pip install --upgrade -r pip-requirements.txt + +* Initialize & Update Submodules + + .. code-block:: bash + + stuart_setup -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + +* Initialize & Update Dependencies (e.g. iASL & NASM) + + .. code-block:: bash + + stuart_update -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + +* Compile + + .. code-block:: bash + + stuart_build -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + +* 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. + + .. code-block:: bash + + stuart_build -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a --FlashOnly + +Notes +````` + +1. Including the expected build architecture and toolchain to the *stuart_update* command is critical. This is because there + are extra scopes and tools that will be resolved during the update step that need to match your build step. +2. 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. +3. 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 commandline. stuart_build currently +requires values to be assigned, so add a `=1` suffix for bare defines. +For example, to enable TPM2 support, instead of the traditional "-D TPM2_ENABLE=TRUE", the stuart_build command-line would be: + +.. code-block:: bash + + stuart_build -c ArmVirtPkg/PlatformCI/PlatformBuild.py BLD_*_TPM2_ENABLE=TRUE + +References +---------- +- `Installing Pytools `_ +- For each workspace, consider creating & using a `Python Virtual Environment `_ + + * `Sample Layout `_ + +- `stuart_build commandline parser `_ + + +.. =================================================================== +.. This is a bunch of directives to make the README file more readable +.. =================================================================== + +.. _Ubuntu GCC5: https://dev.azure.com/tianocore/edk2-ci-play/_build/latest?definitionId=41&branchName=master + +.. |apAArch64du| image:: https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/ArmVirtPkg/ArmVirtQemu%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_AARCH64_DEBUG +.. |apAArch64ru| image:: https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/ArmVirtPkg/ArmVirtQemu%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_AARCH64_RELEASE +.. |apAArch64nu| image:: https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/ArmVirtPkg/ArmVirtQemu%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_AARCH64_NOOPT + +.. |apArmdu| image:: https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/ArmVirtPkg/ArmVirtQemu%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_ARM_DEBUG +.. |apArmru| image:: https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/ArmVirtPkg/ArmVirtQemu%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_ARM_RELEASE +.. |apArmnu| image:: https://dev.azure.com/tianocore/edk2-ci-play/_apis/build/status/ArmVirtPkg/ArmVirtQemu%20Ubuntu%20GCC5?branchName=master&jobName=Platform_CI&configuration=Platform_CI%20QEMU_ARM_NOOPT -- 2.16.3.windows.1