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.openjdk.jmc.common.IDisplayable;
44 import org.openjdk.jmc.common.item.Aggregators;
45 import org.openjdk.jmc.common.item.IItemCollection;
46 import org.openjdk.jmc.common.item.ItemFilters;
47 import org.openjdk.jmc.common.unit.IQuantity;
48 import org.openjdk.jmc.common.unit.UnitLookup;
49 import org.openjdk.jmc.common.util.IPreferenceValueProvider;
50 import org.openjdk.jmc.common.util.TypedPreference;
51 import org.openjdk.jmc.flightrecorder.JfrAttributes;
52 import org.openjdk.jmc.flightrecorder.jdk.JdkAttributes;
53 import org.openjdk.jmc.flightrecorder.jdk.JdkFilters;
54 import org.openjdk.jmc.flightrecorder.jdk.JdkTypeIDs;
55 import org.openjdk.jmc.flightrecorder.rules.IRule;
56 import org.openjdk.jmc.flightrecorder.rules.Result;
57 import org.openjdk.jmc.flightrecorder.rules.jdk.messages.internal.Messages;
58 import org.openjdk.jmc.flightrecorder.rules.util.JfrRuleTopics;
59 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit;
60 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit.EventAvailability;
61
62 public final class BiasedLockingRevocationPauseRule implements IRule {
63
64 public static final TypedPreference<IQuantity> INFO_LIMIT = new TypedPreference<>(
65 "vm.biasedrevocationpause.info.limit", //$NON-NLS-1$
66 Messages.getString(Messages.BiasedLockingRevocationPauseRule_CONFIG_WARNING_LIMIT),
67 Messages.getString(Messages.BiasedLockingRevocationPauseRule_CONFIG_WARNING_LIMIT_LONG),
68 UnitLookup.TIMESPAN, UnitLookup.MILLISECOND.quantity(100));
69
70 private static final List<TypedPreference<?>> CONFIG_ATTRIBUTES = Arrays.<TypedPreference<?>> asList(INFO_LIMIT);
71
72 private Result getResult(IItemCollection items, IPreferenceValueProvider valueProvider) {
73 EventAvailability eventAvailability = RulesToolkit.getEventAvailability(items, JdkTypeIDs.VM_OPERATIONS);
74 if (eventAvailability == EventAvailability.UNAVAILABLE || eventAvailability == EventAvailability.DISABLED) {
75 return RulesToolkit.getEventAvailabilityResult(this, items, eventAvailability, JdkTypeIDs.VM_OPERATIONS);
76 }
77
78 IItemCollection revocationEvents = items.apply(
79 ItemFilters.and(JdkFilters.VM_OPERATIONS, ItemFilters.matches(JdkAttributes.OPERATION, "RevokeBias"))); //$NON-NLS-1$
80 if (!revocationEvents.hasItems()) {
81 return new Result(this, 0, Messages.getString(Messages.BiasedLockingRevocationPauseRule_TEXT_OK));
82 }
83 IQuantity timeSpentRevoking = revocationEvents.hasItems()
84 ? revocationEvents.getAggregate(Aggregators.sum(JfrAttributes.DURATION))
85 : UnitLookup.MILLISECOND.quantity(0);
86 double mappedDuration = RulesToolkit.mapExp100Y(timeSpentRevoking.doubleValueIn(UnitLookup.MILLISECOND),
87 valueProvider.getPreferenceValue(INFO_LIMIT).doubleValueIn(UnitLookup.MILLISECOND), 25);
88 String shortMessage = MessageFormat.format(
89 Messages.getString(Messages.BiasedLockingRevocationPauseRule_TEXT_MESSAGE),
90 timeSpentRevoking.displayUsing(IDisplayable.AUTO));
91 String longMessage = shortMessage;
92 if (mappedDuration >= 25) {
93 longMessage = longMessage + "<p>" //$NON-NLS-1$
94 + Messages.getString(Messages.BiasedLockingRevocationPauseRule_TEXT_INFO_LONG);
95 }
96 return new Result(this, mappedDuration, shortMessage, longMessage);
97 }
98
99 @Override
100 public RunnableFuture<Result> evaluate(final IItemCollection items, final IPreferenceValueProvider valueProvider) {
101 FutureTask<Result> evaluationTask = new FutureTask<>(new Callable<Result>() {
102 @Override
103 public Result call() throws Exception {
104 return getResult(items, valueProvider);
105 }
106 });
107 return evaluationTask;
108 }
109
110 @Override
111 public Collection<TypedPreference<?>> getConfigurationAttributes() {
112 return CONFIG_ATTRIBUTES;
113 }
114
115 @Override
116 public String getId() {
117 return "biasedLockingRevocationPause"; //$NON-NLS-1$
118 }
119
120 @Override
121 public String getName() {
122 return Messages.getString(Messages.BiasedLockingRevocationPauseRule_RULE_NAME);
123 }
124
125 @Override
126 public String getTopic() {
127 return JfrRuleTopics.VM_OPERATIONS_TOPIC;
128 }
129
130 }