Use JNA/WMI instead of PowerShell to list Windows processes

changelog/unreleased/GITHUB#4718-jna-wmi-windows-process-list.yml

@@ -0,0 +1,13 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+
+title: >
+  SolrProcessManager now uses JNA/WMI to list Java processes on Windows, instead of spawning an
+  external PowerShell process
+type: changed
+authors:
+  - name: Jan Høydahl
+  - name: Chan Chan
+    nick: chan-dx
+links:
+  - name: GITHUB#4718
+    url: https://github.com/apache/solr/pull/4718

gradle/libs.versions.toml

@@ -388,6 +388,7 @@ jersey-media-jsonjackson = { module = "org.glassfish.jersey.media:jersey-media-j
 jetbrains-annotations = { module = "org.jetbrains:annotations", version.ref = "jetbrains-annotations" }
 # @keep transitive dependency for version alignment
 jna = { module = "net.java.dev.jna:jna", version.ref = "jna" }
+jna-platform = { module = "net.java.dev.jna:jna-platform", version.ref = "jna" }
 # @keep transitive dependency for version alignment
 jodatime-jodatime = { module = "joda-time:joda-time", version.ref = "joda-time" }
 junit-junit = { module = "junit:junit", version.ref = "junit" }

gradle/testing/randomization/policies/solr-tests.policy

@@ -261,8 +261,10 @@ grant {
 
   // Run java
   permission java.io.FilePermission "${java.home}${/}-", "execute";
-  // Required by SolrProcessManager on Windows to find Solr processes, used by StatusTool (CLI)
-  permission java.io.FilePermission "<<ALL FILES>>", "execute";
+  // Required by SolrProcessManager on Windows to find Solr processes (used by StatusTool CLI):
+  // JNA queries WMI, which loads the native jnidispatch library and reads jna.* system properties.
+  permission java.lang.RuntimePermission "loadLibrary.*";
+  permission java.util.PropertyPermission "jna.*", "read";
 };
 
 // Grant all permissions to Gradle test runner classes.

solr/api/gradle.lockfile

@@ -88,6 +88,8 @@ jakarta.xml.bind:jakarta.xml.bind-api:3.0.1=swaggerBuild
 jakarta.xml.bind:jakarta.xml.bind-api:4.0.2=jarValidation,testRuntimeClasspath
 javax.inject:javax.inject:1=annotationProcessor,errorprone,testAnnotationProcessor
 junit:junit:4.13.2=jarValidation,testCompileClasspath,testRuntimeClasspath
+net.java.dev.jna:jna-platform:5.19.1=jarValidation,testRuntimeClasspath
+net.java.dev.jna:jna:5.19.1=jarValidation,testRuntimeClasspath
 org.antlr:antlr4-runtime:4.13.2=jarValidation,testRuntimeClasspath
 org.apache.commons:commons-exec:1.6.0=jarValidation,testRuntimeClasspath
 org.apache.commons:commons-lang3:3.20.0=jarValidation,swaggerBuild,testRuntimeClasspath

solr/benchmark/gradle.lockfile

@@ -77,6 +77,8 @@ jakarta.ws.rs:jakarta.ws.rs-api:4.0.0=jarValidation,runtimeClasspath,testRuntime
 jakarta.xml.bind:jakarta.xml.bind-api:4.0.2=jarValidation,runtimeClasspath,testRuntimeClasspath
 javax.inject:javax.inject:1=annotationProcessor,errorprone,testAnnotationProcessor
 junit:junit:4.13.2=compileClasspath,jarValidation,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+net.java.dev.jna:jna-platform:5.19.1=jarValidation,runtimeClasspath,testRuntimeClasspath
+net.java.dev.jna:jna:5.19.1=jarValidation,runtimeClasspath,testRuntimeClasspath
 net.sf.jopt-simple:jopt-simple:5.0.4=annotationProcessor,compileClasspath,jarValidation,runtimeClasspath,testAnnotationProcessor,testCompileClasspath,testRuntimeClasspath
 org.antlr:antlr4-runtime:4.13.2=jarValidation,runtimeClasspath,testRuntimeClasspath
 org.apache.commons:commons-exec:1.6.0=jarValidation,runtimeClasspath,testRuntimeClasspath

solr/core/build.gradle

@@ -154,6 +154,9 @@ dependencies {
 
   implementation libs.apache.commons.exec
 
+  // Used by SolrProcessManager to query running processes via WMI on Windows
+  implementation libs.jna.platform
+
   implementation libs.apache.log4j.api
   implementation libs.apache.log4j.core
   runtimeOnly libs.apache.log4j.slf4j2impl

solr/core/gradle.lockfile

@@ -85,6 +85,8 @@ jakarta.xml.bind:jakarta.xml.bind-api:4.0.2=cliDocsRuntime,jarValidation,runtime
 javax.inject:javax.inject:1=annotationProcessor,errorprone,testAnnotationProcessor
 junit:junit:4.13.2=jarValidation,testCompileClasspath,testRuntimeClasspath
 net.bytebuddy:byte-buddy:1.18.11=jarValidation,testCompileClasspath,testRuntimeClasspath
+net.java.dev.jna:jna-platform:5.19.1=cliDocsRuntime,compileClasspath,jarValidation,runtimeClasspath,runtimeLibs,testCompileClasspath,testRuntimeClasspath
+net.java.dev.jna:jna:5.19.1=cliDocsRuntime,compileClasspath,jarValidation,runtimeClasspath,runtimeLibs,testCompileClasspath,testRuntimeClasspath
 org.antlr:antlr4-runtime:4.13.2=cliDocsRuntime,jarValidation,runtimeClasspath,runtimeLibs,testRuntimeClasspath
 org.apache.commons:commons-exec:1.6.0=cliDocsRuntime,compileClasspath,jarValidation,runtimeClasspath,runtimeLibs,testCompileClasspath,testRuntimeClasspath
 org.apache.commons:commons-lang3:3.20.0=cliDocsRuntime,compileClasspath,jarValidation,runtimeClasspath,runtimeLibs,testCompileClasspath,testRuntimeClasspath

solr/core/src/java/org/apache/solr/cli/SolrProcessManager.java

@@ -18,12 +18,12 @@
 
 import static org.apache.solr.servlet.CoreContainerProvider.SOLR_INSTALL_DIR;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import com.sun.jna.platform.win32.COM.COMUtils;
+import com.sun.jna.platform.win32.COM.WbemcliUtil.WmiQuery;
+import com.sun.jna.platform.win32.COM.WbemcliUtil.WmiResult;
+import com.sun.jna.platform.win32.Ole32;
 import java.io.IOException;
 import java.lang.invoke.MethodHandles;
-import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
@@ -37,7 +37,6 @@
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
-import org.apache.commons.io.IOUtils;
 import org.apache.lucene.util.Constants;
 import org.apache.solr.common.SolrException;
 import org.apache.solr.common.util.EnvUtils;
@@ -160,7 +159,7 @@ private boolean isProcessSsl(ProcessHandle ph) {
 
   /**
    * Gets the command line of a process as a string. For Windows, we need to fetch command lines
-   * using a PowerShell command.
+   * from WMI (see {@link #commandLinesWindows()}).
    *
    * @param ph the process handle
    * @return the command line of the process
@@ -174,55 +173,45 @@ private static Optional<String> commandLine(ProcessHandle ph) {
   }
 
   /**
-   * Gets the command lines of all java processes on Windows using PowerShell.
+   * WMI columns to select from {@code Win32_Process}. The enum constant names are used verbatim as
+   * the WQL {@code SELECT} column names (WQL is case-insensitive).
+   */
+  enum ProcessProperty {
+    PROCESSID,
+    COMMANDLINE
+  }
+
+  /**
+   * Gets the command lines of all java processes on Windows by querying WMI ({@code Win32_Process})
+   * through JNA. This avoids spawning an external PowerShell process.
    *
    * @return a map of process IDs to command lines
    */
   private static Map<Long, String> commandLinesWindows() {
+    COMUtils.checkRC(Ole32.INSTANCE.CoInitializeEx(null, Ole32.COINIT_MULTITHREADED));
     try {
-      Process process =
-          new ProcessBuilder(
-                  "powershell.exe",
-                  "-Command",
-                  "Get-CimInstance -ClassName Win32_Process | Where-Object { $_.Name -like '*java*' } | Select-Object ProcessId, CommandLine | ConvertTo-Json -Depth 1")
-              .redirectErrorStream(true)
-              .start();
-      String output = IOUtils.toString(process.getInputStream(), StandardCharsets.UTF_8);
-      int exitCode = process.waitFor();
-      if (exitCode != 0) {
-        String errorText = IOUtils.toString(process.getErrorStream(), StandardCharsets.UTF_8);
-        throw new SolrException(
-            SolrException.ErrorCode.SERVER_ERROR,
-            "Error getting command lines for Windows: " + errorText);
+      // Filter to java processes in the WQL query itself; LIKE is case-insensitive in WMI, so this
+      // matches processes named e.g. "java.exe" while letting WMI do the filtering.
+      WmiResult<ProcessProperty> result =
+          new WmiQuery<>("Win32_Process WHERE Name LIKE '%java%'", ProcessProperty.class).execute();
+      Map<Long, String> pidToCommandLine = new HashMap<>();
+      for (int i = 0; i < result.getResultCount(); i++) {
+        Object commandLine = result.getValue(ProcessProperty.COMMANDLINE, i);
+        Object processId = result.getValue(ProcessProperty.PROCESSID, i);
+        // CommandLine can be null if the current user cannot read it for that process
+        if (commandLine != null && processId != null) {
+          pidToCommandLine.put(((Number) processId).longValue(), commandLine.toString());
+        }
       }
-      return parseWindowsPidToCommandLineJson(output);
-    } catch (IOException e) {
+      return pidToCommandLine;
+    } catch (RuntimeException e) {
       throw new SolrException(
-          SolrException.ErrorCode.SERVER_ERROR, "Error getting command lines for Windows");
-    } catch (InterruptedException e) {
-      Thread.currentThread().interrupt();
-      throw new SolrException(
-          SolrException.ErrorCode.SERVER_ERROR,
-          "Interrupted while getting command lines for Windows");
+          SolrException.ErrorCode.SERVER_ERROR, "Error getting command lines for Windows", e);
+    } finally {
+      Ole32.INSTANCE.CoUninitialize();
     }
   }
 
-  static Map<Long, String> parseWindowsPidToCommandLineJson(String jsonString)
-      throws JsonProcessingException {
-    // Json format: [{"ProcessId": 1234, "CommandLine": "java foo"}]
-    ObjectMapper mapper = new ObjectMapper();
-    List<WindowsProcessInfo> processInfoList =
-        mapper.readValue(jsonString, new TypeReference<>() {});
-    return processInfoList.stream()
-        .filter(p -> p.CommandLine != null)
-        .collect(Collectors.toMap(p -> p.ProcessId, p -> p.CommandLine));
-  }
-
-  public static class WindowsProcessInfo {
-    public long ProcessId;
-    public String CommandLine;
-  }
-
   /**
    * Gets the arguments of a process as a list of strings. With workaround for Windows.
    *

solr/core/src/test/org/apache/solr/cli/SolrProcessManagerTest.java

@@ -16,7 +16,6 @@
  */
 package org.apache.solr.cli;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
@@ -28,7 +27,6 @@
 import java.nio.file.Path;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.Map;
 import java.util.stream.Collectors;
 import org.apache.commons.math3.util.Pair;
 import org.apache.solr.SolrTestCase;
@@ -175,15 +173,6 @@ public void testSolrProcessMethods() {
     assertEquals("https://localhost:" + processHttps.getKey() + "/solr", https.getLocalUrl());
   }
 
-  public void testParseWindowsPidToCommandLineJson() throws JsonProcessingException {
-    String jsonResponseFromPowershell =
-        "[{\"ProcessId\": 9356, \"CommandLine\":  \"date\"}, {\"ProcessId\": 4736, \"CommandLine\":  null}\n]";
-    Map<Long, String> pidToCommandLine =
-        SolrProcessManager.parseWindowsPidToCommandLineJson(jsonResponseFromPowershell);
-    assertEquals(1, pidToCommandLine.size());
-    assertEquals("date", pidToCommandLine.get(9356L));
-  }
-
   /**
    * This class is started as new java process by {@link SolrProcessManagerTest#createProcess}, and
    * it listens to an HTTP(s) port to simulate a real Solr process.

solr/cross-dc-manager/gradle.lockfile

@@ -94,7 +94,8 @@ javax.inject:javax.inject:1=annotationProcessor,errorprone,testAnnotationProcess
 junit:junit:4.13.2=jarValidation,testCompileClasspath,testRuntimeClasspath
 net.bytebuddy:byte-buddy-agent:1.18.11=jarValidation,testRuntimeClasspath
 net.bytebuddy:byte-buddy:1.18.11=jarValidation,testRuntimeClasspath
-net.java.dev.jna:jna:5.19.1=jarValidation,testCompileClasspath,testRuntimeClasspath
+net.java.dev.jna:jna-platform:5.19.1=jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testRuntimeClasspath
+net.java.dev.jna:jna:5.19.1=jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testCompileClasspath,testRuntimeClasspath
 org.antlr:antlr4-runtime:4.13.2=jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testRuntimeClasspath
 org.apache.commons:commons-compress:1.28.0=jarValidation,testCompileClasspath,testRuntimeClasspath
 org.apache.commons:commons-exec:1.6.0=jarValidation,runtimeClasspath,runtimeLibs,solrPlatformLibs,testRuntimeClasspath