Build: Replace use of Yasm with use of Nasm for Windows assembly.

Match BoringSSL. According to the Chromium discussion about nasm, it
is also substantially faster.

Author: briansmith

.github/workflows/ci.yml

@@ -63,9 +63,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - run: >
-          (powershell -ExecutionPolicy Bypass ./mk/install-build-tools.ps1) -and
-          ("$pwd\target\tools" >> $env:GITHUB_PATH)
+      - run: powershell -ExecutionPolicy Bypass ./mk/install-build-tools.ps1
 
       - uses: actions-rs/toolchain@v1
         with:

BUILDING.md

@@ -26,15 +26,16 @@ Builds directly from Git
 ------------------------
 
 If you want to hack on *ring* then you need to build it directly from its Git
-repository. In this case, you must also have Perl installed, because the
-assembly language modules inherited from BoringSSL (inherited from OpenSSL)
-use Perl as a macro assembly language.
+repository. There are some additional requirements for doing this that do not
+apply when building from crates.io:
 
-When building from Git for Windows, directories containing yasm.exe and
-perl.exe must be in `%PATH%`, where yasm.exe is
-[Yasm](http://yasm.tortall.net/Download.html) 1.3 or later and where perl.exe
-is recommended to be [Strawberry Perl](http://strawberryperl.com).
+* For any target for which *ring* has assembly language implementations of
+  primitives (32- and 64- bit Intel, and 32- and 64-bit ARM), Perl must be
+  installed and in `$PATH`.
 
+* For Windows targets, `target/tools/nasm[.exe]` is used as the assembler;
+  [mk/install-build-tools.ps1](mk/install-build-tools.ps1) downloads it for
+  Windows hosts.
 
 Cross Compiling
 ---------------

build.rs

@@ -322,7 +322,7 @@ fn pregenerate_asm_main() {
                 let srcs = asm_srcs(perlasm_src_dsts);
                 for src in srcs {
                     let obj_path = obj_path(&pregenerated, &src, MSVC_OBJ_EXT);
-                    run_command(yasm(&src, target_arch, &obj_path));
+                    run_command(nasm(&src, target_arch, &obj_path));
                 }
             }
         }
@@ -523,7 +523,7 @@ fn compile(
             let cmd = if target.os != WINDOWS || ext != "asm" {
                 cc(p, ext, target, warnings_are_errors, &out_path)
             } else {
-                yasm(p, &target.arch, &out_path)
+                nasm(p, &target.arch, &out_path)
             };
 
             run_command(cmd);
@@ -637,21 +637,20 @@ fn cc(
     c
 }
 
-fn yasm(file: &Path, arch: &str, out_file: &Path) -> Command {
-    let (oformat, machine) = match arch {
-        "x86_64" => ("--oformat=win64", "--machine=amd64"),
-        "x86" => ("--oformat=win32", "--machine=x86"),
+fn nasm(file: &Path, arch: &str, out_file: &Path) -> Command {
+    let oformat = match arch {
+        "x86_64" => ("win64"),
+        "x86" => ("win32"),
         _ => panic!("unsupported arch: {}", arch),
     };
-    let mut c = Command::new("yasm.exe");
+    let mut c = Command::new("./target/tools/nasm");
     let _ = c
-        .arg("-X")
-        .arg("vc")
-        .arg("--dformat=cv8")
-        .arg(oformat)
-        .arg(machine)
         .arg("-o")
         .arg(out_file.to_str().expect("Invalid path"))
+        .arg("-f")
+        .arg(oformat)
+        .arg("-Xgnu")
+        .arg("-gcv8")
         .arg(file);
     c
 }

mk/install-build-tools.ps1

@@ -1,30 +1,67 @@
-function Download-File {
+function Verify-Or-Delete-File {
     param (
         [Parameter(Mandatory)]
-        [string]$Url,
+        [string]$File,
         [Parameter(Mandatory)]
-        [string]$ExpectedDigest,
-        [Parameter(Mandatory)]
-        [string]$OutFile
+        [string]$ExpectedDigest
     )
-    $TmpFile = New-TemporaryFile
-    Invoke-WebRequest -Uri $Url -OutFile $TmpFile.FullName
-    $ActualDigest = ( Get-FileHash -Algorithm SHA256 $TmpFile ).Hash
+    $ActualDigest = ( Get-FileHash -Algorithm SHA256 $File ).Hash
     if ( $ActualDigest -eq $ExpectedDigest )
     {
-        Move-Item -Force $TmpFile $OutFile
         return
     }
-
+    rm $File
     echo "Digest verification failed for $Url; actual $ActualDigest, expected $ExpectedDigest"
-    rm $TmpFile
     exit 1
 }
 
+function Download-Zip-and-Extract-File {
+    param (
+        [Parameter(Mandatory)]
+        [string]$Uri,
+        [Parameter(Mandatory)]
+        [string]$ZipExpectedDigest,
+        [Parameter(Mandatory)]
+        [string]$PathWithinZip,
+        [Parameter(Mandatory)]
+        [string]$FileExpectedDigest,
+        [Parameter(Mandatory)]
+        [string]$OutFile
+    )
+    $TmpZip = New-TemporaryFile
+    Invoke-WebRequest -Uri $Uri -OutFile $TmpZip.FullName
+    echo $TmpZip
+    Verify-Or-Delete-File -File $TmpZip.FullName -ExpectedDigest $ZipExpectedDigest
+
+    Add-Type -AssemblyName System.IO.Compression.FileSystem
+    $zip = [System.IO.Compression.ZipFile]::OpenRead($TmpZip)
+    $zip.Entries |
+        Where-Object { $_.FullName -eq $PathWithinZip } |
+        ForEach-Object {
+            $TmpFile = New-TemporaryFile
+            # extract the selected items from the ZIP archive
+            # and copy them to the out folder
+            $FileName = $_.Name
+            [System.IO.Compression.ZipFileExtensions]::ExtractToFile($_, "$TmpFile", $true)
+            Verify-Or-Delete-File -File $TmpFile -ExpectedDigest $FileExpectedDigest
+            Move-Item -Force $TmpFile $OutFile
+        }
+    $zip.Dispose()
+}
+
 $tools_dir = "target/tools"
 mkdir -Force $tools_dir
 
-Download-File `
-    -Url 'https://www.tortall.net/projects/yasm/releases/yasm-1.3.0-win64.exe' `
-    -ExpectedDigest D160B1D97266F3F28A71B4420A0AD2CD088A7977C2DD3B25AF155652D8D8D91F `
-    -OutFile $tools_dir/yasm.exe
+# This is the file BoringSSL refers to in
+# https://boringssl.googlesource.com/boringssl/+/26f8297177ad8033cc39de84afe9c2000430a66d.
+$nasm_version = "nasm-2.13.03"
+$nasm_zip = "$nasm_version-win64.zip"
+$nasm_zip_sha256 = "B3A1F896B53D07854884C2E0D6BE7DEFBA7EBD09B864BBB9E6D69ADA1C3E989F"
+$nasm_exe = "nasm.exe"
+$nasm_exe_sha256 = "D8A933BF5CC3597C56193135CB78B225AB225E1F611D2FDB51EF6E3F555B21E3"
+Download-Zip-and-Extract-File `
+    -Uri "https://www.nasm.us/pub/nasm/releasebuilds/2.13.03/win64/$nasm_zip" `
+    -ZipExpectedDigest "$nasm_zip_sha256" `
+    -PathWithinZip "$nasm_version/$nasm_exe" `
+    -FileExpectedDigest "$nasm_exe_sha256" `
+    -OutFile "$tools_dir/$nasm_exe"