add start scripts to detect jemalloc presence

Signed-off-by: Gabriel Fukushima <[email protected]>

build.gradle

@@ -570,11 +570,11 @@ task autocomplete(type: JavaExec) {
 }
 
 installDist {
-  dependsOn checkLicense, autocomplete
+  dependsOn checkLicense, startScripts, autocomplete
 }
 
 distTar {
-  dependsOn checkLicense, autocomplete
+  dependsOn checkLicense, startScripts, autocomplete
   doFirst {
     delete fileTree(dir: 'build/distributions', include: '*.tar.gz')
   }
@@ -587,7 +587,7 @@ distTar {
 }
 
 distZip {
-  dependsOn checkLicense, autocomplete
+  dependsOn checkLicense, startScripts, autocomplete
   doFirst {
     delete fileTree(dir: 'build/distributions', include: '*.zip')
   }
@@ -599,6 +599,8 @@ distZip {
 
 startScripts {
 
+  unixStartScriptGenerator.template = resources.text.fromFile("${projectDir}/teku/src/main/scripts/unixStartScript.txt")
+
   def shortenWindowsClasspath = { line ->
     line = line.replaceAll(/^set CLASSPATH=.*$/, "set CLASSPATH=%APP_HOME%/lib/*")
   }

teku/src/main/scripts/unixStartScript.txt

@@ -0,0 +1,304 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+##############################################################################
+#
+#   ${applicationName} start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh ${applicationName}
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «\$var», «\${var}», «\${var:-default}», «\${var+SET}»,
+#           «\${var#prefix}», «\${var%suffix}», and «\$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "\$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and ${optsEnvironmentVar}) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#<% /*
+#       ... and if you're reading this, this IS the template just mentioned.
+#
+#       This template is processed by
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/java/org/gradle/api/internal/plugins/UnixStartScriptGenerator.java
+#
+#       Gradle is a meta-build system used by the project that you're building
+#       or installing. It's like autoconf but for projects that are written in
+#       Java and related languages. It's also used to build parts of the Gradle
+#       project itself.
+#
+#       The Groovy template language is run in two phases.
+#
+#        1. Any character following \ is passed unmodified through to the
+#           next phase, while the \ is removed. Any other $ followed by
+#           varName or {varName} is replaced by the value of that variable.
+#
+#        2. The result of the first phase is parsed and run in a similar
+#           manner to JSP or MASON or PHP: anything within < % ... % > is a
+#           code block, anything else is sent as output, subject to the
+#           flow imposed by any code segments.
+#
+#        3. The "output" is a POSIX shell script, which has its own ideas about
+#           escaping with backslashes, so to get «\» you need to write «\\\\»
+#           and to get «$» you need to write «\\\$».
+#
+#       For more details about the Groovy Template Engine, see
+#       https://docs.groovy-lang.org/next/html/documentation/ section §3.15
+#       (Template Engines) for details.
+#
+#       (An example invocation of this template is from
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/build-init/src/main/java/org/gradle/api/tasks/wrapper/Wrapper.java
+#       within the Gradle project, which builds "gradlew".)
+# */ %>
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: \$0 may be a link
+app_path=\$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=\${app_path%"\${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "\$app_path" ]
+do
+    ls=\$( ls -ld "\$app_path" )
+    link=\${ls#*' -> '}
+    case \$link in             #(
+      /*)   app_path=\$link ;; #(
+      *)    app_path=\$APP_HOME\$link ;;
+    esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=\${0##*/}
+# Discard cd standard output in case \$CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=\$( cd -P "\${APP_HOME:-./}${appHomeRelativePath}" > /dev/null && printf '%s\n' "\$PWD" ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "\$*"
+} >&2
+
+die () {
+    echo
+    echo "\$*"
+    echo
+    exit 1
+} >&2
+
+# 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  ;; #(
+  MSYS* | 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
+    if ! command -v java >/dev/null 2>&1
+    then
+        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
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "\$cygwin" && ! "\$darwin" && ! "\$nonstop" ; then
+    case \$MAX_FD in #(
+      max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        MAX_FD=\$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case \$MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        ulimit -n "\$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to \$MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and ${optsEnvironmentVar} environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "\$cygwin" || "\$msys" ; 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" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case \$arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=\${arg#/} t=/\${t%%/*}              # looks like a POSIX filepath
+                    [ -e "\$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=\$( cygpath --path --ignore --mixed "\$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "\$@" "\$arg"      # push replacement arg
+    done
+fi
+
+<% /*
+# The DEFAULT_JVM_OPTS variable is intentionally defined here to allow using cygwin-processed APP_HOME.
+# So far the only way to inject APP_HOME reference into DEFAULT_JVM_OPTS is to post-process the start script; the declaration is a good anchor to do that.
+*/ %>
+# Add default JVM options here. You can also use JAVA_OPTS and ${optsEnvironmentVar} to pass JVM options to this script.
+DEFAULT_JVM_OPTS=${defaultJvmOpts}
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect \${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '\${Hostname}' itself on the command line.
+
+set -- \\
+<% if ( appNameSystemProperty ) {
+     %>        "-D${appNameSystemProperty}=\$APP_BASE_NAME" \\
+<% } %>        -classpath "\$CLASSPATH" \\
+<% if ( mainClassName.startsWith('--module ') ) {
+     %>        --module-path "\$MODULE_PATH" \\
+<% } %>        ${mainClassName} \\
+        "\$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"\$var" ) &&
+#   set -- "\${ARGS[@]}" "\$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- \$(
+        printf '%s\\n' "\$DEFAULT_JVM_OPTS \$JAVA_OPTS \$${optsEnvironmentVar}" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\\\&~g; ' |
+        tr '\\n' ' '
+    )" '"\$@"'
+
+unset TEKU_USING_JEMALLOC
+if [ "\$darwin" = "false" -a "\$msys" = "false" ]; then
+  # check if jemalloc is available
+  TEST_JEMALLOC=\$(LD_PRELOAD=libjemalloc.so sh -c true 2>&1)
+
+  # if jemalloc is available the output is empty, otherwise the output has an error line
+  if [ -z "\$TEST_JEMALLOC" ]; then
+    export LD_PRELOAD=libjemalloc.so
+    export TEKU_USING_JEMALLOC=true
+  fi
+fi
+
+exec "\$JAVACMD" "\$@"