From 421b225624fe5174b95b2975f125a06c3bfe496c Mon Sep 17 00:00:00 2001 From: Colin Alworth Date: Fri, 18 Feb 2022 13:57:35 -0600 Subject: [PATCH] Exclude certain engine methods from Tier 4 compilation (#1985) This commit excludes 60+ methods from hotspot's Tier 4 (aka C2) JIT compilation. Each of these has been found crash the certain JVM implementations (across vendors, across OSes, and across hardware archetectures) when it compiles this code, but not consistently. By excluding only C2 in this way, we allow C1 (aka Tier 1-3) to still run, and get better performance than interpreted bytecode. All existing ways to run code should be affected by this - running main()s or tests through either gradle or IntelliJ, and running our shell scripts to launch the server will all end up with a compiler directives file to disable c2 for these methods. Using the engine as a library is not fixed in this way, but this is a problem that can only be solved through documentation, to inform users that they should make sure to start the JVM with a specific set of flags. An extra array of "devJvmArgs" is left in the io.deephaven.java-conventions plugin to make it easier to add more flags later for this kind of problem - it will automatically be included for all of the above categories. Fixes #1529 --- .../io.deephaven.java-conventions.gradle | 109 +++++++++- .../src/main/resources/unixStartScript.txt | 188 ++++++++++++++++++ 2 files changed, 296 insertions(+), 1 deletion(-) create mode 100644 buildSrc/src/main/resources/unixStartScript.txt diff --git a/buildSrc/src/main/groovy/io.deephaven.java-conventions.gradle b/buildSrc/src/main/groovy/io.deephaven.java-conventions.gradle index 813d3dc1b23..03cae47335d 100644 --- a/buildSrc/src/main/groovy/io.deephaven.java-conventions.gradle +++ b/buildSrc/src/main/groovy/io.deephaven.java-conventions.gradle @@ -1,3 +1,5 @@ +import groovy.json.JsonBuilder + plugins { id 'java' } @@ -74,18 +76,123 @@ tasks.withType(JavaCompile).configureEach { } } +def tier4CompilationExcludes = [ + // All ChunkedSumOperators + 'io.deephaven.engine.table.impl.by.BigDecimalChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.BigIntegerChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.BooleanChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.ByteChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.CharChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.DoubleChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.FloatChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.IntChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.LongChunkedSumOperator':['addChunk'], + 'io.deephaven.engine.table.impl.by.ShortChunkedSumOperator':['addChunk'], + + // All PercentileTypeMedianHelpers + 'io.deephaven.engine.table.impl.by.ssmpercentile.BooleanPercentileTypeMedianHelper':['setResult'], + 'io.deephaven.engine.table.impl.by.ssmpercentile.BytePercentileTypeMedianHelper':['setResult'], + 'io.deephaven.engine.table.impl.by.ssmpercentile.CharPercentileTypeMedianHelper':['setResult'], + 'io.deephaven.engine.table.impl.by.ssmpercentile.DoublePercentileTypeMedianHelper':['setResult'], + 'io.deephaven.engine.table.impl.by.ssmpercentile.FloatPercentileTypeMedianHelper':['setResult'], + 'io.deephaven.engine.table.impl.by.ssmpercentile.IntPercentileTypeMedianHelper':['setResult'], + 'io.deephaven.engine.table.impl.by.ssmpercentile.LongPercentileTypeMedianHelper':['setResult'], + 'io.deephaven.engine.table.impl.by.ssmpercentile.ShortPercentileTypeMedianHelper':['setResult'], + + 'io.deephaven.engine.table.impl.by.ssmpercentile.SsmChunkedPercentileOperator':['addChunk'], + + // All types emitted by ReplicateHashTable + 'io.deephaven.engine.table.impl.IncrementalChunkedNaturalJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.RightIncrementalChunkedNaturalJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.StaticChunkedAsOfJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.StaticChunkedNaturalJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.RightIncrementalChunkedAsOfJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.SymbolTableCombiner':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.LeftOnlyIncrementalChunkedCrossJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.RightIncrementalChunkedCrossJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.StaticChunkedCrossJoinStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.by.StaticChunkedOperatorAggregationStateManager':['addToIndex', 'buildTable', 'decorationProbe'], + 'io.deephaven.engine.table.impl.by.IncrementalChunkedOperatorAggregationStateManager':['addToIndex', 'buildTable', 'decorationProbe'], +] +def createCompilerDirectives = tasks.register('createCompilerDirectives') { + def compilerDirectivesFile = project.layout.buildDirectory.file('dh-compiler-directives.txt') + it.outputs.file(compilerDirectivesFile) + + doFirst { + def excludesAsList = [] + tier4CompilationExcludes.forEach({type, methods -> + methods.forEach {method -> + excludesAsList += "${type}::${method}" + } + }) + def builder = new JsonBuilder([{ + match excludesAsList + c2 { + Exclude true + } + }]) + + compilerDirectivesFile.get().asFile.text = builder.toPrettyString() + } +} + +def c2ExcludesJvmArgs = { String c2ExcludesFile -> + return [ + '-XX:+UnlockDiagnosticVMOptions', + "-XX:CompilerDirectivesFile=${c2ExcludesFile}", + ] +} + +// Utility to add jvm args to all executions, whether intellij or from a application script or gradle javaexec +def devJvmArgs = [ +// '-XX:Tier4CompileThreshold=1000', // this optional line makes it easier to trigger the c2 error on the above methods +// '-XX:+PrintFlagsFinal', // this optional line makes it easier to explore the final values for compiler args +// '-XX:+PrintCompilation', // this optional line shows jit operations as they happen +] + tasks.withType(JavaExec).configureEach { + def c2ExcludesFile = createCompilerDirectives.get().outputs.files + inputs.files c2ExcludesFile javaLauncher.set runtimeLauncher + jvmArgs += c2ExcludesJvmArgs(c2ExcludesFile.singleFile.path) + devJvmArgs } tasks.withType(Test).configureEach { + def c2ExcludesFile = createCompilerDirectives.get().outputs.files + inputs.files c2ExcludesFile + javaLauncher.set testRuntimeLauncher + jvmArgs += c2ExcludesJvmArgs(c2ExcludesFile.singleFile.path) + devJvmArgs } tasks.withType(GroovyCompile).configureEach { javaLauncher.set groovyCompilerLauncher } +plugins.withType(ApplicationPlugin) { + applicationDistribution.into('lib') { + from(createCompilerDirectives.get().outputs.files) + } +} +tasks.withType(CreateStartScripts).configureEach { + def unixStartScript = resources.text.fromUri(getClass().classLoader.getResource('unixStartScript.txt')) + inputs.files unixStartScript + unixStartScriptGenerator.template = unixStartScript + // For now we only modify the *nix script, as the windows .bat file doesn't seem to work properly anyway, + // and we don't yet have a requirement for it. + windowsStartScriptGenerator.template = resources.text.fromString("echo Sorry, Windows .bat is not currently supported, please use WSL2\nexit 1") + +// def windowsStartScript = resources.text.fromUri(getClass().classLoader.getResource('windowsStartScript.txt')) +// inputs.files windowsStartScript +// windowsStartScriptGenerator.template = windowsStartScript + + // Note that we don't call c2ExcludesJvmArgs() at this time, there is no way to template those strings. + // Instead, we hard code the expected paths in the above templates to match the path lib/dh-compiler-directives.txt +// defaultJvmOpts += c2ExcludesJvmArgs(c2ExcludesFile.singleFile.path) + + defaultJvmOpts += devJvmArgs +} + tasks.withType(Jar).configureEach { Jar jar -> jar.preserveFileTimestamps = false @@ -107,4 +214,4 @@ jar { configurations { testOutput.extendsFrom testRuntimeClasspath -} \ No newline at end of file +} diff --git a/buildSrc/src/main/resources/unixStartScript.txt b/buildSrc/src/main/resources/unixStartScript.txt new file mode 100644 index 00000000000..44db5630994 --- /dev/null +++ b/buildSrc/src/main/resources/unixStartScript.txt @@ -0,0 +1,188 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# 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 +# +# https://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. +# + +############################################################################## +## +## ${applicationName} start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: \$0 may be a link +PRG="\$0" +# Need this for relative symlinks. +while [ -h "\$PRG" ] ; do + ls=`ls -ld "\$PRG"` + link=`expr "\$ls" : '.*-> \\(.*\\)\$'` + if expr "\$link" : '/.*' > /dev/null; then + PRG="\$link" + else + PRG=`dirname "\$PRG"`"/\$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"\$PRG\"`/${appHomeRelativePath}" >/dev/null +APP_HOME="`pwd -P`" +cd "\$SAVED" >/dev/null + +APP_NAME="${applicationName}" +APP_BASE_NAME=`basename "\$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and ${optsEnvironmentVar} to pass JVM options to this script. +DEFAULT_JVM_OPTS=${defaultJvmOpts} + +# Customization for deephaven-core to reference a compiler directives file +DEFAULT_JVM_OPTS="\${DEFAULT_JVM_OPTS} -XX:+UnlockDiagnosticVMOptions -XX:CompilerDirectivesFile=\"\${APP_HOME}/lib/dh-compiler-directives.txt\"" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "\$*" +} + +die () { + echo + echo "\$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$classpath +<% if ( mainClassName.startsWith('--module ') ) { %>MODULE_PATH=$modulePath<% } %> + +# Determine the Java command to use to start the JVM. +if [ -n "\$JAVA_HOME" ] ; then + if [ -x "\$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="\$JAVA_HOME/jre/sh/java" + else + JAVACMD="\$JAVA_HOME/bin/java" + fi + if [ ! -x "\$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: \$JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "\$cygwin" = "false" -a "\$darwin" = "false" -a "\$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ \$? -eq 0 ] ; then + if [ "\$MAX_FD" = "maximum" -o "\$MAX_FD" = "max" ] ; then + MAX_FD="\$MAX_FD_LIMIT" + fi + ulimit -n \$MAX_FD + if [ \$? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: \$MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: \$MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if \$darwin; then + GRADLE_OPTS="\$GRADLE_OPTS \\"-Xdock:name=\$APP_NAME\\" \\"-Xdock:icon=\$APP_HOME/media/gradle.icns\\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "\$cygwin" = "true" -o "\$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "\$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "\$CLASSPATH"` +<% if ( mainClassName.startsWith('--module ') ) { %> MODULE_PATH=`cygpath --path --mixed "\$MODULE_PATH"`<% } %> + JAVACMD=`cygpath --unix "\$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in \$ROOTDIRSRAW ; do + ROOTDIRS="\$ROOTDIRS\$SEP\$dir" + SEP="|" + done + OURCYGPATTERN="(^(\$ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "\$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="\$OURCYGPATTERN|(\$GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "\$@" ; do + CHECK=`echo "\$arg"|egrep -c "\$OURCYGPATTERN" -` + CHECK2=`echo "\$arg"|egrep -c "^-"` ### Determine if an option + + if [ \$CHECK -ne 0 ] && [ \$CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args\$i`=`cygpath --path --ignore --mixed "\$arg"` + else + eval `echo args\$i`="\"\$arg\"" + fi + i=`expr \$i + 1` + done + case \$i in + 0) set -- ;; + 1) set -- "\$args0" ;; + 2) set -- "\$args0" "\$args1" ;; + 3) set -- "\$args0" "\$args1" "\$args2" ;; + 4) set -- "\$args0" "\$args1" "\$args2" "\$args3" ;; + 5) set -- "\$args0" "\$args1" "\$args2" "\$args3" "\$args4" ;; + 6) set -- "\$args0" "\$args1" "\$args2" "\$args3" "\$args4" "\$args5" ;; + 7) set -- "\$args0" "\$args1" "\$args2" "\$args3" "\$args4" "\$args5" "\$args6" ;; + 8) set -- "\$args0" "\$args1" "\$args2" "\$args3" "\$args4" "\$args5" "\$args6" "\$args7" ;; + 9) set -- "\$args0" "\$args1" "\$args2" "\$args3" "\$args4" "\$args5" "\$args6" "\$args7" "\$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\\\n "\$i" | sed "s/'/'\\\\\\\\''/g;1s/^/'/;\\\$s/\\\$/' \\\\\\\\/" ; done + echo " " +} +APP_ARGS=`save "\$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- \$DEFAULT_JVM_OPTS \$JAVA_OPTS \$${optsEnvironmentVar} <% if ( appNameSystemProperty ) { %>"\"-D${appNameSystemProperty}=\$APP_BASE_NAME\"" <% } %>-classpath "\"\$CLASSPATH\"" <% if ( mainClassName.startsWith('--module ') ) { %>--module-path "\"\$MODULE_PATH\"" <% } %>${mainClassName} "\$APP_ARGS" + +exec "\$JAVACMD" "\$@"