Add support for Windows ARM64

Author: dpaoliello

.cargo/config.toml

@@ -3,3 +3,6 @@ rustflags = ["-Ctarget-feature=+crt-static"]
 
 [target.i686-pc-windows-msvc]
 rustflags = ["-Ctarget-feature=+crt-static"]
+
+[target.aarch64-pc-windows-msvc]
+rustflags = ["-Ctarget-feature=+crt-static"]

.gitignore

@@ -21,6 +21,7 @@
 /dist-assets/openvpn.exe
 /dist-assets/aarch64-apple-darwin/
 /dist-assets/x86_64-apple-darwin/
+/dist-assets/aarch64-pc-windows-msvc/
 /windows/version.h
 /windows/**/bin/
 /windows/**/*.user

BuildInstructions.md

@@ -110,6 +110,21 @@ The host has to have the following installed:
 
 [Git for Windows]: https://git-scm.com/download/win
 
+### Experimental: Cross-compiling for ARM64
+
+By default, the app will build for the host platform. It is also possible to cross-compile the app
+for ARM64 on x64. This requires:
+
+- The ARM64 MSVC tools added to Visual Studio.
+
+- `clang` (either directly from llvm.org or as part of Visual Studio) on the `PATH`.
+
+- The `AArch64` target added to Rust:
+
+```bash
+rustup target add aarch64-pc-windows-msvc
+```
+
 ## macOS
 
 The host has to have the following installed:
@@ -146,6 +161,17 @@ variable to `aarch64-unknown-linux-gnu`:
 TARGETS="aarch64-unknown-linux-gnu" ./build.sh
 ```
 
+### Experimental: Windows
+
+ARM64 Windows is not yet fully working or supported.
+
+To cross-compile for ARM64 rather than the current architecture, set the `TARGETS` environment
+variable to `aarch64-pc-windows-msvc`:
+
+```bash
+TARGETS="aarch64-pc-windows-msvc" ./build.sh
+```
+
 ## Notes on building on ARM64 Linux hosts
 
 Due to inability to build the management interface proto files on ARM64 (see

CHANGELOG.md

@@ -26,6 +26,9 @@ Line wrap the file at 100 chars.                                              Th
 - Add DAITA (Defence against AI-guided Traffic Analysis) setting for Linux and macOS.
 - Add `--json` flag to `mullvad status` CLI.
 
+#### Windows
+- Add experimental support for Windows ARM64.
+
 ### Changed
 - Ignore obfuscation protocol constraints when the obfuscation mode is set to auto.
 

Cargo.lock

@@ -68,6 +68,7 @@ function get_solution_output_path {
     case $build_target in
         "x86") echo "$solution_root/bin/Win32-$build_mode";;
         "x64") echo "$solution_root/bin/x64-$build_mode";;
+        "ARM64") echo "$solution_root/bin/ARM64-$build_mode";;
         *)
             echo "Unknown build target: $build_target"
             exit 1

build-windows-modules.sh

@@ -285,21 +285,43 @@ function build {
             sign_win "$destination"
         fi
     done
+
+    if [[ "$current_target" == "aarch64-pc-windows-msvc" ]]; then
+        # TODO: We still ship x64 OpenVPN with ARM64, so we need an x64 talpid-openvpn-plugin
+        # to include in the package.
+        log_info "Workaround: building x64 talpid-openvpn-plugin"
+        cargo build --target x86_64-pc-windows-msvc "${CARGO_ARGS[@]}" -p talpid-openvpn-plugin --lib
+        cp "$CARGO_TARGET_DIR/x86_64-pc-windows-msvc/$RUST_BUILD_MODE/talpid_openvpn_plugin.dll" "dist-assets/aarch64-pc-windows-msvc/talpid_openvpn_plugin.dll"
+        if [[ "$SIGN" == "true" ]]; then
+            sign_win "dist-assets/talpid_openvpn_plugin.dll"
+        fi
+    fi
 }
 
 if [[ "$(uname -s)" == "MINGW"* ]]; then
-    log_header "Building C++ code in $CPP_BUILD_MODE mode"
-    CPP_BUILD_MODES=$CPP_BUILD_MODE IS_RELEASE=$IS_RELEASE ./build-windows-modules.sh
-
-    if [[ "$SIGN" == "true" ]]; then
-        CPP_BINARIES=(
-            "windows/winfw/bin/x64-$CPP_BUILD_MODE/winfw.dll"
-            "windows/driverlogic/bin/x64-$CPP_BUILD_MODE/driverlogic.exe"
-            # The nsis plugin is always built in 32 bit release mode
-            windows/nsis-plugins/bin/Win32-Release/*.dll
-        )
-        sign_win "${CPP_BINARIES[@]}"
-    fi
+    for t in "${TARGETS[@]:-"x86_64-pc-windows-msvc"}"; do
+        case $t in
+            x86_64-pc-windows-msvc) CPP_BUILD_TARGET=x64;;
+            aarch64-pc-windows-msvc) CPP_BUILD_TARGET=ARM64;;
+            *)
+                log_error "Unknown Windows target: $t"
+                exit 1
+                ;;
+        esac
+
+        log_header "Building C++ code in $CPP_BUILD_MODE mode for $CPP_BUILD_TARGET"
+        CPP_BUILD_MODES=$CPP_BUILD_MODE CPP_BUILD_TARGETS=$CPP_BUILD_TARGET IS_RELEASE=$IS_RELEASE ./build-windows-modules.sh
+
+        if [[ "$SIGN" == "true" ]]; then
+            CPP_BINARIES=(
+                "windows/winfw/bin/$CPP_BUILD_TARGET-$CPP_BUILD_MODE/winfw.dll"
+                "windows/driverlogic/bin/$CPP_BUILD_TARGET-$CPP_BUILD_MODE/driverlogic.exe"
+                # The nsis plugin is always built in 32 bit release mode
+                windows/nsis-plugins/bin/Win32-Release/*.dll
+            )
+            sign_win "${CPP_BINARIES[@]}"
+        fi
+    done
 fi
 
 for t in "${TARGETS[@]:-""}"; do

build.sh

@@ -204,6 +204,9 @@ function build_ref {
 
     case "$(uname -s)" in
         MINGW*|MSYS_NT*)
+            echo "Building ARM64 installers"
+            target=aarch64-pc-windows-msvc artifact_dir=$artifact_dir build "${build_args[@]}" || return 1
+
             echo "Packaging all PDB files..."
             find ./windows/ \
                 ./target/release/mullvad-daemon.pdb \
@@ -222,7 +225,7 @@ function build_ref {
         # Pipes all matching names and their new name to mv
         pushd "$artifact_dir"
         for original_file in MullvadVPN-*-dev-*{.deb,.rpm,.exe,.pkg}; do
-            new_file=$(echo "$original_file" | sed -nE "s/^(MullvadVPN-.*-dev-.*)(_amd64\.deb|_x86_64\.rpm|_arm64\.deb|_aarch64\.rpm|\.exe|\.pkg)$/\1$version_suffix\2/p")
+            new_file=$(echo "$original_file" | sed -nE "s/^(MullvadVPN-.*-dev-.*)(_amd64\.deb|_x86_64\.rpm|_arm64\.deb|_aarch64\.rpm|_x64\.exe|_arm64\.exe|\.pkg)$/\1$version_suffix\2/p")
             mv "$original_file" "$new_file"
         done
         popd

ci/buildserver-build.sh

@@ -86,7 +86,7 @@
 !macro ExtractDriverlogic
 
 	SetOutPath "$PLUGINSDIR"
-	File "${BUILD_RESOURCES_DIR}\..\windows\driverlogic\bin\x64-$%CPP_BUILD_MODE%\driverlogic.exe"
+	File "${BUILD_RESOURCES_DIR}\..\windows\driverlogic\bin\$%CPP_BUILD_TARGET%-$%CPP_BUILD_MODE%\driverlogic.exe"
 
 !macroend
 
@@ -100,8 +100,8 @@
 !macro ExtractWireGuard
 
 	SetOutPath "$PLUGINSDIR"
-	File "${BUILD_RESOURCES_DIR}\binaries\x86_64-pc-windows-msvc\wintun\wintun.dll"
-	File "${BUILD_RESOURCES_DIR}\binaries\x86_64-pc-windows-msvc\wireguard-nt\mullvad-wireguard.dll"
+	File "${BUILD_RESOURCES_DIR}\binaries\$%TARGET_TRIPLE%\wintun\wintun.dll"
+	File "${BUILD_RESOURCES_DIR}\binaries\$%TARGET_TRIPLE%\wireguard-nt\mullvad-wireguard.dll"
 
 !macroend
 
@@ -115,8 +115,8 @@
 !macro ExtractMullvadSetup
 
 	SetOutPath "$PLUGINSDIR"
-	File "${BUILD_RESOURCES_DIR}\mullvad-setup.exe"
-	File "${BUILD_RESOURCES_DIR}\..\windows\winfw\bin\x64-$%CPP_BUILD_MODE%\winfw.dll"
+	File "${BUILD_RESOURCES_DIR}\$%SETUP_SUBDIR%\mullvad-setup.exe"
+	File "${BUILD_RESOURCES_DIR}\..\windows\winfw\bin\$%CPP_BUILD_TARGET%-$%CPP_BUILD_MODE%\winfw.dll"
 
 !macroend
 

dist-assets/binaries

@@ -132,26 +132,30 @@ const config = {
     target: [
       {
         target: 'nsis',
-        arch: ['x64'],
+        arch: getWindowsTargetArch(),
       },
     ],
-    artifactName: 'MullvadVPN-${version}.${ext}',
+    artifactName: 'MullvadVPN-${version}_${arch}.${ext}',
     publisherName: 'Mullvad VPN AB',
     extraResources: [
-      { from: distAssets('mullvad.exe'), to: '.' },
-      { from: distAssets('mullvad-problem-report.exe'), to: '.' },
-      { from: distAssets('mullvad-daemon.exe'), to: '.' },
-      { from: distAssets('talpid_openvpn_plugin.dll'), to: '.' },
+      { from: distAssets(path.join(getWindowsDistSubdir(), 'mullvad.exe')), to: '.' },
+      { from: distAssets(path.join(getWindowsDistSubdir(), 'mullvad-problem-report.exe')), to: '.' },
+      { from: distAssets(path.join(getWindowsDistSubdir(), 'mullvad-daemon.exe')), to: '.' },
+      { from: distAssets(path.join(getWindowsDistSubdir(), 'talpid_openvpn_plugin.dll')), to: '.' },
       {
-        from: root(path.join('windows', 'winfw', 'bin', 'x64-${env.CPP_BUILD_MODE}', 'winfw.dll')),
+        from: root(path.join('windows', 'winfw', 'bin', getWindowsTargetArch() + '-${env.CPP_BUILD_MODE}', 'winfw.dll')),
         to: '.',
       },
+      // TODO: OpenVPN does not have an ARM64 build yet.
       { from: distAssets('binaries/x86_64-pc-windows-msvc/openvpn.exe'), to: '.' },
-      { from: distAssets('binaries/x86_64-pc-windows-msvc/apisocks5.exe'), to: '.' },
-      { from: distAssets('binaries/x86_64-pc-windows-msvc/wintun/wintun.dll'), to: '.' },
-      { from: distAssets('binaries/x86_64-pc-windows-msvc/split-tunnel/mullvad-split-tunnel.sys'), to: '.' },
+      { from: distAssets(path.join('binaries', getWindowsTargetSubdir(), 'apisocks5.exe')), to: '.' },
+      { from: distAssets(path.join('binaries', getWindowsTargetSubdir(), 'wintun/wintun.dll')), to: '.' },
+      {
+        from: distAssets(path.join('binaries', getWindowsTargetSubdir(), 'split-tunnel/mullvad-split-tunnel.sys')),
+        to: '.'
+      },
       {
-        from: distAssets('binaries/x86_64-pc-windows-msvc/wireguard-nt/mullvad-wireguard.dll'),
+        from: distAssets(path.join('binaries', getWindowsTargetSubdir(), 'wireguard-nt/mullvad-wireguard.dll')),
         to: '.',
       },
       { from: distAssets('maybenot_machines'), to: '.' },
@@ -250,6 +254,19 @@ function packWin() {
       asarUnpack: ['build/assets/images/menubar-icons/win32/lock-*.ico'],
       beforeBuild: (options) => {
         process.env.CPP_BUILD_MODE = release ? 'Release' : 'Debug';
+        process.env.CPP_BUILD_TARGET = options.arch;
+        switch (options.arch) {
+          case 'x64':
+            process.env.TARGET_TRIPLE = 'x86_64-pc-windows-msvc';
+            process.env.SETUP_SUBDIR = '.';
+            break;
+          case 'arm64':
+            process.env.TARGET_TRIPLE = 'aarch64-pc-windows-msvc';
+            process.env.SETUP_SUBDIR = 'aarch64-pc-windows-msvc';
+            break;
+          default:
+            throw new Error(`Invalid or unknown target (only one may be specified)`);
+        }
         return true;
       },
       afterAllArtifactBuild: (buildResult) => {
@@ -392,8 +409,38 @@ function root(relativePath) {
   return path.join(path.resolve(__dirname, '../../'), relativePath);
 }
 
+function getWindowsDistSubdir() {
+  if (targets === 'aarch64-pc-windows-msvc') {
+    return targets;
+  } else {
+    return '';
+  }
+}
+
+function getWindowsTargetArch() {
+  if (targets && process.platform === 'win32') {
+    if (targets === 'aarch64-pc-windows-msvc') {
+      return 'arm64';
+    }
+    throw new Error(`Invalid or unknown target (only one may be specified)`);
+  }
+  // Use host architecture (we assume this is x64 since building on Arm64 isn't supported).
+  return 'x64';
+}
+
+function getWindowsTargetSubdir() {
+  if (targets && process.platform === 'win32') {
+    if (targets === 'aarch64-pc-windows-msvc') {
+      return targets;
+    }
+    throw new Error(`Invalid or unknown target (only one may be specified)`);
+  }
+  // Use host architecture (we assume this is x64 since building on Arm64 isn't supported).
+  return 'x86_64-pc-windows-msvc';
+}
+
 function getLinuxTargetArch() {
-  if (targets) {
+  if (targets && process.platform === 'linux') {
     if (targets === 'aarch64-unknown-linux-gnu') {
       return 'arm64';
     }
@@ -404,7 +451,7 @@ function getLinuxTargetArch() {
 }
 
 function getLinuxTargetSubdir() {
-  if (targets) {
+  if (targets && process.platform === 'linux') {
     if (targets === 'aarch64-unknown-linux-gnu') {
       return targets;
     }

dist-assets/windows/installer.nsh

@@ -10,10 +10,7 @@ use std::{
 };
 use talpid_types::ErrorExt;
 use talpid_windows::process::{ModuleEntry, ProcessSnapshot};
-use winapi::{
-    um::winnt::{CONTEXT_CONTROL, CONTEXT_INTEGER, CONTEXT_SEGMENTS},
-    vc::excpt::EXCEPTION_EXECUTE_HANDLER,
-};
+use winapi::vc::excpt::EXCEPTION_EXECUTE_HANDLER;
 use windows_sys::Win32::{
     Foundation::{BOOL, HANDLE},
     System::{
@@ -219,7 +216,61 @@ unsafe extern "system" fn logging_exception_filter(info: *const EXCEPTION_POINTE
     EXCEPTION_EXECUTE_HANDLER
 }
 
+#[cfg(target_arch = "aarch64")]
+fn get_context_info(context: &CONTEXT) -> String {
+    use winapi::um::winnt::{CONTEXT_CONTROL, CONTEXT_FLOATING_POINT, CONTEXT_INTEGER};
+
+    let mut context_str = "Context:\n".to_string();
+
+    if context.ContextFlags & CONTEXT_CONTROL != 0 {
+        writeln!(
+            &mut context_str,
+            "\n\tFp: {:#x?}\n \
+             \tLr: {:#x?}\n \
+             \tSp: {:#x?}\n \
+             \tPc: {:#x?}\n \
+             \tCpsr: {:#x?}",
+            unsafe { context.Anonymous.Anonymous.Fp },
+            unsafe { context.Anonymous.Anonymous.Lr },
+            context.Sp,
+            context.Pc,
+            context.Cpsr
+        )
+        .unwrap();
+    }
+
+    if context.ContextFlags & CONTEXT_INTEGER != 0 {
+        context_str.push('\n');
+        for x in 0..=28 {
+            writeln!(&mut context_str, "\tX{}: {:#x?}", x, unsafe {
+                context.Anonymous.X[x]
+            })
+            .unwrap();
+        }
+    }
+    if context.ContextFlags & CONTEXT_FLOATING_POINT != 0 {
+        writeln!(
+            &mut context_str,
+            "\n\tFpcr: {:#x?}\n \
+             \tFpsr: {:#x?}",
+            context.Fpcr, context.Fpsr
+        )
+        .unwrap();
+        for q in 0..=31 {
+            writeln!(&mut context_str, "\tQ{}: {:#x?}", q, unsafe {
+                context.V[q].B
+            })
+            .unwrap();
+        }
+    }
+
+    context_str
+}
+
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 fn get_context_info(context: &CONTEXT) -> String {
+    use winapi::um::winnt::{CONTEXT_CONTROL, CONTEXT_INTEGER, CONTEXT_SEGMENTS};
+
     let mut context_str = "Context:\n".to_string();
 
     if context.ContextFlags & CONTEXT_CONTROL != 0 {