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.general; 34 35 import java.util.Collection; 36 import java.util.Collections; 37 import java.util.concurrent.Callable; 38 import java.util.concurrent.FutureTask; 39 import java.util.concurrent.RunnableFuture; 40 41 import org.openjdk.jmc.common.item.IItemCollection; 42 import org.openjdk.jmc.common.util.IPreferenceValueProvider; 43 import org.openjdk.jmc.common.util.TypedPreference; 44 import org.openjdk.jmc.flightrecorder.jdk.JdkAggregators; 45 import org.openjdk.jmc.flightrecorder.jdk.JdkTypeIDs; 46 import org.openjdk.jmc.flightrecorder.rules.IRule; 47 import org.openjdk.jmc.flightrecorder.rules.Result; 48 import org.openjdk.jmc.flightrecorder.rules.jdk.messages.internal.Messages; 49 import org.openjdk.jmc.flightrecorder.rules.util.JfrRuleTopics; 50 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit; 51 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit.EventAvailability; 52 53 public class DiscouragedVmOptionsRule implements IRule { 54 private static final String DISCOURAGED_VM_OPTIONS_RESULT_ID = "DiscouragedVmOptions"; //$NON-NLS-1$ 55 56 private Result getResult(IItemCollection items, IPreferenceValueProvider valueProvider) { 57 EventAvailability eventAvailability = RulesToolkit.getEventAvailability(items, JdkTypeIDs.BOOLEAN_FLAG); 58 if (eventAvailability == EventAvailability.UNAVAILABLE || eventAvailability == EventAvailability.DISABLED) { 59 return RulesToolkit.getEventAvailabilityResult(this, items, eventAvailability, JdkTypeIDs.BOOLEAN_FLAG); 60 } 61 62 Boolean unlockExperimentalVMOptions = items.getAggregate(JdkAggregators.UNLOCK_EXPERIMENTAL_VM_OPTIONS); 63 Boolean ignoreUnrecognizedVMOptions = items.getAggregate(JdkAggregators.IGNORE_UNRECOGNIZED_VM_OPTIONS); 64 65 if (unlockExperimentalVMOptions != null && ignoreUnrecognizedVMOptions != null && unlockExperimentalVMOptions 66 && ignoreUnrecognizedVMOptions) { 67 String shortMessage = Messages.getString(Messages.DiscouragedVmOptionsRule_BOTH_EXPERIMENTAL_AND_IGNORE); 68 String longMessage = shortMessage + " " //$NON-NLS-1$ 69 + Messages.getString(Messages.UnlockExperimentalVMOptionsRuleFactory_TEXT_INFO_LONG) + " " //$NON-NLS-1$ 70 + Messages.getString(Messages.IgnoreUnrecognizedVMOptionsRuleFactory_TEXT_INFO_LONG); 71 return new Result(this, 50, shortMessage, longMessage); 72 } else if (ignoreUnrecognizedVMOptions != null && ignoreUnrecognizedVMOptions) { 73 return new Result(this, 50, Messages.getString(Messages.IgnoreUnrecognizedVMOptionsRuleFactory_TEXT_INFO), 74 Messages.getString(Messages.IgnoreUnrecognizedVMOptionsRuleFactory_TEXT_INFO_LONG)); 75 } else if (unlockExperimentalVMOptions != null && unlockExperimentalVMOptions) { 76 return new Result(this, 50, Messages.getString(Messages.UnlockExperimentalVMOptionsRuleFactory_TEXT_INFO), 77 Messages.getString(Messages.UnlockExperimentalVMOptionsRuleFactory_TEXT_INFO_LONG)); 78 } else { 79 return new Result(this, 0, Messages.getString(Messages.DiscouragedVmOptionsRule_TEXT_OK)); 80 } 81 } 82 83 @Override 84 public RunnableFuture<Result> evaluate(final IItemCollection items, final IPreferenceValueProvider valueProvider) { 85 FutureTask<Result> evaluationTask = new FutureTask<>(new Callable<Result>() { 86 @Override 87 public Result call() throws Exception { 88 return getResult(items, valueProvider); 89 } 90 }); 91 return evaluationTask; 92 } 93 94 @Override 95 public Collection<TypedPreference<?>> getConfigurationAttributes() { 96 return Collections.emptyList(); 97 } 98 99 @Override 100 public String getId() { 101 return DISCOURAGED_VM_OPTIONS_RESULT_ID; 102 } 103 104 @Override 105 public String getName() { 106 return Messages.getString(Messages.DiscouragedVmOptionsRule_RULE_NAME); 107 } 108 109 @Override 110 public String getTopic() { 111 return JfrRuleTopics.JVM_INFORMATION_TOPIC; 112 } 113 }