1 /*
   2  * Copyright (c) 2013, 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 /*
  25  * @test
  26  * @bug 8028994
  27  * @author Staffan Larsen
  28  * @library /lib/testlibrary
  29  * @build jdk.testlibrary.*
  30  * @run main CheckOrigin
  31  */
  32 
  33 import com.sun.management.HotSpotDiagnosticMXBean;
  34 import com.sun.management.VMOption;
  35 import com.sun.management.VMOption.Origin;
  36 import com.sun.tools.attach.VirtualMachine;
  37 import java.io.File;
  38 import java.io.FileWriter;
  39 import java.io.InputStream;
  40 import java.io.PrintWriter;
  41 import java.lang.management.ManagementFactory;
  42 import java.util.Map;
  43 import jdk.testlibrary.ProcessTools;
  44 import sun.tools.attach.HotSpotVirtualMachine;
  45 
  46 public class CheckOrigin {
  47 
  48     private static HotSpotDiagnosticMXBean mbean;
  49 
  50     public static void main(String... args) throws Exception {
  51         if (args.length == 0) {
  52             // start a process that has options set in a number of different ways
  53 
  54             File flagsFile = File.createTempFile("CheckOriginFlags", null);
  55             try (PrintWriter pw =
  56                    new PrintWriter(new FileWriter(flagsFile))) {
  57                 pw.println("+PrintSafepointStatistics");
  58             }
  59 
  60             ProcessBuilder pb = ProcessTools.
  61                 createJavaProcessBuilder(
  62                     "-XX:+UseConcMarkSweepGC",  // this will cause UseParNewGC to be FLAG_SET_ERGO
  63                     "-XX:+PrintGCDetails",
  64                     "-XX:+UseCerealGC",         // Should be ignored.
  65                     "-XX:Flags=" + flagsFile.getAbsolutePath(),
  66                     "-cp", System.getProperty("test.class.path"),
  67                     "CheckOrigin",
  68                     "-runtests");
  69 
  70             Map<String, String> env = pb.environment();
  71             // "UseCMSGC" should be ignored.
  72             env.put("_JAVA_OPTIONS", "-XX:+PrintOopAddress -XX:+UseCMSGC");
  73             // "UseGOneGC" should be ignored.
  74             env.put("JAVA_TOOL_OPTIONS", "-XX:+IgnoreUnrecognizedVMOptions "
  75                 + "-XX:+PrintVMOptions -XX:+UseGOneGC");
  76 
  77             pb.redirectOutput(ProcessBuilder.Redirect.INHERIT);
  78             pb.redirectError(ProcessBuilder.Redirect.INHERIT);
  79             Process p = pb.start();
  80             int exit = p.waitFor();
  81             System.out.println("sub process exit == " + exit);
  82             if (exit != 0) {
  83                 throw new Exception("Unexpected exit code from subprocess == " + exit);
  84             }
  85         } else {
  86             mbean =
  87                 ManagementFactory.getPlatformMXBean(HotSpotDiagnosticMXBean.class);
  88 
  89             // set a few more options
  90             mbean.setVMOption("HeapDumpOnOutOfMemoryError", "true");
  91             setOptionUsingAttach("HeapDumpPath", "/a/sample/path");
  92 
  93             // check the origin field for all the options we set
  94 
  95             // Not set, so should be default
  96             checkOrigin("ManagementServer", Origin.DEFAULT);
  97             // Set on the command line
  98             checkOrigin("PrintGCDetails", Origin.VM_CREATION);
  99             // Set in _JAVA_OPTIONS
 100             checkOrigin("PrintOopAddress", Origin.ENVIRON_VAR);
 101             // Set in JAVA_TOOL_OPTIONS
 102             checkOrigin("IgnoreUnrecognizedVMOptions", Origin.ENVIRON_VAR);
 103             checkOrigin("PrintVMOptions", Origin.ENVIRON_VAR);
 104             // Set in -XX:Flags file
 105             checkOrigin("PrintSafepointStatistics", Origin.CONFIG_FILE);
 106             // Set through j.l.m
 107             checkOrigin("HeapDumpOnOutOfMemoryError", Origin.MANAGEMENT);
 108             // Should be set by the VM, when we set UseConcMarkSweepGC
 109             checkOrigin("UseParNewGC", Origin.ERGONOMIC);
 110             // Set using attach
 111             checkOrigin("HeapDumpPath", Origin.ATTACH_ON_DEMAND);
 112         }
 113     }
 114 
 115     private static void checkOrigin(String option, Origin origin) throws Exception
 116     {
 117         Origin o = mbean.getVMOption(option).getOrigin();
 118         if (!o.equals(origin)) {
 119             throw new Exception("Option '" + option + "' should have origin '" + origin + "' but had '" + o + "'");
 120         }
 121         System.out.println("Option '" + option + "' verified origin = '" + origin + "'");
 122     }
 123 
 124     // use attach to set a manageable vm option
 125     private static void setOptionUsingAttach(String option, String value) throws Exception {
 126         HotSpotVirtualMachine vm = (HotSpotVirtualMachine) VirtualMachine.attach(ProcessTools.getProcessId()+"");
 127         InputStream in = vm.setFlag(option, value);
 128         System.out.println("Result from setting '" + option + "' to '" + value + "' using attach:");
 129         drain(vm, in);
 130         System.out.println("-- end -- ");
 131     }
 132 
 133     // Read the stream from the target VM until EOF, print to output, then detach
 134     private static void drain(VirtualMachine vm, InputStream in) throws Exception {
 135         byte b[] = new byte[256];
 136         int n;
 137         do {
 138             n = in.read(b);
 139             if (n > 0) {
 140                 String s = new String(b, 0, n, "UTF-8");
 141                 System.out.print(s);
 142             }
 143         } while (n > 0);
 144         in.close();
 145         vm.detach();
 146     }
 147 
 148 }