1 /*
   2  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 import jdk.test.lib.OutputAnalyzer;
  25 import jdk.test.lib.dcmd.CommandExecutor;
  26 import jdk.test.lib.dcmd.JMXExecutor;
  27 import org.testng.annotations.Test;
  28 import static org.testng.Assert.*;
  29 
  30 /*
  31  * @test
  32  * @bug 8054890
  33  * @summary Test of VM.set_flag diagnostic command
  34  * @modules java.base/jdk.internal.misc
  35  * @library /testlibrary
  36  * @build jdk.test.lib.*
  37  * @build jdk.test.lib.dcmd.*
  38  * @run testng SetVMFlagTest
  39  */
  40 
  41 public class SetVMFlagTest {
  42     private static final String MANAGEABLE_PATTERN = "\\s*bool\\s+(\\S+)\\s+[\\:]?=\\s+" +
  43                                                      "(.*?)\\s+\\{manageable\\}";
  44     private static final String IMMUTABLE_PATTERN = "\\s*uintx\\s+(\\S+)\\s+[\\:]?=\\s+" +
  45                                                     "(.*?)\\s+\\{product\\}";
  46 
  47     public void run(CommandExecutor executor) {
  48         setMutableFlag(executor);
  49         setMutableFlagWithInvalidValue(executor);
  50         setImmutableFlag(executor);
  51         setNonExistingFlag(executor);
  52     }
  53 
  54     @Test
  55     public void jmx() {
  56         run(new JMXExecutor());
  57     }
  58 
  59     private void setMutableFlagInternal(CommandExecutor executor, String flag,
  60                                         boolean val, boolean isNumeric) {
  61         String strFlagVal;
  62         if (isNumeric) {
  63             strFlagVal = val ? "1" : "0";
  64         } else {
  65             strFlagVal = val ? "true" : "false";
  66         }
  67 
  68         OutputAnalyzer out = executor.execute("VM.set_flag " + flag + " " + strFlagVal);
  69         out.stderrShouldBeEmpty();
  70 
  71         out = getAllFlags(executor);
  72 
  73         String newFlagVal = out.firstMatch(MANAGEABLE_PATTERN.replace("(\\S+)", flag), 1);
  74 
  75         assertNotEquals(newFlagVal, val ? "1" : "0");
  76     }
  77 
  78     private void setMutableFlag(CommandExecutor executor) {
  79         OutputAnalyzer out = getAllFlags(executor);
  80         String flagName = out.firstMatch(MANAGEABLE_PATTERN, 1);
  81         String flagVal = out.firstMatch(MANAGEABLE_PATTERN, 2);
  82 
  83         System.out.println("### Setting a mutable flag '" + flagName + "'");
  84 
  85         if (flagVal == null) {
  86             System.err.println(out.getOutput());
  87             throw new Error("Can not find a boolean manageable flag");
  88         }
  89 
  90         Boolean blnVal = Boolean.parseBoolean(flagVal);
  91         setMutableFlagInternal(executor, flagName, !blnVal, true);
  92         setMutableFlagInternal(executor, flagName, blnVal, false);
  93     }
  94 
  95     private void setMutableFlagWithInvalidValue(CommandExecutor executor) {
  96         OutputAnalyzer out = getAllFlags(executor);
  97         String flagName = out.firstMatch(MANAGEABLE_PATTERN, 1);
  98         String flagVal = out.firstMatch(MANAGEABLE_PATTERN, 2);
  99 
 100         System.out.println("### Setting a mutable flag '" + flagName + "' to an invalid value");
 101 
 102         if (flagVal == null) {
 103             System.err.println(out.getOutput());
 104             throw new Error("Can not find a boolean manageable flag");
 105         }
 106 
 107         // a boolean flag accepts only 0/1 as its value
 108         out = executor.execute("VM.set_flag " + flagName + " unexpected_value");
 109         out.stderrShouldBeEmpty();
 110         out.stdoutShouldContain("flag value must be a boolean (1/0 or true/false)");
 111 
 112         out = getAllFlags(executor);
 113 
 114         String newFlagVal = out.firstMatch(MANAGEABLE_PATTERN.replace("(\\S+)", flagName), 1);
 115 
 116         assertEquals(newFlagVal, flagVal);
 117     }
 118 
 119     private void setImmutableFlag(CommandExecutor executor) {
 120         OutputAnalyzer out = getAllFlags(executor);
 121         String flagName = out.firstMatch(IMMUTABLE_PATTERN, 1);
 122         String flagVal = out.firstMatch(IMMUTABLE_PATTERN, 2);
 123 
 124         System.out.println("### Setting an immutable flag '" + flagName + "'");
 125 
 126         if (flagVal == null) {
 127             System.err.println(out.getOutput());
 128             throw new Error("Can not find an immutable uintx flag");
 129         }
 130 
 131         Long numVal = Long.parseLong(flagVal);
 132 
 133         out = executor.execute("VM.set_flag " + flagName + " " + (numVal + 1));
 134         out.stderrShouldBeEmpty();
 135         out.stdoutShouldContain("only 'writeable' flags can be set");
 136 
 137         out = getAllFlags(executor);
 138 
 139         String newFlagVal = out.firstMatch(IMMUTABLE_PATTERN.replace("(\\S+)", flagName), 1);
 140 
 141         assertEquals(newFlagVal, flagVal);
 142     }
 143 
 144     private void setNonExistingFlag(CommandExecutor executor) {
 145         String unknownFlag = "ThisIsUnknownFlag";
 146         System.out.println("### Setting a non-existing flag '" + unknownFlag + "'");
 147         OutputAnalyzer out = executor.execute("VM.set_flag " + unknownFlag + " 1");
 148         out.stderrShouldBeEmpty();
 149         out.stdoutShouldContain("flag " + unknownFlag + " does not exist");
 150     }
 151 
 152     private OutputAnalyzer getAllFlags(CommandExecutor executor) {
 153         return executor.execute("VM.flags -all", true);
 154     }
 155 }