CRIU Restore Softmx Functional Tests

Add supporting test cases and related testing scripts.

Softmx functionalities: #18168

Functional changes: #19037

test/functional/cmdLineTests/criu/criuSoftmxScript.sh

@@ -0,0 +1,161 @@
+#!/bin/sh
+
+#
+# Copyright IBM Corp. and others 2023
+#
+# This program and the accompanying materials are made available under
+# the terms of the Eclipse Public License 2.0 which accompanies this
+# distribution and is available at https://www.eclipse.org/legal/epl-2.0/
+# or the Apache License, Version 2.0 which accompanies this distribution and
+# is available at https://www.apache.org/licenses/LICENSE-2.0.
+#
+# This Source Code may also be made available under the following
+# Secondary Licenses when the conditions for such availability set
+# forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
+# General Public License, version 2 with the GNU Classpath
+# Exception [1] and GNU General Public License, version 2 with the
+# OpenJDK Assembly Exception [2].
+#
+# [1] https://www.gnu.org/software/classpath/license.html
+# [2] https://openjdk.org/legal/assembly-exception.html
+#
+# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
+#
+
+echo "start running script";
+# the expected arguments are:
+# $1 is the TEST_ROOT
+# $2 is the JAVA_COMMAND
+# $3 is the JVM_OPTIONS
+# $4 is the MAINCLASS
+# $5 is the APP ARGS
+# $6 is the NUM_CHECKPOINT
+# $7 is the KEEP_CHECKPOINT
+# $8 is the KEEP_TEST_OUTPUT
+# $9 is the dynamicHeapAdjustmentForRestore
+# $10 is the Xmx
+# $11 is the MaxRAMPercentage
+# $12 is the Xms
+# $13 is the Xsoftmx
+# $14 is the expected softmx numerator
+# $15 is the expected softmx denominator
+echo "export GLIBC_TUNABLES=glibc.cpu.hwcaps=-XSAVEC,-XSAVE,-AVX2,-ERMS,-AVX,-AVX_Fast_Unaligned_Load";
+export GLIBC_TUNABLES=glibc.pthread.rseq=0:glibc.cpu.hwcaps=-XSAVEC,-XSAVE,-AVX2,-ERMS,-AVX,-AVX_Fast_Unaligned_Load
+echo "export LD_BIND_NOT=on";
+export LD_BIND_NOT=on
+# get the system memory
+MEMORY=$(grep MemTotal /proc/meminfo | awk '{print $2}')
+MEMORY=$((1024*MEMORY))
+echo "actual memory use"
+echo $MEMORY
+UPPER=26843545600
+# because the computeDefaultMaxHeapForJava has upper limit for 25 GB
+if [ "$MEMORY" -ge "$UPPER" ]; then
+    # just hard code to meet the required output
+    echo "Large Heap Pre-checkpoint"
+    echo "Skip. Machine RAM too large"
+    exit 1
+fi
+XDynamicHeapAdjustment=""
+if [ "$9" == true ]; then
+    XDynamicHeapAdjustment="-XX:+dynamicHeapAdjustmentForRestore"
+fi
+Xmx=""
+if [ "${10}" == true ]; then
+    Xmx="-Xmx$((MEMORY*2))"
+fi
+MaxRAMPercentage=""
+if [ "${11}" == true ]; then
+    MaxRAMPercentage="-XX:MaxRAMPercentage=50"
+fi
+Xms=""
+if [ "${12}" == true ]; then
+    Xms="-Xms$((MEMORY/2))"
+fi
+Xsoftmx=""
+if [ "${13}" == true ]; then
+    Xsoftmx="-Xsoftmx$((MEMORY/2))"
+fi
+echo "Xmx"
+echo $Xmx
+echo "MaxRAMPercentage"
+echo $MaxRAMPercentage
+echo "Xms"
+echo $Xms
+echo "Xsoftmx"
+echo $Xsoftmx
+echo "$2 -XX:+EnableCRIUSupport -XX:+fvtest_testContainerMemLimit $XDynamicHeapAdjustment $Xmx $MaxRAMPercentage $Xms $Xsoftmx $3 -cp "$1/criu.jar" $4 $5 $6 >testOutput 2>&1;"
+$2 -XX:+EnableCRIUSupport -XX:+fvtest_testContainerMemLimit $XDynamicHeapAdjustment $Xmx $MaxRAMPercentage $Xms $Xsoftmx $3 -cp "$1/criu.jar" $4 $5 $6 >testOutput 2>&1;
+
+if [ "$7" != true ]; then
+    NUM_CHECKPOINT=$6
+    for ((i=0; i<$NUM_CHECKPOINT; i++)); do
+        sleep 2;
+        criu restore -D ./cpData --shell-job >criuOutput 2>&1;
+    done
+fi
+echo "test output"
+cat testOutput;
+echo "end test output"
+echo ""
+echo "restore output"
+cat criuOutput
+echo "end restore output"
+echo ""
+echo "restore verbose"
+cat output.txt
+echo "end restore verbose"
+if grep -q "Unable to create a thread" criuOutput
+then
+    echo "reach thread error 1"
+    exit 1
+fi
+if grep -q "do not match expected" criuOutput
+then
+    echo "reach thread error 2"
+    exit 1
+fi
+# get the decimal representation of the current softmx value
+softMX=$(($(cat output.txt | grep "softMx" | cut -d'"' -f 4)))
+echo "actual softmx"
+echo $softMX
+# assume that 64K is the largest alignment that JVM will apply out of
+# extensions->heapAlignment (not in VGC)
+# regionSize for standard GCs (not in VGC)
+# and pageSize (in VGC)
+processedsoftMX=$((softMX - (softMX%(64*1024))))
+echo $processedsoftMX
+if  [ "$7" != true ]; then
+    if [ "$8" != true ]; then
+        rm -rf testOutput criuOutput output.txt
+        echo "Removed test output files"
+    fi
+fi
+if [ "$((${14}))" -eq 0 ]; then
+    if [ "$softMX" -ne 0 ]; then
+        echo "Error condition: softMX value should be 0 but it's not."
+        exit 1
+    fi
+    echo "Success condition: SoftMX value is 0 as expected."
+    exit 1
+fi
+echo ""
+echo ""
+echo "before alignment expected"
+echo $((MEMORY * ${14} / ${15}))
+echo "expected softmx"
+# same as above, use 64K for alignment
+regionAligned=$(((MEMORY * ${14} / ${15}) - ((MEMORY * ${14} / ${15}) % (64*1024))))
+echo $regionAligned
+if [ "$((${15}))" -eq 0 ]; then
+    echo "Error condition: the denominator should never be 0."
+    exit 1
+else
+    echo "Both are not 0, we check the proposed softmx against the actual one."
+    if [ "$processedsoftMX" -eq "$regionAligned" ]; then
+        echo "Success condition: The proposed softmx equals the actual one."
+    else
+        echo "Error condition: the proposed softmx doesn't equal the actual one."
+    fi
+fi
+echo "finished script";