Skip to content

[build.ps1] Revamp No-asserts toolchain build and packaging #81644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jun 11, 2025
Merged

[build.ps1] Revamp No-asserts toolchain build and packaging #81644

Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2d6f05b
Remove Variant option and add support for IncludeNoAsserts instead
mhegazy May 15, 2025
1624bf6
Add support for named arguments in Invoke-BuildStep
mhegazy May 15, 2025
709f591
Check for property type before using string functions
mhegazy May 16, 2025
74151fc
Address code review feedback
mhegazy May 20, 2025
96b4038
Address review feedback
mhegazy May 29, 2025
b8be792
Remove PinnedToolchainVarinat variable
mhegazy May 30, 2025
3aff198
Remove trailing whitespace
mhegazy May 30, 2025
14b2682
Copy Asserts output to the NoAsserts toolchain layout
mhegazy May 30, 2025
a16f47c
Add parameter name
mhegazy Jun 2, 2025
2f10097
Update utils/build.ps1
mhegazy Jun 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 61 additions & 40 deletions utils/build.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,6 @@ The toolchain snapshot to build the early components with.
.PARAMETER PinnedSHA256
The SHA256 for the pinned toolchain.

.PARAMETER PinnedToolchainVariant
The toolchain variant to use while building the toolchain. Defaults to
`Asserts`.

.PARAMETER AndroidNDKVersion
The version number of the Android NDK to be used.

Expand Down Expand Up @@ -100,8 +96,8 @@ in batch file format instead of executing them.
.PARAMETER HostArchName
The architecture where the toolchain will execute.

.PARAMETER Variant
The toolchain variant to build. Defaults to `Asserts`.
.PARAMETER IncludeNoAsserts
If set, the no-assert toolchain variant is also build and included in the output.

.PARAMETER FoundationTestConfiguration
Whether to run swift-foundation and swift-corelibs-foundation tests in a debug or release configuration.
Expand Down Expand Up @@ -132,8 +128,6 @@ param
[ValidatePattern("^([A-Fa-f0-9]{64}|)$")]
[string] $PinnedSHA256 = "",
[string] $PinnedVersion = "",
[ValidateSet("Asserts", "NoAsserts")]
[string] $PinnedToolchainVariant = "Asserts",
[ValidatePattern('^\d+(\.\d+)*$')]
[string] $PythonVersion = "3.9.10",
[ValidatePattern("^r(?:[1-9]|[1-9][0-9])(?:[a-z])?$")]
Expand All @@ -148,8 +142,7 @@ param
[string] $Stage = "",
[ValidateSet("AMD64", "ARM64")]
[string] $HostArchName = $(if ($env:PROCESSOR_ARCHITEW6432) { $env:PROCESSOR_ARCHITEW6432 } else { $env:PROCESSOR_ARCHITECTURE }),
[ValidateSet("Asserts", "NoAsserts")]
[string] $Variant = "Asserts",
[switch] $IncludeNoAsserts = $false,
[switch] $Clean,
[switch] $DebugInfo,
[ValidatePattern('^\d+(\.\d+)*$')]
Expand Down Expand Up @@ -623,8 +616,10 @@ function Get-InstallDir([Hashtable] $Platform) {

# For dev productivity, install the host toolchain directly using CMake.
# This allows iterating on the toolchain using ninja builds.
$HostPlatform.ToolchainInstallRoot = "$(Get-InstallDir $HostPlatform)\Toolchains\$ProductVersion+$Variant"
$BuildPlatform.ToolchainInstallRoot = "$(Get-InstallDir $BuildPlatform)\Toolchains\$ProductVersion+$Variant"
$HostPlatform.ToolchainInstallRoot = "$(Get-InstallDir $HostPlatform)\Toolchains\$ProductVersion+Asserts"
$HostPlatform.NoAssertsToolchainInstallRoot = "$(Get-InstallDir $HostPlatform)\Toolchains\$ProductVersion+NoAsserts"
$BuildPlatform.ToolchainInstallRoot = "$(Get-InstallDir $BuildPlatform)\Toolchains\$ProductVersion+Asserts"
$BuildPlatform.NoAssertsToolchainInstallRoot = "$(Get-InstallDir $BuildPlatform)\Toolchains\$ProductVersion+NoAsserts"

# Build functions
function Invoke-BuildStep {
Expand All @@ -636,21 +631,36 @@ function Invoke-BuildStep {
[Parameter(Position=1, Mandatory)]
[Hashtable] $Platform,
[Parameter(ValueFromRemainingArguments)]
$RemainingArgs
[Object[]] $RemainingArgs
)

if ($Summary) {
$Stopwatch = [Diagnostics.Stopwatch]::StartNew()
}

$SplatArgs = @{}
foreach ($Arg in $RemainingArgs) {
if ($Arg -is [Hashtable]) {
$SplatArgs += $Arg
} elseif ($Arg -is [string]) {
$SplatArgs[$Arg.TrimStart('-')] = $true
} else {
throw "$Arg is unknown type: $($Arg.GetType())"
if ($RemainingArgs) {
$Enumerator = $RemainingArgs.GetEnumerator()
while ($Enumerator.MoveNext()) {
$Arg = $Enumerator.Current
if ($Arg -is [Hashtable]) {
$SplatArgs += $Arg
} elseif ($Arg -is [string] -and $Arg.StartsWith('-')) {
$ParamName = $Arg.TrimStart('-')
$HasNextArg = $RemainingArgs.IndexOf($Arg) -lt ($RemainingArgs.Count - 1)
if ($HasNextArg) {
$NextArg = $RemainingArgs[$RemainingArgs.IndexOf($Arg) + 1]
if ($NextArg -is [string] -and !$NextArg.StartsWith('-')) {
$SplatArgs[$ParamName] = $NextArg
$Enumerator.MoveNext() # Skip NextArg
continue
}
}
# Must be a flag.
$SplatArgs[$ParamName] = $true
} else {
throw "Positional parameter '$Arg' found. The Invoke-BuildStep function only supports named parameters after the required Name and Platform parameters."
}
}
}

Expand Down Expand Up @@ -1179,15 +1189,15 @@ function Get-PinnedToolchainToolsDir() {
}
}

$VariantToolchainPath = [IO.Path]::Combine($ToolchainsRoot, "$(Get-PinnedToolchainVersion)+$PinnedToolchainVariant", "usr", "bin")
$VariantToolchainPath = [IO.Path]::Combine($ToolchainsRoot, "$(Get-PinnedToolchainVersion)+Asserts", "usr", "bin")

if (Test-Path $VariantToolchainPath) {
return $VariantToolchainPath
}

return [IO.Path]::Combine("$BinaryCache\", "toolchains", $PinnedToolchain,
"Library", "Developer", "Toolchains",
"unknown-$PinnedToolchainVariant-development.xctoolchain", "usr", "bin")
"unknown-Asserts-development.xctoolchain", "usr", "bin")
}

function Get-PinnedToolchainSDK() {
Expand Down Expand Up @@ -1673,7 +1683,7 @@ function Build-WiXProject() {

$MSBuildArgs = @( "-noLogo", "-maxCpuCount", "-restore", "$SourceCache\swift-installer-scripts\platforms\Windows\$FileName" )
foreach ($Property in $Properties.GetEnumerator()) {
if ($Property.Value.Contains(" ")) {
if ($Property.Value -is [string] -and $Property.Value.Contains(" ")) {
$MSBuildArgs += "-p:$($Property.Key)=$($Property.Value.Replace('\', '\\'))"
} else {
$MSBuildArgs += "-p:$($Property.Key)=$($Property.Value)"
Expand All @@ -1694,7 +1704,7 @@ function Build-CMark([Hashtable] $Platform) {
Build-CMakeProject `
-Src $SourceCache\cmark `
-Bin (Get-CMarkBinaryCache $Platform) `
-InstallTo "$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+$Variant\usr" `
-InstallTo "$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+Asserts\usr" `
-Platform $Platform `
-Defines @{
BUILD_SHARED_LIBS = "YES";
Expand Down Expand Up @@ -1737,7 +1747,7 @@ function Build-BuildTools([Hashtable] $Platform) {
SWIFT_INCLUDE_APINOTES = "NO";
SWIFT_INCLUDE_DOCS = "NO";
SWIFT_INCLUDE_TESTS = "NO";
"cmark-gfm_DIR" = "$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+$Variant\usr\lib\cmake";
"cmark-gfm_DIR" = "$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+Asserts\usr\lib\cmake";
}
}

Expand Down Expand Up @@ -1773,7 +1783,7 @@ function Load-LitTestOverrides($Filename) {
}
}

function Get-CompilersDefines([Hashtable] $Platform, [switch] $Test) {
function Get-CompilersDefines([Hashtable] $Platformm, [string] $Variant, [switch] $Test) {
$BuildTools = [IO.Path]::Combine((Get-ProjectBinaryCache $BuildPlatform BuildTools), "bin")
$PythonRoot = [IO.Path]::Combine((Get-PythonPath $Platform), "tools")
$PythonLibName = "python{0}{1}" -f ([System.Version]$PythonVersion).Major, ([System.Version]$PythonVersion).Minor
Expand Down Expand Up @@ -1848,7 +1858,7 @@ function Get-CompilersDefines([Hashtable] $Platform, [switch] $Test) {
}
}

function Build-Compilers([Hashtable] $Platform) {
function Build-Compilers([Hashtable] $Platform, [string] $Variant) {
New-Item -ItemType SymbolicLink -Path "$BinaryCache\$($HostPlatform.Triple)\compilers" -Target "$BinaryCache\5" -ErrorAction Ignore
Build-CMakeProject `
-Src $SourceCache\llvm-project\llvm `
Expand All @@ -1859,7 +1869,7 @@ function Build-Compilers([Hashtable] $Platform) {
-UsePinnedCompilers Swift `
-BuildTargets @("install-distribution") `
-CacheScript $SourceCache\swift\cmake\caches\Windows-$($Platform.Architecture.LLVMName).cmake `
-Defines (Get-CompilersDefines $Platform)
-Defines (Get-CompilersDefines $Platform $Variant)

$Settings = @{
FallbackLibrarySearchPaths = @("usr/bin")
Expand All @@ -1869,10 +1879,10 @@ function Build-Compilers([Hashtable] $Platform) {
Write-PList -Settings $Settings -Path "$($Platform.ToolchainInstallRoot)\ToolchainInfo.plist"
}

function Test-Compilers([Hashtable] $Platform, [switch] $TestClang, [switch] $TestLLD, [switch] $TestLLDB, [switch] $TestLLVM, [switch] $TestSwift) {
function Test-Compilers([Hashtable] $Platform, [string] $Variant, [switch] $TestClang, [switch] $TestLLD, [switch] $TestLLDB, [switch] $TestLLVM, [switch] $TestSwift) {
Invoke-IsolatingEnvVars {
$env:Path = "$(Get-CMarkBinaryCache $Platform)\src;$(Get-ProjectBinaryCache $BuildPlatform Compilers)\tools\swift\libdispatch-windows-$($Platform.Architecture.LLVMName)-prefix\bin;$(Get-ProjectBinaryCache $BuildPlatform Compilers)\bin;$env:Path;$VSInstallRoot\DIA SDK\bin\$($HostPlatform.Architecture.VSName);$UnixToolsBinDir"
$TestingDefines = Get-CompilersDefines $Platform -Test
$TestingDefines = Get-CompilersDefines $Platform $Variant -Test
if ($TestLLVM) { $Targets += @("check-llvm") }
if ($TestClang) { $Targets += @("check-clang") }
if ($TestLLD) { $Targets += @("check-lld") }
Expand Down Expand Up @@ -1984,19 +1994,26 @@ function Build-mimalloc() {
"ld.lld.exe",
"ld64.lld.exe"
)
foreach ($Tool in $Tools) {
$Binary = [IO.Path]::Combine($Platform.ToolchainInstallRoot, "usr", "bin", $Tool)
$Binaries = $Tools | ForEach-Object {[IO.Path]::Combine($Platform.ToolchainInstallRoot, "usr", "bin", $_)}
if ($IncludeNoAsserts) {
$NoAssertBinaries = $Tools `
| ForEach-Object {[IO.Path]::Combine($Platform.NoAssertsToolchainInstallRoot, "usr", "bin", $_)} `
| Where-Object { Test-Path $_ -PathType Leaf }
$Binaries = $Binaries + $NoAssertBinaries
}
foreach ($Binary in $Binaries) {
$Name = [IO.Path]::GetFileName($Binary)
# Binary-patch in place
Invoke-Program "$SourceCache\mimalloc\bin\minject$BuildSuffix" "-f" "-i" "$Binary"
# Log the import table
$LogFile = "$BinaryCache\$($Platform.Triple)\mimalloc\minject-log-$Tool.txt"
$ErrorFile = "$BinaryCache\$($Platform.Triple)\mimalloc\minject-log-$Tool-error.txt"
$LogFile = "$BinaryCache\$($Platform.Triple)\mimalloc\minject-log-$Name.txt"
$ErrorFile = "$BinaryCache\$($Platform.Triple)\mimalloc\minject-log-$Name-error.txt"
Invoke-Program "$SourceCache\mimalloc\bin\minject$BuildSuffix" "-l" "$Binary" -OutFile $LogFile -ErrorFile $ErrorFile
# Verify patching
$Found = Select-String -Path $LogFile -Pattern "mimalloc"
if (-not $Found) {
Get-Content $ErrorFile
throw "Failed to patch mimalloc for $Tool"
throw "Failed to patch mimalloc for $Name"
}
}
}
Expand Down Expand Up @@ -3232,8 +3249,8 @@ function Test-PackageManager() {
-Src $SrcDir `
-Bin "$BinaryCache\$($HostPlatform.Triple)\PackageManagerTests" `
-Platform $HostPlatform `
-Xcc "-I$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+$Variant\usr\include" `
-Xlinker "-L$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+$Variant\usr\lib"
-Xcc "-I$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+Asserts\usr\include" `
-Xlinker "-L$(Get-InstallDir $Platform)\Toolchains\$ProductVersion+Asserts\usr\lib"
}

function Build-Installer([Hashtable] $Platform) {
Expand Down Expand Up @@ -3261,6 +3278,7 @@ function Build-Installer([Hashtable] $Platform) {
$Properties["Platforms"] = "`"windows$(if ($Android) { ";android" })`"";
$Properties["AndroidArchitectures"] = "`"$(($AndroidSDKPlatforms | ForEach-Object { $_.Architecture.LLVMName }) -Join ";")`""
$Properties["WindowsArchitectures"] = "`"$(($WindowsSDKPlatforms | ForEach-Object { $_.Architecture.LLVMName }) -Join ";")`""
$Properties["ToolchainVariants"] = "`"asserts$(if ($IncludeNoAsserts) { ";noasserts" })`"";
foreach ($SDKPlatform in $WindowsSDKPlatforms) {
$Properties["WindowsRuntime$($SDKPlatform.Architecture.ShortName.ToUpperInvariant())"] = [IO.Path]::Combine((Get-InstallDir $SDKPlatform), "Runtimes", "$ProductVersion");
}
Expand Down Expand Up @@ -3314,15 +3332,18 @@ if (-not $SkipBuild) {
Invoke-BuildStep Build-BuildTools $BuildPlatform
if ($IsCrossCompiling) {
Invoke-BuildStep Build-XML2 $BuildPlatform
Invoke-BuildStep Build-Compilers $BuildPlatform
Invoke-BuildStep Build-Compilers $BuildPlatform -Variant "Asserts"
}
if ($IncludeDS2) {
Invoke-BuildStep Build-RegsGen2 $BuildPlatform
}

Invoke-BuildStep Build-CMark $HostPlatform
Invoke-BuildStep Build-XML2 $HostPlatform
Invoke-BuildStep Build-Compilers $HostPlatform
Invoke-BuildStep Build-Compilers $HostPlatform -Variant "Asserts"
if ($IncludeNoAsserts) {
Invoke-BuildStep Build-Compilers $HostPlatform -Variant "NoAsserts"
}

Invoke-BuildStep Build-SDK $BuildPlatform -IncludeMacros

Expand Down Expand Up @@ -3419,7 +3440,7 @@ if (-not $IsCrossCompiling) {
"-TestLLVM" = $Test -contains "llvm";
"-TestSwift" = $Test -contains "swift";
}
Invoke-BuildStep Test-Compilers $HostPlatform $Tests
Invoke-BuildStep Test-Compilers $HostPlatform "Asserts" $Tests
}

# FIXME(jeffdav): Invoke-BuildStep needs a platform dictionary, even though the Test-
Expand Down