Bug 647: Use bin/karaf arguments as JVM arguments
[odlparent.git] / karaf / opendaylight-karaf-resources / src / main / resources / bin / instance
1 #!/bin/bash
2 #
3 #    Licensed to the Apache Software Foundation (ASF) under one or more
4 #    contributor license agreements.  See the NOTICE file distributed with
5 #    this work for additional information regarding copyright ownership.
6 #    The ASF licenses this file to You under the Apache License, Version 2.0
7 #    (the "License"); you may not use this file except in compliance with
8 #    the License.  You may obtain a copy of the License at
9 #
10 #       http://www.apache.org/licenses/LICENSE-2.0
11 #
12 #    Unless required by applicable law or agreed to in writing, software
13 #    distributed under the License is distributed on an "AS IS" BASIS,
14 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 #    See the License for the specific language governing permissions and
16 #    limitations under the License.
17 #
18
19 realpath() {
20   OURPWD="$PWD"
21   cd "$(dirname "$1")"
22   LINK=$(readlink "$(basename "$1")")
23   while [ "$LINK" ]; do
24     cd "$(dirname "$LINK")"
25     LINK=$(readlink "$(basename "$1")")
26   done
27   REALPATH="$PWD/$(basename "$1")"
28   cd "$OURPWD"
29   echo "$REALPATH"
30 }
31
32 REALNAME=$(realpath "$0")
33 DIRNAME=$(dirname "$REALNAME")
34 PROGNAME=$(basename "$REALNAME")
35
36 #
37 # Sourcing environment settings for karaf similar to tomcats setenv
38 #
39 KARAF_SCRIPT="instance"
40 export KARAF_SCRIPT
41 if [ -f "$DIRNAME/setenv" ]; then
42   . "$DIRNAME/setenv"
43 fi
44
45 #
46 # Check/Set up some easily accessible MIN/MAX params for JVM mem usage
47 #
48 if [ "x$JAVA_MIN_MEM" = "x" ]; then
49     JAVA_MIN_MEM=128M
50     export JAVA_MIN_MEM
51 fi
52 if [ "x$JAVA_MAX_MEM" = "x" ]; then
53     JAVA_MAX_MEM=512M
54     export JAVA_MAX_MEM
55 fi
56
57 warn() {
58     echo "${PROGNAME}: $*"
59 }
60
61 die() {
62     warn "$*"
63     exit 1
64 }
65
66 detectOS() {
67     # OS specific support (must be 'true' or 'false').
68     cygwin=false;
69     darwin=false;
70     aix=false;
71     os400=false;
72     case "`uname`" in
73         CYGWIN*)
74             cygwin=true
75             ;;
76         Darwin*)
77             darwin=true
78             ;;
79         AIX*)
80             aix=true
81             ;;
82         OS400*)
83             os400=true
84             ;;
85     esac
86     # For AIX, set an environment variable
87     if $aix; then
88          export LDR_CNTRL=MAXDATA=0xB0000000@DSA
89          echo $LDR_CNTRL
90     fi
91 }
92
93 unlimitFD() {
94     # Use the maximum available, or set MAX_FD != -1 to use that
95     if [ "x$MAX_FD" = "x" ]; then
96         MAX_FD="maximum"
97     fi
98
99     # Increase the maximum file descriptors if we can
100     if [ "$os400" = "false" ] && [ "$cygwin" = "false" ]; then
101         MAX_FD_LIMIT=`ulimit -H -n`
102         if [ "$MAX_FD_LIMIT" != 'unlimited' ]; then
103             if [ $? -eq 0 ]; then
104                 if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ]; then
105                     # use the system max
106                     MAX_FD="$MAX_FD_LIMIT"
107                 fi
108
109                 ulimit -n $MAX_FD > /dev/null
110                 # echo "ulimit -n" `ulimit -n`
111                 if [ $? -ne 0 ]; then
112                     warn "Could not set maximum file descriptor limit: $MAX_FD"
113                 fi
114             else
115                 warn "Could not query system maximum file descriptor limit: $MAX_FD_LIMIT"
116             fi
117         fi
118     fi
119 }
120
121 locateHome() {
122     if [ "x$KARAF_HOME" != "x" ]; then
123         warn "Ignoring predefined value for KARAF_HOME"
124     fi
125
126     # In POSIX shells, CDPATH may cause cd to write to stdout
127     (unset CDPATH) >/dev/null 2>&1 && unset CDPATH
128
129     KARAF_HOME=`cd "$DIRNAME/.."; pwd`
130     if [ ! -d "$KARAF_HOME" ]; then
131         die "KARAF_HOME is not valid: $KARAF_HOME"
132     fi
133 }
134
135 locateBase() {
136     if [ "x$KARAF_BASE" != "x" ]; then
137         if [ ! -d "$KARAF_BASE" ]; then
138             die "KARAF_BASE is not valid: $KARAF_BASE"
139         fi
140     else
141         KARAF_BASE=$KARAF_HOME
142     fi
143 }
144
145 locateData() {
146     if [ "x$KARAF_DATA" != "x" ]; then
147         if [ ! -d "$KARAF_DATA" ]; then
148             die "KARAF_DATA is not valid: $KARAF_DATA"
149         fi
150     else
151         KARAF_DATA=$KARAF_BASE/data
152     fi
153 }
154
155 locateEtc() {
156     if [ "x$KARAF_ETC" != "x" ]; then
157         if [ ! -d "$KARAF_ETC" ]; then
158             die "KARAF_ETC is not valid: $KARAF_ETC"
159         fi
160     else
161         KARAF_ETC=$KARAF_BASE/etc
162     fi
163 }
164
165 setupNativePath() {
166     # Support for loading native libraries
167     LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:$KARAF_BASE/lib:$KARAF_HOME/lib"
168
169     # For Cygwin, set PATH from LD_LIBRARY_PATH
170     if $cygwin; then
171         LD_LIBRARY_PATH=`cygpath --path --windows "$LD_LIBRARY_PATH"`
172         PATH="$PATH;$LD_LIBRARY_PATH"
173         export PATH
174     fi
175     export LD_LIBRARY_PATH
176 }
177
178 pathCanonical() {
179     dst="${1}"
180     while [ -h "${dst}" ] ; do
181         ls=`ls -ld "${dst}"`
182         link=`expr "$ls" : '.*-> \(.*\)$'`
183         if expr "$link" : '/.*' > /dev/null; then
184             dst="$link"
185         else
186             dst="`dirname "${dst}"`/$link"
187         fi
188     done
189     bas=`basename "${dst}"`
190     dir=`dirname "${dst}"`
191     if [ "$bas" != "$dir" ]; then
192         dst="`pathCanonical "$dir"`/$bas"
193     fi
194     echo "${dst}" | sed -e 's#//#/#g' -e 's#/./#/#g' -e 's#/[^/]*/../#/#g'
195 }
196
197 locateJava() {
198     # Setup the Java Virtual Machine
199     if $cygwin ; then
200         [ -n "$JAVA" ] && JAVA=`cygpath --unix "$JAVA"`
201         [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
202     fi
203
204     if [ "x$JAVA_HOME" = "x" ] && [ "$darwin" = "true" ]; then
205         JAVA_HOME="$(/usr/libexec/java_home -v 1.7)"
206     fi
207     if [ "x$JAVA" = "x" ] && [ -r /etc/gentoo-release ] ; then
208         JAVA_HOME=`java-config --jre-home`
209     fi
210     if [ "x$JAVA" = "x" ]; then
211         if [ "x$JAVA_HOME" != "x" ]; then
212             if [ ! -d "$JAVA_HOME" ]; then
213                 die "JAVA_HOME is not valid: $JAVA_HOME"
214             fi
215             JAVA="$JAVA_HOME/bin/java"
216         else
217             warn "JAVA_HOME not set; results may vary"
218             JAVA=`type java`
219             JAVA=`expr "$JAVA" : '.* \(/.*\)$'`
220             if [ "x$JAVA" = "x" ]; then
221                 die "java command not found"
222             fi
223         fi
224     fi
225     if [ "x$JAVA_HOME" = "x" ]; then
226         JAVA_HOME="$(dirname $(dirname $(pathCanonical "$JAVA")))"
227     fi
228 }
229
230 detectJVM() {
231    #echo "`$JAVA -version`"
232    # This service should call `java -version`,
233    # read stdout, and look for hints
234    if $JAVA -version 2>&1 | grep "^IBM" ; then
235        JVM_VENDOR="IBM"
236    # on OS/400, java -version does not contain IBM explicitly
237    elif $os400; then
238        JVM_VENDOR="IBM"
239    else
240        JVM_VENDOR="SUN"
241    fi
242    # echo "JVM vendor is $JVM_VENDOR"
243 }
244
245 setupDebugOptions() {
246     if [ "x$JAVA_OPTS" = "x" ]; then
247         JAVA_OPTS="$DEFAULT_JAVA_OPTS"
248     fi
249     export JAVA_OPTS
250
251     if [ "x$EXTRA_JAVA_OPTS" != "x" ]; then
252         JAVA_OPTS="$JAVA_OPTS $EXTRA_JAVA_OPTS"
253     fi
254
255     # Set Debug options if enabled
256     if [ "x$KARAF_DEBUG" != "x" ]; then
257         # Use the defaults if JAVA_DEBUG_OPTS was not set
258         if [ "x$JAVA_DEBUG_OPTS" = "x" ]; then
259             JAVA_DEBUG_OPTS="$DEFAULT_JAVA_DEBUG_OPTS"
260         fi
261
262         JAVA_OPTS="$JAVA_DEBUG_OPTS $JAVA_OPTS"
263         warn "Enabling Java debug options: $JAVA_DEBUG_OPTS"
264     fi
265 }
266
267 setupDefaults() {
268     DEFAULT_JAVA_OPTS="-Xms$JAVA_MIN_MEM -Xmx$JAVA_MAX_MEM "
269
270     #Set the JVM_VENDOR specific JVM flags
271     if [ "$JVM_VENDOR" = "SUN" ]; then
272         # permgen was removed in Java 8
273         VERSION=`$JAVA -version 2>&1 | egrep '"([0-9].[0-9]\..*[0-9]).*"' | awk '{print substr($3,2,length($3)-2)}' | awk '{print substr($1, 3, 3)}' | sed -e 's;\.;;g'`
274         if [ "$VERSION" -lt "80" ]; then
275             # Check some easily accessible MIN/MAX params for JVM mem usage
276             if [ "x$JAVA_PERM_MEM" != "x" ]; then
277                 DEFAULT_JAVA_OPTS="$DEFAULT_JAVA_OPTS -XX:PermSize=$JAVA_PERM_MEM"
278             fi
279             if [ "x$JAVA_MAX_PERM_MEM" != "x" ]; then
280                 DEFAULT_JAVA_OPTS="$DEFAULT_JAVA_OPTS -XX:MaxPermSize=$JAVA_MAX_PERM_MEM"
281             fi
282         fi
283         DEFAULT_JAVA_OPTS="-server $DEFAULT_JAVA_OPTS -Dcom.sun.management.jmxremote"
284     elif [ "$JVM_VENDOR" = "IBM" ]; then
285         if $os400; then
286             DEFAULT_JAVA_OPTS="$DEFAULT_JAVA_OPTS"
287         elif $aix; then
288             DEFAULT_JAVA_OPTS="-Xverify:none -Xdump:heap -Xlp $DEFAULT_JAVA_OPTS"
289         else
290             DEFAULT_JAVA_OPTS="-Xverify:none $DEFAULT_JAVA_OPTS"
291         fi
292     fi
293
294     # Add default security file option
295     if [ "x$ODL_JAVA_SECURITY_PROPERTIES" != "x" ]; then
296         DEFAULT_JAVA_OPTS="-Djava.security.properties="${ODL_JAVA_SECURITY_PROPERTIES}" $DEFAULT_JAVA_OPTS"
297     else
298         DEFAULT_JAVA_OPTS="-Djava.security.properties="${KARAF_ETC}/odl.java.security" $DEFAULT_JAVA_OPTS"
299     fi
300
301     # Add the jars in the lib dir
302     for file in "$KARAF_HOME"/lib/*.jar
303     do
304         if [ -z "$CLASSPATH" ]; then
305             CLASSPATH="$file"
306         else
307             CLASSPATH="$CLASSPATH:$file"
308         fi
309     done
310
311     DEFAULT_JAVA_DEBUG_PORT="5005"
312     if [ "x$JAVA_DEBUG_PORT" = "x" ]; then
313         JAVA_DEBUG_PORT="$DEFAULT_JAVA_DEBUG_PORT"
314     fi
315     DEFAULT_JAVA_DEBUG_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=$JAVA_DEBUG_PORT"
316
317     ##
318     ## TODO: Move to conf/profiler/yourkit.{sh|cmd}
319     ##
320     # Uncomment to enable YourKit profiling
321     #DEFAULT_JAVA_DEBUG_OPTS="-Xrunyjpagent"
322 }
323
324 init() {
325     # Determine if there is special OS handling we must perform
326     detectOS
327
328     # Unlimit the number of file descriptors if possible
329     unlimitFD
330
331     # Locate the Karaf home directory
332     locateHome
333
334     # Locate the Karaf base directory
335     locateBase
336
337     # Locate the Karaf data directory
338     locateData
339
340     # Locate the Karaf etc directory
341     locateEtc
342
343     # Setup the native library path
344     setupNativePath
345
346     # Locate the Java VM to execute
347     locateJava
348
349     # Determine the JVM vendor
350     detectJVM
351
352     # Setup default options
353     setupDefaults
354
355     # Install debug options
356     setupDebugOptions
357
358 }
359
360 run() {
361
362     CLASSPATH="${KARAF_HOME}/system/org/apache/karaf/instance/org.apache.karaf.instance.command/${karaf.version}/org.apache.karaf.instance.command-${karaf.version}.jar:${KARAF_HOME}/system/org/apache/karaf/instance/org.apache.karaf.instance.core/${karaf.version}/org.apache.karaf.instance.core-${karaf.version}.jar:${KARAF_HOME}/system/org/apache/karaf/shell/org.apache.karaf.shell.console/${karaf.version}/org.apache.karaf.shell.console-${karaf.version}.jar:${KARAF_HOME}/system/org/apache/karaf/shell/org.apache.karaf.shell.table/${karaf.version}/org.apache.karaf.shell.table-${karaf.version}.jar:${KARAF_HOME}/system/org/apache/aries/blueprint/org.apache.aries.blueprint.api/${aries.blueprint.api.version}/org.apache.aries.blueprint.api-${aries.blueprint.api.version}.jar:${KARAF_HOME}/system/org/apache/aries/blueprint/org.apache.aries.blueprint.core/${aries.blueprint.core.version}/org.apache.aries.blueprint.core-${aries.blueprint.core.version}.jar:${KARAF_HOME}/system/org/apache/aries/blueprint/org.apache.aries.blueprint.cm/${aries.blueprint.cm.version}/org.apache.aries.blueprint.cm-${aries.blueprint.cm.version}.jar:${KARAF_HOME}/system/org/ops4j/pax/logging/pax-logging-api/${pax.logging.version}/pax-logging-api-${pax.logging.version}.jar:${KARAF_HOME}/system/org/apache/felix/org.apache.felix.framework/${felix.framework.version}/org.apache.felix.framework-${felix.framework.version}.jar:${KARAF_HOME}/system/jline/jline/${jline.version}/jline-${jline.version}.jar:$CLASSPATH"
363
364     if $cygwin; then
365         KARAF_HOME=`cygpath --path --windows "$KARAF_HOME"`
366         KARAF_BASE=`cygpath --path --windows "$KARAF_BASE"`
367         KARAF_DATA=`cygpath --path --windows "$KARAF_DATA"`
368         KARAF_ETC=`cygpath --path --windows "$KARAF_ETC"`
369         if [ ! -z "$CLASSPATH" ]; then
370             CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
371         fi
372     fi
373
374     exec "$JAVA" $JAVA_OPTS -Dkaraf.instances="${KARAF_HOME}/instances" -Dkaraf.home="$KARAF_HOME" -Dkaraf.base="$KARAF_BASE" -Dkaraf.etc="$KARAF_ETC" -Djava.io.tmpdir="$KARAF_DATA/tmp" -Djava.util.logging.config.file="$KARAF_BASE/etc/java.util.logging.properties" $KARAF_OPTS $OPTS -classpath "$CLASSPATH" org.apache.karaf.instance.main.Execute "$@"
375 }
376
377 main() {
378     init
379     run "$@"
380 }
381
382 main "$@"