Skip to content

Commit

Permalink
Merge pull request #153 from annaibm/removeDebug
Browse files Browse the repository at this point in the history 
Remove debug options for sc mt test.
  • Loading branch information
@llxia
llxia authored May 7, 2024
2 parents e8ca471 + 275c7bd commit 0cc1cdb
Showing 1 changed file with 85 additions and 92 deletions.
177 changes: 85 additions & 92 deletions openj9.test.sharedClasses/src/test.sharedClasses/net/openj9/stf/SharedClasses.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
*
* 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 http://eclipse.org/legal/epl-2.0 or the Apache License,
* Version 2.0 which accompanies this distribution and is available at
* and is available at http://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
* 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
*
Expand Down Expand Up @@ -44,28 +44,28 @@

/**
* This is a SVT Shared Classes test plugin aimed at stress testing the shared Classes features of IBM's sdk.
* It runs various extremes of classloading, whilst mixing -Xshareclasses options which are either diagnostic in nature
* or are likely options for customers. The tests and their aims are described below:
*
* It runs various extremes of classloading, whilst mixing -Xshareclasses options which are either diagnostic in nature
* or are likely options for customers. The tests and their aims are described below:
*
* Single Class Loader (SingleCL)
* One classLoader, loads all classes (20000) in a single jar file. This is the simplest test in the suite, its aim is
* One classLoader, loads all classes (20000) in a single jar file. This is the simplest test in the suite, its aim is
* to populate the cache in the simplest and most obvious way without stressing the classpath caching.
*
*
* Multiple Class Loader (MultiCL)
* As above, however a separate classLoader is used to load each class from the jar file. This test introduces multiple
* classLoaders to stress the classpath caching.
*
* As above, however a separate classLoader is used to load each class from the jar file. This test introduces multiple
* classLoaders to stress the classpath caching.
*
* Multiple Thread Loader (MultiThread)
* As "Single Class Loader", however a thread is forked to load each class file from the jar. This test is
* aimed at stressing the concurrent access control without being too demanding on the rest of the caching code.
*
* aimed at stressing the concurrent access control without being too demanding on the rest of the caching code.
*
* Multiple Thread / Multiple Class Loader (MultiThreadMultiCL)
* As "Multiple Class Loader", however each classLoader is created in it's own forked thread. The most stressful test for
* As "Multiple Class Loader", however each classLoader is created in it's own forked thread. The most stressful test for
* loading classes from a single jar - just a combination of the multiple classloaders and threads to make life difficult..
*
*
* Multiple Jars (MultiJar)
* Here we create a new classLoader to load two classes from every jar file in a given folder - one class loaded to lock
* the jar, another loaded into the cache. This tests makes heavy demands on the classpath caching code as it introduces
* Here we create a new classLoader to load two classes from every jar file in a given folder - one class loaded to lock
* the jar, another loaded into the cache. This tests makes heavy demands on the classpath caching code as it introduces
* a large number of classpath jars (10000 by default).
*/
public class SharedClasses implements SharedClassesPluginInterface {
Expand All @@ -77,70 +77,70 @@ private enum Tests {
MultiJar( "MJ", LoaderSlaveMultiJar.class, "1000", true),
MultiThread( "MT", LoaderSlaveMultiThread.class, "300", false),
MultiThreadMultiCL( "MTM", LoaderSlaveMultiThreadMultiCL.class, "120", false);

private String mnemonic;
private Class<?> testClass;
private String classArgs;
private Boolean usesMultipleJars;

private Tests(String mnemonic, Class<?> testClass, String classArgs, Boolean usesMultipleJars) {
this.mnemonic = mnemonic;
this.testClass = testClass;
this.classArgs = classArgs;
this.usesMultipleJars = usesMultipleJars;
this.usesMultipleJars = usesMultipleJars;
}
}


// Define the Shared Classes test modes that can be run.
// Not all these options may be being used in a given test plan (e.g. as defined as makefile targets in a 'make test' run.
// It may be that some options listed here are not compatible with recent versions of java.
private enum Modes {
SCM01("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation}"), // default option
SCM02("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noClasspathCacheing"),
SCM03("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noIncrementalUpdates"), // No longer in use as noIncrementalUpdates is deprecated
SCM04("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},safemode"), // This mode required a pre-populated cache - no longer a valid option
SCM05("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noaot"),
SCM06("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xaot:forceAoT,count=0"),
SCM07("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xits0"), // Java6 only, as -Xits has been replaced with -Xitsn and -Xitn for the 2.6 J9 JVM
SCM08("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xits2000"), // Java6 only, as -Xits has been replaced with -Xitsn and -Xitn for the 2.6 J9 VM
SCM09("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xits50000"), // Java6 only, as -Xits has been replaced with -Xitsn and -Xitn for the 2.6 J9 VM
SCM10("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noReduceStoreContention"),
SCM11("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},modified=context1"),
SCM12("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xtrace:maximal=all,buffers=64k -XX:fatalassert"),
SCM13("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xint"), // -Xint on the command line should override -Xjit from the IBM_JAVA_OPTIONS env variable
SCM14("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xnojit"),
SCM15("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},nonpersistent"),
SCM16("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xquickstart"),
SCM17("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xscdmx0m"),
SCM18("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xitn0 -Xitsn0"),
SCM19("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xitn0 -Xitsn29179"), // 29179 was the highest supported value at Nov 2010
SCM20("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xitn5000 -Xitsn0"), // default value for itn was 2000 at Nov 2010
SCM21("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},nojitdata"),
SCM22("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xscdmx18m"),
SCM23("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xaot:forceAoT,count=1"),
SCM24("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},mprotect=onfind"), // Was used to test that the last partially filled pages in the shared cache are kept write protected
noSC("");
private String sharedClassesModeStr;
private Modes(String sharedClassesModeStr) {
this.sharedClassesModeStr = sharedClassesModeStr;
}
SCM01("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation}"), // default option
SCM02("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noClasspathCacheing"),
SCM03("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noIncrementalUpdates"), // No longer in use as noIncrementalUpdates is deprecated
SCM04("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},safemode"), // This mode required a pre-populated cache - no longer a valid option
SCM05("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noaot"),
SCM06("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xaot:forceAoT,count=0"),
SCM07("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xits0"), // Java6 only, as -Xits has been replaced with -Xitsn and -Xitn for the 2.6 J9 JVM
SCM08("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xits2000"), // Java6 only, as -Xits has been replaced with -Xitsn and -Xitn for the 2.6 J9 VM
SCM09("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xits50000"), // Java6 only, as -Xits has been replaced with -Xitsn and -Xitn for the 2.6 J9 VM
SCM10("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},noReduceStoreContention"),
SCM11("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},modified=context1"),
SCM12("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xtrace:maximal=all,buffers=64k -XX:fatalassert"),
SCM13("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xint"), // -Xint on the command line should override -Xjit from the IBM_JAVA_OPTIONS env variable
SCM14("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xnojit"),
SCM15("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},nonpersistent"),
SCM16("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xquickstart"),
SCM17("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xscdmx0m"),
SCM18("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xitn0 -Xitsn0"),
SCM19("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xitn0 -Xitsn29179"), // 29179 was the highest supported value at Nov 2010
SCM20("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xitn5000 -Xitsn0"), // default value for itn was 2000 at Nov 2010
SCM21("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},nojitdata"),
SCM22("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xscdmx18m"),
SCM23("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation} -Xaot:forceAoT,count=1"),
SCM24("-Xshareclasses:name=${cacheName},cacheDir=${cacheDir}${cacheOperation},mprotect=onfind"), // Was used to test that the last partially filled pages in the shared cache are kept write protected
noSC("");

private String sharedClassesModeStr;

private Modes(String sharedClassesModeStr) {
this.sharedClassesModeStr = sharedClassesModeStr;
}
}


private Tests scTest;
private Modes mode;

private String scOptions;
private String[] defaultScOptions;

private String cacheDir;

private String localSharedClassesResources;


public void help(HelpTextGenerator help) {
help.outputSection("Shared Classes test options");

Expand All @@ -152,37 +152,37 @@ public void help(HelpTextGenerator help) {
+ "'MultiThread' - Multiple thread test that uses a single jar on a single class loader on multiple threads \n"
+ "'MultiThreadMultiCL' - Multiple thread / Multi Classloader does similarly but uses multiple class "
+ "loaders on multiple threads ");

help.outputArgName("sharedClassMode", "MODE");
help.outputArgDesc("This is the mode of the Shared Classes test, each mode uses a combination of Shared Classes options to run. "
+ "The modes include a noSC mode (with no shared classes options) and range from SCM01 to SCM24, e.g. :\n"
+ "'SCM01' - -Xshareclasses:name=<name>,cacheDir=<dir> \n"
+ "'SCM05' - -Xshareclasses:name=<name>,cacheDir=<dir>,noaot \n"
+ "'SCM05' - -Xshareclasses:name=<name>,cacheDir=<dir>,noaot \n"
+ "etc... See SharedClasses.java for the full list of modes and their respective options.");
}


public void pluginInit(StfCoreExtension test, StfSharedClassesExtension sharedClasses) throws Exception {
// Find out which shared classes test and mode have been supplied.
StfTestArguments testArgs = test.env().getTestProperties("sharedClassTest", "sharedClassMode");
// Get the shared classes options from the supplied args.

// Get the shared classes options from the supplied args.
scTest = testArgs.decodeEnum("sharedClassTest", Tests.class);
mode = testArgs.decodeEnum("sharedClassMode", Modes.class);

cacheDir = test.env().getResultsDir().childDirectory("caches").toString();
String cacheOperation = "";
// Get the shared classes JVM options from the mode.

// Get the shared classes JVM options from the mode.
scOptions = mode.sharedClassesModeStr;

// And the (default) shared classes JVM options without the cache operation.
defaultScOptions = sharedClasses.resolveSharedClassesOptions(scOptions, SCSoftmxTestUtil.CACHE_NAME, cacheDir, cacheOperation);
}


public void setUp(StfCoreExtension test, StfSharedClassesExtension sharedClasses) throws Exception {

// See whether the test data (20000 classes and jars) already exist.
// If not, create them in the first -systemtest-prereqs directory (or the default location if no -systemtest-prereqs were supplied).
DirectoryRef sharedClassesDataDir = null; // This will be initialised when we find it.
Expand All @@ -202,21 +202,21 @@ public void setUp(StfCoreExtension test, StfSharedClassesExtension sharedClasses

if ( found == 0 ) {
sharedClassesDataDir = prereqRoots.get(0).childDirectory(dataSubdir);
test.doRunForegroundProcess("Create Shared Classes jars",
test.doRunForegroundProcess("Create Shared Classes jars",
"CSC",
ECHO_ON,
ExpectedOutcome.cleanRun().within("30m"),
ExpectedOutcome.cleanRun().within("30m"),
test.createJavaProcessDefinition()
.addProjectToClasspath("stf.core")
.addProjectToClasspath("openj9.test.sharedClasses")
.runClass(JavaGen.class)
.addArg(sharedClassesDataDir.getSpec())
.addArg("10000"));
}

// Copy the shared classes jar/s from the systemtest_prereqs directory to /tmp.
// This is in case the prereqs directory is on a mount which would cause the tests to run much more slowly.
if (scTest.usesMultipleJars) {
if (scTest.usesMultipleJars) {
DirectoryRef appsSharedClassesJarsDir = sharedClassesDataDir.childDirectory("jars");
DirectoryRef localSharedClassesJarsDir = test.doCpDir("Copy sharedClasses jars", appsSharedClassesJarsDir, test.env().getTmpDir().childDirectory("jars"));
localSharedClassesResources = localSharedClassesJarsDir.getSpec();
Expand All @@ -225,8 +225,8 @@ public void setUp(StfCoreExtension test, StfSharedClassesExtension sharedClasses
FileRef localSharedClassesJar = test.doCp("Copy sharedClasses jar", sharedClassesJar, test.env().getTmpDir());
localSharedClassesResources = localSharedClassesJar.getSpec();
}
// To ensure we run from a clean state, attempt to destroy all test related persistent/non-persistent caches

// To ensure we run from a clean state, attempt to destroy all test related persistent/non-persistent caches
// from the default cache location which may have been left behind by a previous failed test.
sharedClasses.doDestroySpecificCache("Destroy cache", "-Xshareclasses:name=" + SCSoftmxTestUtil.CACHE_NAME + ",cacheDir=" + cacheDir + "${cacheOperation}", SCSoftmxTestUtil.CACHE_NAME, cacheDir);
sharedClasses.doDestroySpecificNonPersistentCache("Destroy cache", "-Xshareclasses:name=" + SCSoftmxTestUtil.CACHE_NAME + ",cacheDir=" + cacheDir + "${cacheOperation}", SCSoftmxTestUtil.CACHE_NAME, cacheDir);
Expand All @@ -236,36 +236,29 @@ public void setUp(StfCoreExtension test, StfSharedClassesExtension sharedClasses
public void execute(StfCoreExtension test, StfSharedClassesExtension sharedClasses) throws Exception {
// Abort if we are not running on IBM Java
test.env().verifyUsingIBMJava();

// Reset/create test-specific cache.
sharedClasses.doResetSharedClassesCache("Reset Shared Classes Cache", scOptions, SCSoftmxTestUtil.CACHE_NAME, cacheDir);

// Launch 5 Java processes concurrently to populate the Shared Classes cache.
String comment = "Start java processes using " + scTest.testClass.getSimpleName();
test.doRunForegroundProcesses(comment, scTest.mnemonic, 5, ECHO_ON, ExpectedOutcome.cleanRun().within("2h"),
test.doRunForegroundProcesses(comment, scTest.mnemonic, 5, ECHO_ON, ExpectedOutcome.cleanRun().within("2h"),
test.createJavaProcessDefinition()
.addJvmOption(defaultScOptions)
.addProjectToClasspath("openj9.test.sharedClasses")
.runClass(scTest.testClass)
.addArg(localSharedClassesResources)
.addArg(scTest.classArgs));

String args = scTest.classArgs;

// If we are running any variant of SharedClasses.SCM01
if (mode == Modes.SCM01) {
args = "-Xdump:system+java:events=throw,filter=java/lang/NullPointerException#java/lang/invoke/BruteArgumentMoverHandle.permuteArguments* " + args;
}
// Launch 5 Java processes concurrently to load from the Shared Classes cache.
test.doRunForegroundProcesses(comment, scTest.mnemonic, 5, ECHO_ON, ExpectedOutcome.cleanRun().within("2h"),
test.doRunForegroundProcesses(comment, scTest.mnemonic, 5, ECHO_ON, ExpectedOutcome.cleanRun().within("2h"),
test.createJavaProcessDefinition()
.addJvmOption(defaultScOptions)
.addProjectToClasspath("openj9.test.sharedClasses")
.runClass(scTest.testClass)
.addArg(localSharedClassesResources)
.addArg(args));
// Ensure no cache is found if the noSC (no shared classes) mode is used
.addArg(scTest.classArgs));

// Ensure no cache is found if the noSC (no shared classes) mode is used
// else print the cache and check the output to ensure the cache has been created/populated.
if (mode == Modes.noSC) {
sharedClasses.doVerifySharedClassesCache("Ensure no cache is found", "-Xshareclasses" + "${cacheOperation}", SCSoftmxTestUtil.CACHE_NAME, cacheDir, "", 0);
Expand All @@ -275,9 +268,9 @@ public void execute(StfCoreExtension test, StfSharedClassesExtension sharedClass
}
}


public void tearDown(StfCoreExtension test, StfSharedClassesExtension sharedClasses) throws Exception {
// Destroy all caches created by the test
// Destroy all caches created by the test
sharedClasses.doDestroySpecificCache("Destroy cache", "-Xshareclasses:name=" + SCSoftmxTestUtil.CACHE_NAME + ",cacheDir=" + cacheDir + "${cacheOperation}", SCSoftmxTestUtil.CACHE_NAME, cacheDir);
sharedClasses.doDestroySpecificNonPersistentCache("Destroy cache", "-Xshareclasses:name=" + SCSoftmxTestUtil.CACHE_NAME + ",cacheDir=" + cacheDir + "${cacheOperation}", SCSoftmxTestUtil.CACHE_NAME, cacheDir);
}
Expand Down

0 comments on commit 0cc1cdb

Please sign in to comment.