Skip to content

Commit

Permalink
[Xamarin.Android.Build.Tasks] parse JDK release file directly (#8663)
Browse files Browse the repository at this point in the history 
Fixes: #8369

During Android project builds, the `<ValidateJavaVersion/>` MSBuild task
currently shells out to `java -version` and `javac -version` to
determine if we have a *valid* & usable JDK.

Unfortunately, some customer logs have reported build times that are
completely bananas:

    Task ValidateJavaVersion 23.469s
    ...
    Top 10 most expensive tasks
    ...
    ValidateJavaVersion = 3:46.740, 35 calls

`java -version` and/or `javac -version` must be quite slow! Reading the
source for OpenJDK, it appears that `java -version` actually starts a
JVM to call a single method:

* https://github.com/openjdk/jdk/blob/df370d725e5ae55a05479e8375bf665233ac3e44/src/java.base/share/native/libjli/java.c#L1895-L1913
* https://github.com/openjdk/jdk/blob/c9cacfb25d1f15c879c961d2965a63c9fe4d9fa7/src/java.base/share/classes/java/lang/VersionProps.java.template#L191-L233

That could explain the slowness?

To improve this, let's just parse the file:

* C:\Program Files\Microsoft\jdk-11.0.19.7-hotspot\release

With contents:

    IMPLEMENTOR="Microsoft"
    IMPLEMENTOR_VERSION="Microsoft-7621296"
    JAVA_VERSION="11.0.19"
    JAVA_VERSION_DATE="2023-04-18"
    LIBC="default"
    MODULES="java.base java.compiler java.datatransfer java.xml java.prefs java.desktop java.instrument java.logging java.management java.security.sasl java.naming java.rmi java.management.rmi java.net.http java.scripting java.security.jgss java.transaction.xa java.sql java.sql.rowset java.xml.crypto java.se java.smartcardio jdk.accessibility jdk.internal.vm.ci jdk.management jdk.unsupported jdk.internal.vm.compiler jdk.aot jdk.internal.jvmstat jdk.attach jdk.charsets jdk.compiler jdk.crypto.ec jdk.crypto.cryptoki jdk.crypto.mscapi jdk.dynalink jdk.internal.ed jdk.editpad jdk.hotspot.agent jdk.httpserver jdk.internal.le jdk.internal.opt jdk.internal.vm.compiler.management jdk.jartool jdk.javadoc jdk.jcmd jdk.management.agent jdk.jconsole jdk.jdeps jdk.jdwp.agent jdk.jdi jdk.jfr jdk.jlink jdk.jshell jdk.jsobject jdk.jstatd jdk.localedata jdk.management.jfr jdk.naming.dns jdk.naming.ldap jdk.naming.rmi jdk.net jdk.pack jdk.rmic jdk.scripting.nashorn jdk.scripting.nashorn.shell jdk.sctp jdk.security.auth jdk.security.jgss jdk.unsupported.desktop jdk.xml.dom jdk.zipfs"
    OS_ARCH="x86_64"
    OS_NAME="Windows"
    SOURCE=".:git:6171c19d2c18"

We can just call `StreamReader.ReadLine()` until `JAVA_VERSION="` is
found.

I kept the existing logic in place, with an escape hatch if it were ever
needed. After a few .NET 9 previews, we could consider removing old
logic entirely?

This logic is considerably faster, because we no longer launch a JVM!

* Before: Task ValidateJavaVersion 377ms
* After: Task ValidateJavaVersion 2ms

Where you can test the "Before" logic by passing
`-p:_AndroidUseJavaExeVersion=true`.

I assume the customer's log from before (35 calls) would be around 70ms
give or take instead of 3 hours and 46 minutes? Even if this estimation
was 10x worse, it would still be a huge improvement! :eyes:
  • Loading branch information
@jonathanpeppers
jonathanpeppers committed Jan 23, 2024
1 parent 7b0e102 commit 766ac33
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 2 deletions.
6 changes: 5 additions & 1 deletion ...n.Android.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.Tooling.targets
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ This file contains .NET 6+ calls to the <ValidateJavaVersion/> and
<UsingTask TaskName="Xamarin.Android.Tasks.ValidateJavaVersion" AssemblyFile="$(_XamarinAndroidBuildTasksAssembly)" />

<Target Name="_ResolveAndroidTooling">
<PropertyGroup>
<_AndroidUseJavaExeVersion Condition=" '$(_AndroidUseJavaExeVersion)' == '' ">false</_AndroidUseJavaExeVersion>
</PropertyGroup>
<ValidateJavaVersion
Condition=" '$(DesignTimeBuild)' != 'True' Or '$(AndroidUseManagedDesignTimeResourceGenerator)' != 'True' "
ContinueOnError="$(_AndroidAllowMissingSdkTooling)"
Expand All @@ -24,7 +27,8 @@ This file contains .NET 6+ calls to the <ValidateJavaVersion/> and
JavacToolExe="$(JavacToolExe)"
TargetPlatformVersion="$(TargetPlatformVersion)"
LatestSupportedJavaVersion="$(LatestSupportedJavaVersion)"
MinimumSupportedJavaVersion="$(MinimumSupportedJavaVersion)">
MinimumSupportedJavaVersion="$(MinimumSupportedJavaVersion)"
UseJavaExeVersion="$(_AndroidUseJavaExeVersion)">
<Output TaskParameter="JdkVersion" PropertyName="_JdkVersion" />
<Output TaskParameter="MinimumRequiredJdkVersion" PropertyName="_DefaultJdkVersion" />
</ValidateJavaVersion>
Expand Down
51 changes: 50 additions & 1 deletion src/Xamarin.Android.Build.Tasks/Tasks/ValidateJavaVersion.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ public class ValidateJavaVersion : AndroidTask
[Required]
public string MinimumSupportedJavaVersion { get; set; }

/// <summary>
/// If true use the old method of calling `java -version` and `javac -version`
/// $(_AndroidUseJavaExeVersion) is passed in from MSBuild targets and defaults to false.
/// </summary>
public bool UseJavaExeVersion { get; set; } = true;

[Output]
public string MinimumRequiredJdkVersion { get; set; }

Expand Down Expand Up @@ -63,7 +69,7 @@ bool ValidateJava ()
var javac = JavacToolExe ?? (OS.IsWindows ? "javac.exe" : "javac");

return ValidateJava (java, JavaVersionRegex) &&
ValidateJava (javac, JavacVersionRegex);
(!UseJavaExeVersion || ValidateJava (javac, JavacVersionRegex));
}

protected virtual bool ValidateJava (string javaExe, Regex versionRegex)
Expand Down Expand Up @@ -97,6 +103,12 @@ protected virtual bool ValidateJava (string javaExe, Regex versionRegex)

protected Version GetVersionFromTool (string javaExe, Regex versionRegex)
{
// New code path, reads directly from `release` text file
if (!UseJavaExeVersion && GetVersionFromFile (javaExe, out var version)) {
JdkVersion = version.ToString ();
return version;
}

// NOTE: this doesn't need to use GetRegisteredTaskObjectAssemblyLocal()
// because the path to java/javac is the key and the value is a System.Version.
var javaTool = Path.Combine (JavaSdkPath, "bin", javaExe);
Expand Down Expand Up @@ -128,5 +140,42 @@ protected Version GetVersionFromTool (string javaExe, Regex versionRegex)
return null;
}
}

bool GetVersionFromFile (string javaExe, out Version version)
{
var path = Path.Combine (Path.GetDirectoryName (javaExe), "..", "release");
if (!File.Exists (path)) {
path = Path.Combine (JavaSdkPath, "release");
}
if (!File.Exists (path)) {
Log.LogDebugMessage ($"{path} does not exist, falling back to `java -version`");
version = new ();
return false;
}

using var stream = File.OpenRead (path);
using var reader = new StreamReader (stream);

string line;
while ((line = reader.ReadLine ()) != null) {
const string JAVA_VERSION = "JAVA_VERSION=\"";
int index = line.IndexOf (JAVA_VERSION, StringComparison.OrdinalIgnoreCase);
if (index != -1) {
var versionString = line.Substring (index + JAVA_VERSION.Length);
index = versionString.IndexOf ('"');
if (index != -1) {
versionString = versionString.Substring (0, index);
}
if (Version.TryParse (versionString, out version)) {
Log.LogDebugMessage ($"{path} contains JAVA_VERSION.");
return true;
}
}
}

Log.LogDebugMessage ($"{path} did not contain a valid JAVA_VERSION.");
version = new ();
return false;
}
}
}
52 changes: 52 additions & 0 deletions ...n.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/Tasks/ValidateJavaVersionTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,5 +148,57 @@ public void CacheInvalidates ()
Assert.IsTrue (validateJavaVersion.Execute (), "second Execute should succeed!");
Assert.IsFalse (messages.Any (m => m.Message.StartsWith ("Using cached value for", StringComparison.Ordinal)), "`java -version` should *not* be cached!");
}

[Test]
public void ReleaseFile_Valid ()
{
var javaPath = CreateFauxJavaSdkDirectory (Path.Combine (path, "jdk-1"), "11.0.9", out string javaExe, out string javacExe);
var releasePath = Path.Combine (Path.GetDirectoryName (javaExe), "..", "release");
File.WriteAllText (releasePath,
@"IMPLEMENTOR=""Microsoft""
IMPLEMENTOR_VERSION=""Microsoft-7621296""
JAVA_VERSION=""11.0.19""
JAVA_VERSION_DATE=""2023-04-18""
LIBC=""default""
MODULES=""java.base java.compiler java.datatransfer java.xml java.prefs java.desktop java.instrument java.logging java.management java.security.sasl java.naming java.rmi java.management.rmi java.net.http java.scripting java.security.jgss java.transaction.xa java.sql java.sql.rowset java.xml.crypto java.se java.smartcardio jdk.accessibility jdk.internal.vm.ci jdk.management jdk.unsupported jdk.internal.vm.compiler jdk.aot jdk.internal.jvmstat jdk.attach jdk.charsets jdk.compiler jdk.crypto.ec jdk.crypto.cryptoki jdk.crypto.mscapi jdk.dynalink jdk.internal.ed jdk.editpad jdk.hotspot.agent jdk.httpserver jdk.internal.le jdk.internal.opt jdk.internal.vm.compiler.management jdk.jartool jdk.javadoc jdk.jcmd jdk.management.agent jdk.jconsole jdk.jdeps jdk.jdwp.agent jdk.jdi jdk.jfr jdk.jlink jdk.jshell jdk.jsobject jdk.jstatd jdk.localedata jdk.management.jfr jdk.naming.dns jdk.naming.ldap jdk.naming.rmi jdk.net jdk.pack jdk.rmic jdk.scripting.nashorn jdk.scripting.nashorn.shell jdk.sctp jdk.security.auth jdk.security.jgss jdk.unsupported.desktop jdk.xml.dom jdk.zipfs""
OS_ARCH=""x86_64""
OS_NAME=""Windows""
SOURCE="".:git:6171c19d2c18""
");

var validateJavaVersion = new Android.Tasks.ValidateJavaVersion {
BuildEngine = engine,
JavaSdkPath = javaPath,
JavaToolExe = javaExe,
JavacToolExe = javacExe,
LatestSupportedJavaVersion = "17.99.0",
MinimumSupportedJavaVersion = "11.0.0",
UseJavaExeVersion = false,
};
Assert.IsTrue (validateJavaVersion.Execute (), "Execute should succeed!");
Assert.IsTrue (messages.Any (m => m.Message.Contains ("contains JAVA_VERSION")), "contains JAVA_VERSION should be found");
}

[Test]
public void ReleaseFile_Invalid ()
{
var javaPath = CreateFauxJavaSdkDirectory (Path.Combine (path, "jdk-1"), "11.0.9", out string javaExe, out string javacExe);
var releasePath = Path.Combine (Path.GetDirectoryName (javaExe), "..", "release");
File.WriteAllText (releasePath, "Just some random text");

var validateJavaVersion = new Android.Tasks.ValidateJavaVersion {
BuildEngine = engine,
JavaSdkPath = javaPath,
JavaToolExe = javaExe,
JavacToolExe = javacExe,
LatestSupportedJavaVersion = "17.99.0",
MinimumSupportedJavaVersion = "11.0.0",
UseJavaExeVersion = false,
};

// Will succeed due to fallback
Assert.IsTrue (validateJavaVersion.Execute (), "Execute should succeed!");
Assert.IsTrue (messages.Any (m => m.Message.Contains ("did not contain a valid JAVA_VERSION")), "valid JAVA_VERSION should *not* be found");
}
}
}

0 comments on commit 766ac33

Please sign in to comment.