|
| 1 | +#requires -Version 5.1 |
| 2 | +<# |
| 3 | +.SYNOPSIS |
| 4 | + Build yescrypt with the MSVC toolchain (port of the supplied GNU Makefile). |
| 5 | +
|
| 6 | +.DESCRIPTION |
| 7 | + Locates a Visual Studio / Build Tools installation with the C++ compiler |
| 8 | + using vswhere.exe, imports its x64 environment, and compiles the yescrypt |
| 9 | + "tests" and "phc-test" programs with cl.exe / link.exe. |
| 10 | +
|
| 11 | + The Makefile's "initrom" and "userom" programs are intentionally NOT built: |
| 12 | + they rely on POSIX shared memory (sys/shm.h) and mmap, which have no MSVC |
| 13 | + equivalent. "tests" and "phc-test" are what "make check" exercises. |
| 14 | +
|
| 15 | + Targets (mirroring the Makefile): |
| 16 | + build.ps1 # build tests.exe and phc-test.exe (optimized) |
| 17 | + build.ps1 -Target check # build and run both, verify against known-good |
| 18 | + build.ps1 -Target ref # build using the reference implementation |
| 19 | + build.ps1 -Target check-ref |
| 20 | + build.ps1 -Target clean # remove build artifacts |
| 21 | +
|
| 22 | +.NOTES |
| 23 | + Requires Visual Studio 2026 (Community is fine) with the |
| 24 | + "Desktop development with C++" workload installed. See the README section |
| 25 | + "How to test yescrypt for proper operation." for details. |
| 26 | +#> |
| 27 | +[CmdletBinding()] |
| 28 | +param( |
| 29 | + [ValidateSet('all', 'tests', 'phc-test', 'check', 'ref', 'check-ref', 'clean')] |
| 30 | + [string]$Target = 'all' |
| 31 | +) |
| 32 | + |
| 33 | +$ErrorActionPreference = 'Stop' |
| 34 | +Set-Location -LiteralPath $PSScriptRoot |
| 35 | + |
| 36 | +# --- Toolchain detection via vswhere.exe ------------------------------------ |
| 37 | + |
| 38 | +function Find-VsWhere { |
| 39 | + $candidates = @( |
| 40 | + (Join-Path ${env:ProgramFiles(x86)} 'Microsoft Visual Studio\Installer\vswhere.exe'), |
| 41 | + (Join-Path $env:ProgramFiles 'Microsoft Visual Studio\Installer\vswhere.exe') |
| 42 | + ) |
| 43 | + foreach ($c in $candidates) { |
| 44 | + if ($c -and (Test-Path -LiteralPath $c)) { return $c } |
| 45 | + } |
| 46 | + $cmd = Get-Command vswhere.exe -ErrorAction SilentlyContinue |
| 47 | + if ($cmd) { return $cmd.Source } |
| 48 | + throw "vswhere.exe not found. Install Visual Studio 2026 (it ships vswhere)." |
| 49 | +} |
| 50 | + |
| 51 | +function Get-VcVarsPath { |
| 52 | + $vswhere = Find-VsWhere |
| 53 | + # Require the x64/x86 C++ compiler toolset. |
| 54 | + $installPath = & $vswhere -latest -products * ` |
| 55 | + -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 ` |
| 56 | + -property installationPath |
| 57 | + if (-not $installPath) { |
| 58 | + throw "No Visual Studio installation with the C++ toolset was found. " + |
| 59 | + "Install the 'Desktop development with C++' workload." |
| 60 | + } |
| 61 | + $vcvars = Join-Path $installPath 'VC\Auxiliary\Build\vcvars64.bat' |
| 62 | + if (-not (Test-Path -LiteralPath $vcvars)) { |
| 63 | + throw "vcvars64.bat not found under '$installPath'." |
| 64 | + } |
| 65 | + return $vcvars |
| 66 | +} |
| 67 | + |
| 68 | +# Import the MSVC x64 environment (PATH, INCLUDE, LIB, ...) into this session. |
| 69 | +function Import-VcEnvironment { |
| 70 | + $vcvars = Get-VcVarsPath |
| 71 | + Write-Host "Using MSVC environment: $vcvars" |
| 72 | + $marker = '___VCVARS_ENV___' |
| 73 | + # vcvars64.bat may emit benign stderr noise; don't let it abort the script. |
| 74 | + $lines = & cmd /c "`"$vcvars`" 2>nul && echo $marker && set" |
| 75 | + $seen = $false |
| 76 | + foreach ($line in $lines) { |
| 77 | + if (-not $seen) { |
| 78 | + if ($line.Trim() -eq $marker) { $seen = $true } |
| 79 | + continue |
| 80 | + } |
| 81 | + if ($line -match '^([^=]+)=(.*)$') { |
| 82 | + Set-Item -Path ("Env:" + $matches[1]) -Value $matches[2] |
| 83 | + } |
| 84 | + } |
| 85 | + if (-not $seen) { throw "Failed to import the MSVC environment." } |
| 86 | +} |
| 87 | + |
| 88 | +# --- Compiler / linker settings (port of Makefile CFLAGS) ------------------- |
| 89 | + |
| 90 | +# /O2 -> -O2 |
| 91 | +# /D__SSE2__ -> enable the SSE2 intrinsic code path (MSVC x64 supports |
| 92 | +# <emmintrin.h>; this path is free of GCC inline asm). |
| 93 | +# /DSKIP_MEMZERO -> matches the Makefile's -DSKIP_MEMZERO. |
| 94 | +# OpenMP is intentionally not enabled: it is only used by userom, which is not |
| 95 | +# built here. |
| 96 | +$CFLAGS = @('/nologo', '/O2', '/MT', '/D__SSE2__', '/DSKIP_MEMZERO', '/wd4146', '/wd4244') |
| 97 | + |
| 98 | +$OBJS_COMMON = @('yescrypt-common.obj', 'sha256.obj', 'insecure_memzero.obj') |
| 99 | +$OBJS_CORE_OPT = 'yescrypt-opt.obj' |
| 100 | +$OBJS_CORE_REF = 'yescrypt-ref.obj' |
| 101 | + |
| 102 | +function Invoke-Tool { |
| 103 | + param([string]$Exe, [string[]]$Arguments) |
| 104 | + Write-Host ">> $Exe $($Arguments -join ' ')" |
| 105 | + # Send tool output to the host so it doesn't pollute function return values. |
| 106 | + & $Exe @Arguments | Out-Host |
| 107 | + if ($LASTEXITCODE -ne 0) { |
| 108 | + throw "$Exe failed with exit code $LASTEXITCODE" |
| 109 | + } |
| 110 | +} |
| 111 | + |
| 112 | +function Compile-One { |
| 113 | + param([string]$Source, [string]$Obj, [string[]]$ExtraFlags = @()) |
| 114 | + if (-not $Obj) { |
| 115 | + $Obj = [System.IO.Path]::GetFileNameWithoutExtension($Source) + '.obj' |
| 116 | + } |
| 117 | + Invoke-Tool 'cl' (@('/c') + $CFLAGS + $ExtraFlags + @("/Fo$Obj", $Source)) |
| 118 | + return $Obj |
| 119 | +} |
| 120 | + |
| 121 | +function Link-Exe { |
| 122 | + param([string]$Out, [string[]]$Objs) |
| 123 | + Invoke-Tool 'link' (@('/nologo', "/OUT:$Out") + $Objs) |
| 124 | +} |
| 125 | + |
| 126 | +# Compile the core + common objects shared by every program. |
| 127 | +function Build-Common { |
| 128 | + param([string]$Core = $OBJS_CORE_OPT) |
| 129 | + $coreSrc = if ($Core -eq $OBJS_CORE_REF) { 'yescrypt-ref.c' } else { 'yescrypt-opt.c' } |
| 130 | + Compile-One $coreSrc $Core | Out-Null |
| 131 | + Compile-One 'yescrypt-common.c' 'yescrypt-common.obj' | Out-Null |
| 132 | + Compile-One 'sha256.c' 'sha256.obj' | Out-Null |
| 133 | + Compile-One 'insecure_memzero.c' 'insecure_memzero.obj' | Out-Null |
| 134 | +} |
| 135 | + |
| 136 | +function Build-Tests { |
| 137 | + param([string]$Core = $OBJS_CORE_OPT) |
| 138 | + Build-Common -Core $Core |
| 139 | + Compile-One 'tests.c' 'tests.obj' | Out-Null |
| 140 | + Link-Exe 'tests.exe' (@($Core) + $OBJS_COMMON + @('tests.obj')) |
| 141 | + Write-Host "Built tests.exe" |
| 142 | +} |
| 143 | + |
| 144 | +function Build-PhcTest { |
| 145 | + param([string]$Core = $OBJS_CORE_OPT) |
| 146 | + Build-Common -Core $Core |
| 147 | + # phc-test is phc.c compiled with -DTEST (Makefile: phc-test.o). |
| 148 | + Compile-One 'phc.c' 'phc-test.obj' @('/DTEST') | Out-Null |
| 149 | + Link-Exe 'phc-test.exe' (@($Core) + $OBJS_COMMON + @('phc-test.obj')) |
| 150 | + Write-Host "Built phc-test.exe" |
| 151 | +} |
| 152 | + |
| 153 | +# Read a file as text with CRLF normalized to LF (MSVC's text-mode output uses |
| 154 | +# CRLF; the known-good files use LF). |
| 155 | +function Get-NormalizedText { |
| 156 | + param([string]$Path) |
| 157 | + return (Get-Content -Raw -LiteralPath $Path) -replace "`r`n", "`n" |
| 158 | +} |
| 159 | + |
| 160 | +function Invoke-Check { |
| 161 | + param([string]$Core = $OBJS_CORE_OPT) |
| 162 | + Build-Tests -Core $Core |
| 163 | + Build-PhcTest -Core $Core |
| 164 | + |
| 165 | + Write-Host 'Running main tests' |
| 166 | + & .\tests.exe | Out-File -Encoding ascii -FilePath 'TESTS-OUT' |
| 167 | + if ($LASTEXITCODE -ne 0) { throw "tests.exe failed with exit code $LASTEXITCODE" } |
| 168 | + $expected = (Get-NormalizedText 'TESTS-OK').TrimEnd("`n") |
| 169 | + $actual = (Get-NormalizedText 'TESTS-OUT').TrimEnd("`n") |
| 170 | + if ($expected -eq $actual) { |
| 171 | + Write-Host 'PASSED' -ForegroundColor Green |
| 172 | + } else { |
| 173 | + Write-Host 'FAILED' -ForegroundColor Red |
| 174 | + Compare-Object ($expected -split "`n") ($actual -split "`n") | |
| 175 | + Format-Table -AutoSize | Out-String | Write-Host |
| 176 | + exit 1 |
| 177 | + } |
| 178 | + |
| 179 | + if (Test-Path -LiteralPath 'PHC-TEST-OK-SHA256') { |
| 180 | + Write-Host 'Running PHC tests' |
| 181 | + # Capture raw stdout (text mode -> CRLF), then verify the LF-normalized |
| 182 | + # SHA-256 against the known-good digest in PHC-TEST-OK-SHA256. |
| 183 | + & cmd /c ".\phc-test.exe > PHC-TEST-OUT 2>nul" |
| 184 | + if ($LASTEXITCODE -ne 0) { throw "phc-test.exe failed with exit code $LASTEXITCODE" } |
| 185 | + |
| 186 | + $bytes = [System.Text.Encoding]::ASCII.GetBytes((Get-NormalizedText 'PHC-TEST-OUT')) |
| 187 | + $sha = [System.Security.Cryptography.SHA256]::Create() |
| 188 | + try { |
| 189 | + $got = -join ($sha.ComputeHash($bytes) | ForEach-Object { $_.ToString('x2') }) |
| 190 | + } finally { |
| 191 | + $sha.Dispose() |
| 192 | + } |
| 193 | + $expectedHash = ((Get-Content -Raw 'PHC-TEST-OK-SHA256').Trim() -split '\s+')[0].ToLower() |
| 194 | + if ($got -eq $expectedHash) { |
| 195 | + Write-Host 'PHC PASSED' -ForegroundColor Green |
| 196 | + } else { |
| 197 | + Write-Host "PHC FAILED (got $got, expected $expectedHash)" -ForegroundColor Red |
| 198 | + exit 1 |
| 199 | + } |
| 200 | + } |
| 201 | +} |
| 202 | + |
| 203 | +function Invoke-Clean { |
| 204 | + $patterns = @('*.obj', 'tests.exe', 'phc-test.exe', 'TESTS-OUT', 'PHC-TEST-OUT', |
| 205 | + '*.ilk', '*.pdb') |
| 206 | + foreach ($p in $patterns) { |
| 207 | + Get-ChildItem -LiteralPath $PSScriptRoot -Filter $p -ErrorAction SilentlyContinue | |
| 208 | + Remove-Item -Force -ErrorAction SilentlyContinue |
| 209 | + } |
| 210 | + Write-Host 'Cleaned build artifacts.' |
| 211 | +} |
| 212 | + |
| 213 | +# --- Dispatch --------------------------------------------------------------- |
| 214 | + |
| 215 | +switch ($Target) { |
| 216 | + 'clean' { Invoke-Clean; break } |
| 217 | + default { |
| 218 | + Import-VcEnvironment |
| 219 | + switch ($Target) { |
| 220 | + 'all' { Build-Tests; Build-PhcTest } |
| 221 | + 'tests' { Build-Tests } |
| 222 | + 'phc-test' { Build-PhcTest } |
| 223 | + 'check' { Invoke-Check } |
| 224 | + 'ref' { Build-Tests -Core $OBJS_CORE_REF; Build-PhcTest -Core $OBJS_CORE_REF } |
| 225 | + 'check-ref' { Invoke-Check -Core $OBJS_CORE_REF } |
| 226 | + } |
| 227 | + } |
| 228 | +} |
0 commit comments