1 /*
2 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
3 *
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * The contents of this file are subject to the terms of either the Universal Permissive License
7 * v 1.0 as shown at http://oss.oracle.com/licenses/upl
8 *
9 * or the following license:
10 *
11 * Redistribution and use in source and binary forms, with or without modification, are permitted
12 * provided that the following conditions are met:
13 *
14 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
15 * and the following disclaimer.
16 *
17 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
18 * conditions and the following disclaimer in the documentation and/or other materials provided with
19 * the distribution.
20 *
21 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
22 * endorse or promote products derived from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
26 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
30 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
31 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33 package org.openjdk.jmc.flightrecorder.rules.jdk.latency;
34
35 import java.text.MessageFormat;
36 import java.util.Arrays;
37 import java.util.Collection;
38 import java.util.List;
39 import java.util.concurrent.Callable;
40 import java.util.concurrent.FutureTask;
41 import java.util.concurrent.RunnableFuture;
42
43 import org.owasp.encoder.Encode;
44
45 import org.openjdk.jmc.common.IDisplayable;
46 import org.openjdk.jmc.common.IMCThread;
47 import org.openjdk.jmc.common.item.Aggregators;
48 import org.openjdk.jmc.common.item.IItem;
49 import org.openjdk.jmc.common.item.IItemCollection;
50 import org.openjdk.jmc.common.unit.IQuantity;
51 import org.openjdk.jmc.common.unit.UnitLookup;
52 import org.openjdk.jmc.common.util.IPreferenceValueProvider;
53 import org.openjdk.jmc.common.util.TypedPreference;
54 import org.openjdk.jmc.flightrecorder.JfrAttributes;
55 import org.openjdk.jmc.flightrecorder.jdk.JdkAttributes;
56 import org.openjdk.jmc.flightrecorder.jdk.JdkFilters;
57 import org.openjdk.jmc.flightrecorder.jdk.JdkQueries;
58 import org.openjdk.jmc.flightrecorder.jdk.JdkTypeIDs;
59 import org.openjdk.jmc.flightrecorder.rules.IRule;
60 import org.openjdk.jmc.flightrecorder.rules.Result;
61 import org.openjdk.jmc.flightrecorder.rules.Severity;
62 import org.openjdk.jmc.flightrecorder.rules.jdk.messages.internal.Messages;
63 import org.openjdk.jmc.flightrecorder.rules.util.JfrRuleTopics;
64 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit;
65 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit.EventAvailability;
66
67 public class VMOperationRule implements IRule {
68
69 private static final String RESULT_ID = "VMOperations"; //$NON-NLS-1$
70
71 public static final TypedPreference<IQuantity> WARNING_LIMIT = new TypedPreference<>("vm.vmoperation.warning.limit", //$NON-NLS-1$
72 Messages.getString(Messages.VMOperationRule_CONFIG_WARNING_LIMIT),
73 Messages.getString(Messages.VMOperationRule_CONFIG_WARNING_LIMIT_LONG), UnitLookup.TIMESPAN,
74 UnitLookup.MILLISECOND.quantity(2000));
75
76 private static final List<TypedPreference<?>> CONFIG_ATTRIBUTES = Arrays.<TypedPreference<?>> asList(WARNING_LIMIT);
77
78 @Override
79 public RunnableFuture<Result> evaluate(final IItemCollection items, final IPreferenceValueProvider vp) {
80 FutureTask<Result> evaluationTask = new FutureTask<>(new Callable<Result>() {
81 @Override
82 public Result call() throws Exception {
83 return evaluate(items, vp.getPreferenceValue(WARNING_LIMIT));
84 }
85 });
86 return evaluationTask;
87 }
88
89 private Result evaluate(IItemCollection items, IQuantity warningLimit) {
90 EventAvailability eventAvailability = RulesToolkit.getEventAvailability(items, JdkTypeIDs.VM_OPERATIONS);
91 if (eventAvailability == EventAvailability.UNAVAILABLE || eventAvailability == EventAvailability.DISABLED) {
92 return RulesToolkit.getEventAvailabilityResult(this, items, eventAvailability, JdkTypeIDs.VM_OPERATIONS);
93 }
94
95 IQuantity infoLimit = warningLimit.multiply(0.5);
96 // Get the longest blocking VM operation
97 IItem longestEvent = items.apply(JdkFilters.VM_OPERATIONS_BLOCKING_OR_SAFEPOINT)
98 .getAggregate(Aggregators.itemWithMax(JfrAttributes.DURATION));
99
100 if (longestEvent == null) {
101 String zeroDuration = UnitLookup.SECOND.quantity(0).displayUsing(IDisplayable.AUTO);
102 return new Result(this, 0,
103 MessageFormat.format(Messages.getString(Messages.VMOperationRuleFactory_TEXT_OK), zeroDuration),
104 null, JdkQueries.VM_OPERATIONS);
105 }
106 IQuantity longestDuration = RulesToolkit.getValue(longestEvent, JfrAttributes.DURATION);
107 String timeStr = RulesToolkit.getValue(longestEvent, JfrAttributes.START_TIME).displayUsing(IDisplayable.AUTO);
108 String peakDuration = longestDuration.displayUsing(IDisplayable.AUTO);
109 double score = RulesToolkit.mapExp100(longestDuration.doubleValueIn(UnitLookup.SECOND),
110 infoLimit.doubleValueIn(UnitLookup.SECOND), warningLimit.doubleValueIn(UnitLookup.SECOND));
111
112 if (Severity.get(score) == Severity.WARNING || Severity.get(score) == Severity.INFO) {
113 String operation = RulesToolkit.getValue(longestEvent, JdkAttributes.OPERATION);
114 IMCThread caller = RulesToolkit.getValue(longestEvent, JdkAttributes.CALLER);
115 return new Result(this, score,
116 MessageFormat.format(Messages.getString(Messages.VMOperationRuleFactory_TEXT_WARN), peakDuration),
117 MessageFormat.format(Messages.getString(Messages.VMOperationRuleFactory_TEXT_WARN_LONG),
118 peakDuration, operation, Encode.forHtml(caller.getThreadName()), timeStr),
119 JdkQueries.VM_OPERATIONS_BLOCKING);
120 }
121 return new Result(this, score,
122 MessageFormat.format(Messages.getString(Messages.VMOperationRuleFactory_TEXT_OK), peakDuration), null,
123 JdkQueries.FILE_READ);
124 }
125
126 @Override
127 public Collection<TypedPreference<?>> getConfigurationAttributes() {
128 return CONFIG_ATTRIBUTES;
129 }
130
131 @Override
132 public String getId() {
133 return RESULT_ID;
134 }
135
136 @Override
137 public String getName() {
138 return Messages.getString(Messages.VMOperations_RULE_NAME);
139 }
140
141 @Override
142 public String getTopic() {
143 return JfrRuleTopics.VM_OPERATIONS_TOPIC;
144 }
145 }