Always run Turbine native image with a UTF-8 code page on Windows

We are building Turbine native images with a UTF-8 code page and need to match the runtime code page for UTF-8 paths to be handled properly. This change splits the existing tool for patching the app manifest of the embedded JDK into separate tools for reading and writing app manifests. The write tool is then used to add a manifest to the turbine binary.

Closes #25444.

PiperOrigin-RevId: 735457536
Change-Id: Id6395435cc350772e1225ecb80fa32a74f6ae0e3

Author: fmeum

src/BUILD

@@ -181,24 +181,31 @@ filegroup(
     visibility = ["//src/test/shell/bazel:__pkg__"],
 )
 
-# This program patches the app manifest of the java.exe launcher to force its
-# active code page to UTF-8 on Windows 1903 and later, which is required for
-# proper support of Unicode characters outside the system code page.
-# The JDK currently (as of JDK 23) doesn't support this natively:
-# https://mail.openjdk.org/pipermail/core-libs-dev/2024-November/133773.html
+# Reads the app manifest of a Windows executable.
 cc_binary(
-    name = "patch_java_manifest_for_utf8",
-    srcs = ["patch_java_manifest_for_utf8.cc"],
+    name = "read_manifest",
+    srcs = ["read_manifest.cc"],
     tags = ["manual"],
     target_compatible_with = ["@platforms//os:windows"],
+    visibility = ["//src/java_tools:__subpackages__"],
+)
+
+# Updates the app manifest of a Windows executable.
+cc_binary(
+    name = "write_manifest",
+    srcs = ["write_manifest.cc"],
+    tags = ["manual"],
+    target_compatible_with = ["@platforms//os:windows"],
+    visibility = ["//src/java_tools:__subpackages__"],
 )
 
 sh_binary(
     name = "minimize_jdk",
     srcs = ["minimize_jdk.sh"],
     data = select({
         "@platforms//os:windows": [
-            ":patch_java_manifest_for_utf8",
+            ":read_manifest",
+            ":write_manifest",
         ],
         "//conditions:default": [],
     }),

src/java_tools/buildjar/java/com/google/devtools/build/java/turbine/BUILD

@@ -1,5 +1,5 @@
 load("@rules_graalvm//graalvm:defs.bzl", "native_image")
-load("@rules_java//java:defs.bzl", "java_binary")
+load("@rules_java//java:defs.bzl", "java_binary", "java_library")
 
 package(
     default_applicable_licenses = ["//:license"],
@@ -26,13 +26,21 @@ java_binary(
     runtime_deps = [":turbine_deps"],
 )
 
-native_image(
+alias(
     name = "turbine_direct_graal",
+    actual = select({
+        "@platforms//os:windows": ":turbine_direct_graal_with_app_manifest",
+        "//conditions:default": ":turbine_direct_graal_unpatched",
+    }),
+)
+
+native_image(
+    name = "turbine_direct_graal_unpatched",
     executable_name = select({
         # TODO(cushon): restore .exe suffix on windows
         # see https://github.com/sgammon/rules_graalvm/issues/324
-        "@bazel_tools//src/conditions:windows": "%target%",
-        "//conditions:default": "%target%",
+        "@bazel_tools//src/conditions:windows": "turbine_direct_graal_unpatched",
+        "//conditions:default": "turbine_direct_graal",
     }),
     extra_args = [
         # Workaround for https://github.com/oracle/graal/issues/4757.
@@ -74,6 +82,26 @@ native_image(
     deps = [":turbine_deps"],
 )
 
+# On Windows, add an app manifest to the binary to force it to run with a UTF-8
+# code page. It is built with one, but without the app manifest it will not be
+# able to use UTF-8 for filesystem operations.
+# https://github.com/oracle/graal/issues/10237
+genrule(
+    name = "turbine_direct_graal_with_app_manifest",
+    srcs = [
+        ":turbine_direct_graal_unpatched",
+        "turbine_direct_graal.manifest",
+    ],
+    outs = ["turbine_direct_graal.exe"],
+    cmd = """\
+cp $(location :turbine_direct_graal_unpatched) $@
+chmod +w $@
+cat $(location turbine_direct_graal.manifest) | $(location //src:write_manifest) $@
+""",
+    target_compatible_with = ["@platforms//os:windows"],
+    tools = ["//src:write_manifest"],
+)
+
 # Run with -c opt.
 sh_binary(
     name = "turbine_benchmark",

src/java_tools/buildjar/java/com/google/devtools/build/java/turbine/turbine_direct_graal.manifest

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<assembly xmlns="urn:schemas-microsoft-com:asm.v1"
+          manifestVersion="1.0"
+          xmlns:asmv3="urn:schemas-microsoft-com:asm.v3"
+>
+<assemblyIdentity
+    name="turbine_direct_graal.exe"
+    version = "1.0.0.0"
+    type="win32"
+/>
+<description>Turbine</description>
+
+  <asmv3:application>
+    <asmv3:windowsSettings>
+        <activeCodePage xmlns="http://schemas.microsoft.com/SMI/2019/WindowsSettings">UTF-8</activeCodePage>
+    </asmv3:windowsSettings>
+  </asmv3:application>
+
+</assembly>

src/minimize_jdk.sh

@@ -61,7 +61,6 @@ fi
 UNAME=$(uname -s | tr 'A-Z' 'a-z')
 
 if [[ "$UNAME" =~ msys_nt* ]]; then
-  set -x
   mkdir "tmp.$$"
   cd "tmp.$$"
   unzip -q "../$fulljdk"
@@ -73,7 +72,14 @@ if [[ "$UNAME" =~ msys_nt* ]]; then
   ./bin/jlink --module-path ./jmods/ --add-modules "$modules" \
     --vm=server --strip-debug --no-man-pages \
     --output reduced
-  "$(rlocation "io_bazel/src/patch_java_manifest_for_utf8.exe")" reduced/bin/java.exe
+  # Patch the app manifest of the java.exe launcher to force its active code
+  # page to UTF-8 on Windows 1903 and later, which is required for proper
+  # support of Unicode characters outside the system code page.
+  # The JDK currently (as of JDK 23) doesn't support this natively:
+  # https://mail.openjdk.org/pipermail/core-libs-dev/2024-November/133773.html
+  "$(rlocation io_bazel/src/read_manifest.exe)" reduced/bin/java.exe \
+    | sed 's|</asmv3:windowsSettings>|<activeCodePage xmlns="http://schemas.microsoft.com/SMI/2019/WindowsSettings">UTF-8</activeCodePage>&|' \
+    | "$(rlocation io_bazel/src/write_manifest.exe)" reduced/bin/java.exe
   cp $DOCS legal/java.base/ASSEMBLY_EXCEPTION \
     reduced/
   # These are necessary for --host_jvm_debug to work.

src/patch_java_manifest_for_utf8.cc

@@ -0,0 +1,62 @@
+// Copyright 2024 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+
+#include <string>
+
+// Extracts the app manifest of a Windows executable and prints it to stdout.
+int wmain(int argc, wchar_t *argv[]) {
+  if (argc != 2) {
+    fwprintf(stderr, L"Usage: %ls <filename>\n", argv[0]);
+    return 1;
+  }
+
+  // Read the app manifest (aka side-by-side or fusion manifest) from the
+  // executable, which requires loading it as a "module".
+  HMODULE exe = LoadLibraryExW(argv[1], nullptr, LOAD_LIBRARY_AS_DATAFILE);
+  if (!exe) {
+    fwprintf(stderr, L"Error loading file %ls: %d\n", argv[1], GetLastError());
+    return 1;
+  }
+  HRSRC manifest_resource = FindResourceA(exe, MAKEINTRESOURCE(1), RT_MANIFEST);
+  if (!manifest_resource) {
+    fwprintf(stderr, L"Resource not found: %d\n", GetLastError());
+    return 1;
+  }
+  HGLOBAL manifest_handle = LoadResource(exe, manifest_resource);
+  if (!manifest_handle) {
+    fwprintf(stderr, L"Error loading resource: %d\n", GetLastError());
+    return 1;
+  }
+  LPVOID manifest_data = LockResource(manifest_handle);
+  if (!manifest_data) {
+    fwprintf(stderr, L"Error locking resource: %d\n", GetLastError());
+    return 1;
+  }
+  DWORD manifest_len = SizeofResource(exe, manifest_resource);
+
+  // Write the manifest to stdout.
+  fwrite(manifest_data, 1, manifest_len, stdout);
+
+  UnlockResource(manifest_handle);
+  FreeResource(manifest_handle);
+  FreeLibrary(exe);
+
+  return 0;
+}

src/read_manifest.cc

@@ -1990,32 +1990,24 @@ EOF
 }
 
 function test_header_compiler_direct_supports_unicode() {
-  if [[ "${JAVA_TOOLS_ZIP}" == released ]]; then
+  if [[ "${JAVA_TOOLS_ZIP}" == released && "$is_windows" ]]; then
       # TODO: Enable test after the next java_tools release.
       return 0
   fi
 
-  if "$is_windows"; then
-    # GraalVM native images on Windows use the same active code page they have been built
-    # with, which in the case of Bazel CI is 1252 (not UTF-8). Even with -H:+AddAllCharsets
-    # InvalidPathExceptions are still thrown when accessing a Unicode file path, indicating a
-    # problem within GraalVM's path encoding handling.
-    # https://github.com/oracle/graal/issues/10237
-    # TODO: Fix this by building java_tools binaries on a machine with system code page set to
-    #  UTF-8.
-    echo "Skipping test on Windows"
-    return 0
-  elif [[ "$(uname -s)" == "Linux" ]]; then
+  # JVMs on macOS always support UTF-8 since JEP 400.
+  # Windows releases of Turbine are built on a machine with system code page set
+  # to UTF-8 so that Graal picks up the correct sun.jnu.encoding value *and*
+  # have an app manifest patched in to set the system code page to UTF-8 at
+  # runtime.
+  if [[ "$(uname -s)" == "Linux" ]]; then
     export LC_ALL=C.UTF-8
     if [[ $(locale charmap) != "UTF-8" ]]; then
       echo "Skipping test due to missing UTF-8 locale"
       return 0
     fi
-    local -r unicode="äöüÄÖÜß🌱"
-  else
-    # JVMs on macOS always support UTF-8 since JEP 400.
-    local -r unicode="äöüÄÖÜß🌱"
   fi
+  local -r unicode="äöüÄÖÜß🌱"
   mkdir -p pkg
   cat << EOF > pkg/BUILD
 java_library(name = "a", srcs = ["A.java"], deps = [":b"])