Skip to content

Commit

Permalink
7262: Add rule for when the JVM version is < OpenJDK 8u302
Browse files Browse the repository at this point in the history
Reviewed-by: hirt
  • Loading branch information
ojung authored and thegreystone committed Jun 2, 2021
1 parent 8c28f1b commit f2e80e7
Show file tree
Hide file tree
Showing 10 changed files with 746 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2020, 2021, Oracle and/or its affiliates. All rights reserved.
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
Expand Down Expand Up @@ -91,8 +91,8 @@ private static boolean isNumber(String string) {
*
* @param vmName
* the JVM name to check.
* @return <code>true</code> of it is a JRockit, <code>false</code> if it isn't or if was not
* possible to tell.
* @return {@code true} of it is a JRockit, {@code false} if it isn't or if was not possible to
* tell.
*/
public static boolean isJRockitJVMName(String vmName) {
if (vmName == null) {
Expand All @@ -106,14 +106,29 @@ public static boolean isJRockitJVMName(String vmName) {
*
* @param vmName
* the JVM name to check.
* @return <code>true</code> if it is a HotSpot, <code>false</code> if it isn't or if was not
* possible to tell.
* @return {@code true} if it is a HotSpot, {@code false} if it isn't or if was not possible to
* tell.
*/
public static boolean isHotspotJVMName(String vmName) {
if (vmName == null) {
return false;
}
return vmName.startsWith("Java HotSpot") || vmName.startsWith("OpenJDK") || vmName.startsWith("SAP"); //$NON-NLS-1$ //$NON-NLS-2$;
return vmName.startsWith("Java HotSpot") || isOpenJDKJVMName(vmName) || vmName.startsWith("SAP"); //$NON-NLS-1$ //$NON-NLS-2$;
}

/**
* Returns whether this is a OpenJDK JVM or not.
*
* @param vmName
* the JVM name to check.
* @return {@code true} if it is a OpenJDK JVM, {@code false} if it isn't or if was not possible
* to tell.
*/
public static boolean isOpenJDKJVMName(String vmName) {
if (vmName == null) {
return false;
}
return vmName.startsWith("OpenJDK"); //$NON-NLS-1$
}

}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
Expand Down Expand Up @@ -139,6 +139,21 @@ public boolean equals(Object obj) {
* @return {@code true} if this instance is greater than or equal to {@code otherVersion}
*/
public boolean isGreaterOrEqualThan(JavaVersion otherVersion) {
return isGreaterOrEqualThan(otherVersion, true);
}

/**
* Compare another version instance with this instance disregarding early access status.
*
* @param otherVersion
* version to compare with
* @return {@code true} if this instance is greater than or equal to {@code otherVersion}
*/
public boolean isGreaterOrEqualThanDisregardEa(JavaVersion otherVersion) {
return isGreaterOrEqualThan(otherVersion, false);
}

private boolean isGreaterOrEqualThan(JavaVersion otherVersion, boolean compareEa) {
int maxLength = Math.max(versionNumbers.length, otherVersion.versionNumbers.length);
for (int i = 0; i < maxLength; i++) {
int thisNumber = versionNumbers.length > i ? versionNumbers[i] : 0;
Expand All @@ -147,7 +162,8 @@ public boolean isGreaterOrEqualThan(JavaVersion otherVersion) {
return thisNumber > otherNumber;
}
}
return !this.isEarlyAccess || otherVersion.isEarlyAccess;

return !compareEa || !this.isEarlyAccess || otherVersion.isEarlyAccess;
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
/*
* Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2021, Datadog, Inc. All rights reserved.
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The contents of this file are subject to the terms of either the Universal Permissive License
* v 1.0 as shown at http://oss.oracle.com/licenses/upl
*
* or the following license:
*
* Redistribution and use in source and binary forms, with or without modification, are permitted
* provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions
* and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other materials provided with
* the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to
* endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.openjdk.jmc.flightrecorder.rules.jdk.general;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.FutureTask;
import java.util.concurrent.RunnableFuture;

import org.openjdk.jmc.common.item.Aggregators;
import org.openjdk.jmc.common.item.IItemCollection;
import org.openjdk.jmc.common.unit.UnitLookup;
import org.openjdk.jmc.common.util.IPreferenceValueProvider;
import org.openjdk.jmc.common.util.TypedPreference;
import org.openjdk.jmc.common.version.JavaVMVersionToolkit;
import org.openjdk.jmc.common.version.JavaVersion;
import org.openjdk.jmc.flightrecorder.jdk.JdkAttributes;
import org.openjdk.jmc.flightrecorder.jdk.JdkTypeIDs;
import org.openjdk.jmc.flightrecorder.rules.IResult;
import org.openjdk.jmc.flightrecorder.rules.IResultValueProvider;
import org.openjdk.jmc.flightrecorder.rules.IRule;
import org.openjdk.jmc.flightrecorder.rules.ResultBuilder;
import org.openjdk.jmc.flightrecorder.rules.Severity;
import org.openjdk.jmc.flightrecorder.rules.TypedResult;
import org.openjdk.jmc.flightrecorder.rules.jdk.messages.internal.Messages;
import org.openjdk.jmc.flightrecorder.rules.util.JfrRuleTopics;
import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit;
import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit.EventAvailability;
import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit.RequiredEventsBuilder;

public class JfrPeriodicEventsFixRule implements IRule {

private static final String RESULT_ID = "JfrPeriodicEventsFix"; //$NON-NLS-1$

private static final Map<String, EventAvailability> REQUIRED_EVENTS = RequiredEventsBuilder.create()
.addEventType(JdkTypeIDs.VM_INFO, EventAvailability.AVAILABLE).build();

public static final TypedResult<String> JDK_VERSION = new TypedResult<>("jdkVersion", "JDK Version", //$NON-NLS-1$
"The version of the JDK that produced the recording.", UnitLookup.PLAIN_TEXT, String.class);

private static final Collection<TypedResult<?>> RESULT_ATTRIBUTES = Arrays.<TypedResult<?>> asList(JDK_VERSION);

private static final JavaVersion JDK_8_U_302 = new JavaVersion(8, 0, 302);

private IResult getResult(
IItemCollection items, IPreferenceValueProvider valueProvider, IResultValueProvider resultProvider) {
String vmName = items.getAggregate(Aggregators.distinctAsString(JdkTypeIDs.VM_INFO, JdkAttributes.JVM_NAME));
if (!JavaVMVersionToolkit.isOpenJDKJVMName(vmName)) {
return ResultBuilder.createFor(this, valueProvider).setSeverity(Severity.OK)
.setSummary(Messages.getString(Messages.JfrPeriodicEventsFixRule_TEXT_OK)).build();
}

String jvmVersion = items
.getAggregate(Aggregators.distinctAsString(JdkTypeIDs.VM_INFO, JdkAttributes.JVM_VERSION));
if (jvmVersion == null) {
return RulesToolkit.getNotApplicableResult(this, valueProvider,
Messages.getString(Messages.JfrPeriodicEventsFixRule_NO_JVM_VERSION_EVENTS_TEXT));
}

JavaVersion usedVersion = RulesToolkit.getJavaVersion(jvmVersion);

if (usedVersion == null) {
return RulesToolkit.getNotApplicableResult(this, valueProvider,
Messages.getString(Messages.General_TEXT_COULD_NOT_DETERMINE_JAVA_VERSION));
}

if (!usedVersion.isGreaterOrEqualThanDisregardEa(JDK_8_U_302)) {
return ResultBuilder.createFor(this, valueProvider).setSeverity(Severity.WARNING)
.addResult(JDK_VERSION, jvmVersion)
.setSummary(Messages.getString(Messages.JfrPeriodicEventsFixRule_TEXT_WARN_SHORT))
.setExplanation(Messages.getString(Messages.JfrPeriodicEventsFixRule_TEXT_WARN_LONG)).build();
}

return ResultBuilder.createFor(this, valueProvider).setSeverity(Severity.OK)
.setSummary(Messages.getString(Messages.JfrPeriodicEventsFixRule_TEXT_OK)).build();
}

@Override
public RunnableFuture<IResult> createEvaluation(
final IItemCollection items, final IPreferenceValueProvider valueProvider,
final IResultValueProvider resultProvider) {
FutureTask<IResult> evaluationTask = new FutureTask<>(new Callable<IResult>() {
@Override
public IResult call() throws Exception {
return getResult(items, valueProvider, resultProvider);
}
});
return evaluationTask;
}

@Override
public Collection<TypedPreference<?>> getConfigurationAttributes() {
return Collections.emptyList();
}

@Override
public String getId() {
return RESULT_ID;
}

@Override
public String getName() {
return Messages.getString(Messages.JfrPeriodicEventsFixRule_RULE_NAME);
}

@Override
public String getTopic() {
return JfrRuleTopics.JVM_INFORMATION;
}

@Override
public Map<String, EventAvailability> getRequiredEvents() {
return REQUIRED_EVENTS;
}

@Override
public Collection<TypedResult<?>> getResults() {
return RESULT_ATTRIBUTES;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,11 @@ public class Messages {
public static final String JavaBlockingRule_TEXT_MOST_BLOCKED_THREAD = "JavaBlockingRule_TEXT_MOST_BLOCKED_THREAD"; //$NON-NLS-1$
public static final String JavaBlockingRule_TEXT_OK = "JavaBlockingRule_TEXT_OK"; //$NON-NLS-1$
public static final String JavaBlocking_RULE_NAME = "JavaBlocking_RULE_NAME"; //$NON-NLS-1$
public static final String JfrPeriodicEventsFixRule_NO_JVM_VERSION_EVENTS_TEXT = "JfrPeriodicEventsFixRule_NO_JVM_VERSION_EVENTS_TEXT"; //$NON-NLS-1$
public static final String JfrPeriodicEventsFixRule_RULE_NAME = "JfrPeriodicEventsFixRule_RULE_NAME"; //$NON-NLS-1$
public static final String JfrPeriodicEventsFixRule_TEXT_OK = "JfrPeriodicEventsFixRule_TEXT_OK"; //$NON-NLS-1$
public static final String JfrPeriodicEventsFixRule_TEXT_WARN_LONG = "JfrPeriodicEventsFixRule_TEXT_WARN_LONG"; //$NON-NLS-1$
public static final String JfrPeriodicEventsFixRule_TEXT_WARN_SHORT = "JfrPeriodicEventsFixRule_TEXT_WARN_SHORT"; //$NON-NLS-1$
public static final String LongGcPauseRuleFactory_RULE_NAME = "LongGcPauseRuleFactory_RULE_NAME"; //$NON-NLS-1$
public static final String LongGcPauseRuleFactory_TEXT_INFO = "LongGcPauseRuleFactory_TEXT_INFO"; //$NON-NLS-1$
public static final String LongGcPauseRuleFactory_TEXT_INFO_G1 = "LongGcPauseRuleFactory_TEXT_INFO_G1"; //$NON-NLS-1$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ org.openjdk.jmc.flightrecorder.rules.jdk.general.DiscouragedVmOptionsRule
org.openjdk.jmc.flightrecorder.rules.jdk.general.DumpReasonRule
org.openjdk.jmc.flightrecorder.rules.jdk.general.FewSampledThreadsRule
org.openjdk.jmc.flightrecorder.rules.jdk.general.FlightRecordingSupportRule
org.openjdk.jmc.flightrecorder.rules.jdk.general.JfrPeriodicEventsFixRule
org.openjdk.jmc.flightrecorder.rules.jdk.general.ManagementAgentRule
org.openjdk.jmc.flightrecorder.rules.jdk.general.OptionsCheckRule
org.openjdk.jmc.flightrecorder.rules.jdk.general.PasswordsInArgumentsRule
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,12 @@ FlightRecordingSupportRule_EA_TEXT_WARN_LONG=This recording is from an early acc
FlightRecordingSupportRule_NO_JVM_VERSION_EVENTS_TEXT=There were no VM information events with JVM version information recorded. Please turn on JVM information events to use this rule.
FlightRecordingSupportRule_UNSUPPORTED_TEXT_WARN_SHORT=The recording is from an unsupported JRE version.
FlightRecordingSupportRule_UNSUPPORTED_TEXT_WARN_LONG=This recording is from a runtime with JRE version {jdkVersion}, before JDK Flight Recorder was fully supported in HotSpot. Versions before 7u40 only have partial support for flight recordings. The automated analysis is not supported, and you may see errors when attempting to analyze this recording.
JfrPeriodicEventsFixRule_RULE_NAME=JFR Periodic Events Fix
JfrPeriodicEventsFixRule_TEXT_OK=The version of Java you are running is not affected by a performance issue related to periodic events.
JfrPeriodicEventsFixRule_NO_JVM_VERSION_EVENTS_TEXT=There were no VM information events with JVM version information recorded. Please turn on JVM information events to use this rule.
JfrPeriodicEventsFixRule_TEXT_WARN_SHORT=The version of OpenJDK 8 you are running is lacking an important performance fix.
# {jdkVersion} is a string
JfrPeriodicEventsFixRule_TEXT_WARN_LONG=The version of OpenJDK ({jdkVersion}) you are running is lacking an important performance fix. Upgrading to version 8u302 or later can, in some cases, improve your performance quite radically. See JDK-8266723 for more information. An alternative can be to disable any periodic events not needed, such as the NativeExecutionSample event.

FullGcRule_RULE_NAME=G1/CMS Full Collection
FullGcRule_OTHER_COLLECTOR_IN_USE=This rule is only valid for CMS and G1 Garbage Collectors, neither of which were detected for this JVM.
Expand Down
Loading

0 comments on commit f2e80e7

Please sign in to comment.