Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

7903889: jcstress: document used properites (and env variables) #156

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

7903889: jcstress: document used properites (and env variables) #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1761d67
7903889: jcstress: document used properites (and env variables)
judovana Jan 4, 2025
ced87e2
Removed autoformatted whitespaces
judovana Jan 4, 2025
c67cbf4
Extracted properties encapsualted in objects
judovana Jan 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 36 additions & 20 deletions jcstress-core/src/main/java/org/openjdk/jcstress/Options.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@
* @author Aleksey Shipilev ([email protected])
*/
public class Options {
public static final String TIME_BUDGET_SWITCH = "tb";

private String resultDir;
private String testFilter;
private int strideSize;
Expand Down Expand Up @@ -93,7 +95,7 @@ public boolean parse() throws IOException {
.withRequiredArg().ofType(Integer.class).describedAs("N");

OptionSpec<Integer> strideCount = parser.accepts("strideCount", "Internal stride count per epoch. " +
"Larger value increases cache footprint.")
"Larger value increases cache footprint.")
.withRequiredArg().ofType(Integer.class).describedAs("N");

OptionSpec<Integer> optTime = parser.accepts("time", "(Deprecated, to be removed in next releases.)")
Expand Down Expand Up @@ -144,13 +146,13 @@ public boolean parse() throws IOException {
OptionSpec<Boolean> optPretouchHeap = parser.accepts("pth", "Pre-touch Java heap, if possible.")
.withOptionalArg().ofType(Boolean.class).describedAs("bool");

OptionSpec<TimeValue> optTimeBudget = parser.accepts("tb", "Time budget to run the tests. Harness code would try to fit the entire " +
OptionSpec<TimeValue> optTimeBudget = parser.accepts(TIME_BUDGET_SWITCH, "Time budget to run the tests. Harness code would try to fit the entire " +
"run in the desired timeframe. This value is expected to be reasonable, as it is not guaranteed that tests would succeed " +
"in arbitrarily low time budget. If not set, harness would try to decide a reasonable time, given the number of tests to run. " +
"Common time suffixes (s/m/h/d) are accepted.")
.withRequiredArg().ofType(TimeValue.class).describedAs("time");

parser.accepts("v", "Be verbose.");
parser.accepts("v", "Be verbose. Will print known properties in help");
parser.accepts("vv", "Be extra verbose.");
parser.accepts("vvv", "Be extra extra verbose.");
parser.accepts("h", "Print this help.");
Expand All @@ -161,12 +163,13 @@ public boolean parse() throws IOException {
} catch (OptionException e) {
System.err.println("ERROR: " + e.getMessage());
System.err.println();
parser.printHelpOn(System.err);
printHelp(parser, System.err);
return false;
}
setVerbosity(set);

if (set.has("h")) {
parser.printHelpOn(System.out);
printHelp(parser, System.out);
return false;
}

Expand All @@ -185,23 +188,14 @@ public boolean parse() throws IOException {
this.resultFile = "jcstress-results-" + timestamp + ".bin.gz";
}
this.list = orDefault(set.has(list), false);
if (set.has("vvv")) {
this.verbosity = new Verbosity(3);
} else if (set.has("vv")) {
this.verbosity = new Verbosity(2);
} else if (set.has("v")) {
this.verbosity = new Verbosity(1);
} else {
this.verbosity = new Verbosity(0);
}

int totalCpuCount = VMSupport.figureOutHotCPUs();
cpuCount = orDefault(set.valueOf(cpus), totalCpuCount);

if (cpuCount > totalCpuCount) {
System.err.println("Requested to use " + cpuCount + " CPUs, but system has only " + totalCpuCount + " CPUs.");
System.err.println();
parser.printHelpOn(System.err);
printHelp(parser, System.err);
return false;
}

Expand All @@ -227,21 +221,21 @@ public boolean parse() throws IOException {
if (optModeStr.value(set) != null) {
System.err.println("-m option is not supported anymore, please use -tb.");
System.err.println();
parser.printHelpOn(System.err);
printHelp(parser, System.err);
return false;
}

if (optTime.value(set) != null) {
System.err.println("-time option is not supported anymore, please use -tb.");
System.err.println();
parser.printHelpOn(System.err);
printHelp(parser, System.err);
return false;
}

if (optIters.value(set) != null) {
System.err.println("-iters option is not supported anymore, please use -tb.");
System.err.println();
parser.printHelpOn(System.err);
printHelp(parser, System.err);
return false;
}

Expand All @@ -263,6 +257,26 @@ public boolean parse() throws IOException {
return true;
}

private void setVerbosity(OptionSet set) {
if (set.has("vvv")) {
this.verbosity = new Verbosity(3);
} else if (set.has("vv")) {
this.verbosity = new Verbosity(2);
} else if (set.has("v")) {
this.verbosity = new Verbosity(1);
} else {
this.verbosity = new Verbosity(0);
}
}

private void printHelp(OptionParser parser, PrintStream ouer) throws IOException {
parser.printHelpOn(ouer);
ouer.println();
if (verbosity != null && verbosity.printAllTests()) {
UsedProperties.printHelpOn(ouer);
}
}

private List<String> processArgs(OptionSpec<String> op, OptionSet set) {
if (set.hasArgument(op)) {
try {
Expand Down Expand Up @@ -297,7 +311,7 @@ public void printSettingsOn(PrintStream out) {
out.printf(" Hardware CPUs in use: %d%n", getCPUCount());
out.printf(" Spinning style: %s%n", getSpinStyle());
out.printf(" Test selection: \"%s\"%n", getTestFilter());
out.printf(" Forks per test: %d normal, %d stress%n", getForks(), getForks()*getForksStressMultiplier());
out.printf(" Forks per test: %d normal, %d stress%n", getForks(), getForks() * getForksStressMultiplier());
out.printf(" Test stride: %d strides x %d tests, but taking no more than %d Mb%n", getStrideCount(), getStrideSize(), getMaxFootprintMb());
out.printf(" Test result blob: \"%s\"%n", resultFile);
out.printf(" Test results: \"%s\"%n", resultDir);
Expand Down Expand Up @@ -392,6 +406,8 @@ public boolean isPretouchHeap() {
return pretouchHeap;
}

public TimeValue timeBudget() { return timeBudget; }
public TimeValue timeBudget() {
return timeBudget;
}

}
6 changes: 3 additions & 3 deletions jcstress-core/src/main/java/org/openjdk/jcstress/TimeBudget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@

public class TimeBudget {

static final int DEFAULT_PER_TEST_MS = Integer.getInteger("jcstress.timeBudget.defaultPerTestMs", 3000);
static final int MIN_TIME_MS = Integer.getInteger("jcstress.timeBudget.minTimeMs", 30);
static final int MAX_TIME_MS = Integer.getInteger("jcstress.timeBudget.maxTimeMs", 60_000);
static final int DEFAULT_PER_TEST_MS = UsedProperties.getJcstressTimeBudgetDefaultPerTestMs();
static final int MIN_TIME_MS = UsedProperties.getJcstressTimeBudgetMinTimeMs();
static final int MAX_TIME_MS = UsedProperties.getJcstressTimeBudgetMaxTimeMs();

final long endTime;
final int expectedTests;
Expand Down
Loading