< prev index next >

test/hotspot/jtreg/runtime/appcds/jvmti/InstrumentationTest.java

Print this page
   1 /*
   2  * Copyright (c) 2014, 2017, 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 /*
  26  * @test
  27  * @summary Exercise the java.lang.instrument.Instrumentation APIs on classes archived
  28  *          using CDS/AppCDSv1/AppCDSv2.
  29  * @library /test/lib /test/hotspot/jtreg/runtime/appcds /test/hotspot/jtreg/runtime/appcds/test-classes
  30  * @requires vm.cds
  31  * @requires vm.flavor != "minimal"
  32  * @modules java.base/jdk.internal.misc
  33  *          jdk.jartool/sun.tools.jar
  34  *          java.management
  35  * @build sun.hotspot.WhiteBox
  36  *        InstrumentationApp
  37  *        InstrumentationClassFileTransformer
  38  *        InstrumentationRegisterClassFileTransformer
  39  * @run main/othervm InstrumentationTest
  40  */
  41 
  42 // Note: TestCommon is from /test/hotspot/jtreg/runtime/appcds/TestCommon.java
  43 // Note: Util       is from /test/hotspot/jtreg/runtime/appcds/test-classes/TestCommon.java
  44 
  45 import com.sun.tools.attach.VirtualMachine;
  46 import com.sun.tools.attach.VirtualMachineDescriptor;
  47 import java.io.File;
  48 import java.io.FileOutputStream;
  49 import java.util.List;
  50 import jdk.test.lib.Asserts;
  51 import jdk.test.lib.cds.CDSOptions;
  52 import jdk.test.lib.process.OutputAnalyzer;
  53 import jdk.test.lib.process.ProcessTools;
  54 
  55 public class InstrumentationTest {
  56     public static String bootClasses[] = {
  57         "InstrumentationApp$Intf",
  58         "InstrumentationApp$Bar",
  59         "sun.hotspot.WhiteBox",
  60     };
  61     public static String appClasses[] = {
  62         "InstrumentationApp",
  63         "InstrumentationApp$Foo",
  64         "InstrumentationApp$MyLoader",
  65     };
  66     public static String custClasses[] = {
  67         "InstrumentationApp$Coo",
  68     };
  69     public static String sharedClasses[] = TestCommon.concat(bootClasses, appClasses);


 104         String agentCmdArg, flagFile;
 105         if (attachAgent) {
 106             // we will attach the agent, so don't specify -javaagent in the command line. We'll use
 107             // something harmless like -showversion to make it easier to construct the command line
 108             agentCmdArg = "-showversion";
 109         } else {
 110             agentCmdArg = "-javaagent:" + agentJar;
 111         }
 112 
 113         // First, run the test class directly, w/o sharing, as a baseline reference
 114         flagFile = getFlagFile(attachAgent);
 115         AgentAttachThread t = doAttach(attachAgent, flagFile, agentJar);
 116         ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(
 117                 bootCP,
 118                 "-cp", appJar,
 119                 "-XX:+UnlockDiagnosticVMOptions",
 120                 "-XX:+WhiteBoxAPI",
 121                 "-Xshare:off",
 122                 agentCmdArg,
 123                 "InstrumentationApp", flagFile, bootJar, appJar, custJar);
 124         TestCommon.executeAndLog(pb, "no-sharing").shouldHaveExitValue(0);




 125         checkAttach(t);
 126 
 127         // Dump the AppCDS archive. On some platforms AppCDSv2 may not be enabled, so we
 128         // first try the v2 classlist, and if that fails, revert to the v1 classlist.
 129         // Note that the InstrumentationApp$ArchivedIfAppCDSv2Enabled class is archived
 130         // only if V2 is enabled. This is tested by InstrumentationApp.isAppCDSV2Enabled().
 131         String[] v2Classes = {
 132             "InstrumentationApp$ArchivedIfAppCDSv2Enabled",
 133             "java/lang/Object id: 0",
 134             "InstrumentationApp$Intf id: 1",
 135             "InstrumentationApp$Coo  id: 2 super: 0 interfaces: 1 source: " + custJar,
 136         };
 137         String[] sharedClassesWithV2 = TestCommon.concat(v2Classes, sharedClasses);
 138         OutputAnalyzer out = TestCommon.dump(appJar, sharedClassesWithV2, bootCP);
 139         if (out.getExitValue() != 0) {
 140             System.out.println("Redumping with AppCDSv2 disabled");
 141                 TestCommon.testDump(appJar, sharedClasses, bootCP);
 142         }
 143 
 144         // Run with AppCDS.
 145         System.out.println("");
 146         System.out.println("============================================================");
 147         System.out.println("CDS: YES, attachAgent: " + (attachAgent ? "YES" : "NO"));
 148         System.out.println("============================================================");
 149         System.out.println("");
 150 
 151         flagFile = getFlagFile(attachAgent);
 152         t = doAttach(attachAgent, flagFile, agentJar);
 153         out = TestCommon.execAuto("-cp", appJar,
 154                 bootCP,
 155                 "-XX:+UnlockDiagnosticVMOptions",
 156                 "-XX:+WhiteBoxAPI",
 157                 agentCmdArg,
 158                "InstrumentationApp", flagFile, bootJar, appJar, custJar);
 159 




 160         CDSOptions opts = (new CDSOptions()).setXShareMode("auto");
 161         TestCommon.checkExec(out, opts);
 162         checkAttach(t);
 163     }
 164 
 165     static int flagFileSerial = 1;
 166     static private String getFlagFile(boolean attachAgent) {
 167         if (attachAgent) {
 168             // Do not reuse the same file name as Windows may fail to
 169             // delete the file.
 170             return "attach.flag." + ProcessHandle.current().pid() +
 171                     "." + (flagFileSerial++) + "." + System.currentTimeMillis();
 172         } else {
 173             return "noattach";
 174         }
 175     }
 176 
 177     static AgentAttachThread doAttach(boolean attachAgent, String flagFile, String agentJar) throws Throwable {
 178         if (!attachAgent) {
 179             return null;


 195         //
 196         // So, we will launch a AgentAttachThread which will poll the system
 197         // until the child process is launched, and then do the attachment.
 198         // The child process is uniquely identified by having flagFile in its
 199         // command-line -- see AgentAttachThread.getPid().
 200         AgentAttachThread t = new AgentAttachThread(flagFile, agentJar);
 201         t.start();
 202         return t;
 203     }
 204 
 205     static void checkAttach(AgentAttachThread thread) throws Throwable {
 206         if (thread != null) {
 207             thread.check();
 208         }
 209     }
 210 
 211     static class AgentAttachThread extends Thread {
 212         String flagFile;
 213         String agentJar;
 214         volatile boolean succeeded;


 215 
 216         AgentAttachThread(String flagFile, String agentJar) {
 217             this.flagFile = flagFile;
 218             this.agentJar = agentJar;
 219             this.succeeded = false;

 220         }
 221 
 222         static String getPid(String flagFile) throws Throwable {
 223             while (true) {
 224                 // Keep polling until the child process has been launched. If for some
 225                 // reason the child process fails to launch, this test will be terminated





 226                 // by JTREG's time-out mechanism.
 227                 Thread.sleep(100);
 228                 List<VirtualMachineDescriptor> vmds = VirtualMachine.list();
 229                 for (VirtualMachineDescriptor vmd : vmds) {
 230                     if (vmd.displayName().contains(flagFile) && vmd.displayName().contains("InstrumentationApp")) {
 231                         // We use flagFile (which has the PID of this process) as a unique identifier
 232                         // to ident the child process, which we want to attach to.
 233                         System.out.println("Process found: " + vmd.id() + " " + vmd.displayName());
 234                         return vmd.id();
 235                     }
 236                 }
 237             }


 238         }
 239 
 240         public void run() {
 241             try {
 242                 String pid = getPid(flagFile);
 243                 VirtualMachine vm = VirtualMachine.attach(pid);
 244                 System.out.println(agentJar);
 245                 vm.loadAgent(agentJar);
 246             } catch (Throwable t) {
 247                 t.printStackTrace();
 248                 throw new RuntimeException(t);
 249             }
 250 
 251             // Delete the flagFile to indicate to the child process that we
 252             // have attached to it, so it should proceed.
 253             File f = new File(flagFile);
 254             for (int i=0; i<5; i++) {
 255                 // The detele may fail on Windows if the child JVM is checking
 256                 // f.exists() at exactly the same time?? Let's do a little
 257                 // dance.
 258                 f.delete();
 259                 try {
 260                     Thread.sleep(10);
 261                 } catch (Throwable t) {;}
 262             }
 263             if (f.exists()) {
   1 /*
   2  * Copyright (c) 2014, 2019, 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 /*
  26  * @test
  27  * @summary Exercise the java.lang.instrument.Instrumentation APIs on classes archived
  28  *          using CDS/AppCDSv1/AppCDSv2.
  29  * @library /test/lib /test/hotspot/jtreg/runtime/appcds /test/hotspot/jtreg/runtime/appcds/test-classes
  30  * @requires vm.cds
  31  * @requires vm.flavor != "minimal"



  32  * @build sun.hotspot.WhiteBox
  33  *        InstrumentationApp
  34  *        InstrumentationClassFileTransformer
  35  *        InstrumentationRegisterClassFileTransformer
  36  * @run main/othervm InstrumentationTest
  37  */
  38 
  39 // Note: TestCommon is from /test/hotspot/jtreg/runtime/appcds/TestCommon.java
  40 // Note: Util       is from /test/hotspot/jtreg/runtime/appcds/test-classes/Util.java
  41 
  42 import com.sun.tools.attach.VirtualMachine;

  43 import java.io.File;
  44 import java.io.FileOutputStream;

  45 import jdk.test.lib.Asserts;
  46 import jdk.test.lib.cds.CDSOptions;
  47 import jdk.test.lib.process.OutputAnalyzer;
  48 import jdk.test.lib.process.ProcessTools;
  49 
  50 public class InstrumentationTest {
  51     public static String bootClasses[] = {
  52         "InstrumentationApp$Intf",
  53         "InstrumentationApp$Bar",
  54         "sun.hotspot.WhiteBox",
  55     };
  56     public static String appClasses[] = {
  57         "InstrumentationApp",
  58         "InstrumentationApp$Foo",
  59         "InstrumentationApp$MyLoader",
  60     };
  61     public static String custClasses[] = {
  62         "InstrumentationApp$Coo",
  63     };
  64     public static String sharedClasses[] = TestCommon.concat(bootClasses, appClasses);


  99         String agentCmdArg, flagFile;
 100         if (attachAgent) {
 101             // we will attach the agent, so don't specify -javaagent in the command line. We'll use
 102             // something harmless like -showversion to make it easier to construct the command line
 103             agentCmdArg = "-showversion";
 104         } else {
 105             agentCmdArg = "-javaagent:" + agentJar;
 106         }
 107 
 108         // First, run the test class directly, w/o sharing, as a baseline reference
 109         flagFile = getFlagFile(attachAgent);
 110         AgentAttachThread t = doAttach(attachAgent, flagFile, agentJar);
 111         ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(
 112                 bootCP,
 113                 "-cp", appJar,
 114                 "-XX:+UnlockDiagnosticVMOptions",
 115                 "-XX:+WhiteBoxAPI",
 116                 "-Xshare:off",
 117                 agentCmdArg,
 118                 "InstrumentationApp", flagFile, bootJar, appJar, custJar);
 119         Process process = pb.start();
 120         if (t != null) {
 121             t.setPid(process.pid());
 122         }
 123         TestCommon.executeAndLog(process, "no-sharing").shouldHaveExitValue(0);
 124         checkAttach(t);
 125 
 126         // Dump the AppCDS archive. On some platforms AppCDSv2 may not be enabled, so we
 127         // first try the v2 classlist, and if that fails, revert to the v1 classlist.
 128         // Note that the InstrumentationApp$ArchivedIfAppCDSv2Enabled class is archived
 129         // only if V2 is enabled. This is tested by InstrumentationApp.isAppCDSV2Enabled().
 130         String[] v2Classes = {
 131             "InstrumentationApp$ArchivedIfAppCDSv2Enabled",
 132             "java/lang/Object id: 0",
 133             "InstrumentationApp$Intf id: 1",
 134             "InstrumentationApp$Coo  id: 2 super: 0 interfaces: 1 source: " + custJar,
 135         };
 136         String[] sharedClassesWithV2 = TestCommon.concat(v2Classes, sharedClasses);
 137         OutputAnalyzer out = TestCommon.dump(appJar, sharedClassesWithV2, bootCP);
 138         if (out.getExitValue() != 0) {
 139             System.out.println("Redumping with AppCDSv2 disabled");
 140                 TestCommon.testDump(appJar, sharedClasses, bootCP);
 141         }
 142 
 143         // Run with AppCDS.
 144         System.out.println("");
 145         System.out.println("============================================================");
 146         System.out.println("CDS: YES, attachAgent: " + (attachAgent ? "YES" : "NO"));
 147         System.out.println("============================================================");
 148         System.out.println("");
 149 
 150         flagFile = getFlagFile(attachAgent);
 151         t = doAttach(attachAgent, flagFile, agentJar);
 152         pb = TestCommon.createProcessBuilderWithAutoArchive("-cp", appJar,
 153                 bootCP,
 154                 "-XX:+UnlockDiagnosticVMOptions",
 155                 "-XX:+WhiteBoxAPI",
 156                 agentCmdArg,
 157                "InstrumentationApp", flagFile, bootJar, appJar, custJar);
 158         process = pb.start();
 159         if (t != null) {
 160             t.setPid(process.pid());
 161         }
 162         out = TestCommon.executeAndLog(process, "auto");
 163         CDSOptions opts = (new CDSOptions()).setXShareMode("auto");
 164         TestCommon.checkExec(out, opts);
 165         checkAttach(t);
 166     }
 167 
 168     static int flagFileSerial = 1;
 169     static private String getFlagFile(boolean attachAgent) {
 170         if (attachAgent) {
 171             // Do not reuse the same file name as Windows may fail to
 172             // delete the file.
 173             return "attach.flag." + ProcessHandle.current().pid() +
 174                     "." + (flagFileSerial++) + "." + System.currentTimeMillis();
 175         } else {
 176             return "noattach";
 177         }
 178     }
 179 
 180     static AgentAttachThread doAttach(boolean attachAgent, String flagFile, String agentJar) throws Throwable {
 181         if (!attachAgent) {
 182             return null;


 198         //
 199         // So, we will launch a AgentAttachThread which will poll the system
 200         // until the child process is launched, and then do the attachment.
 201         // The child process is uniquely identified by having flagFile in its
 202         // command-line -- see AgentAttachThread.getPid().
 203         AgentAttachThread t = new AgentAttachThread(flagFile, agentJar);
 204         t.start();
 205         return t;
 206     }
 207 
 208     static void checkAttach(AgentAttachThread thread) throws Throwable {
 209         if (thread != null) {
 210             thread.check();
 211         }
 212     }
 213 
 214     static class AgentAttachThread extends Thread {
 215         String flagFile;
 216         String agentJar;
 217         volatile boolean succeeded;
 218         volatile long pid;
 219         volatile boolean pidIsKnown;
 220 
 221         AgentAttachThread(String flagFile, String agentJar) {
 222             this.flagFile = flagFile;
 223             this.agentJar = agentJar;
 224             this.succeeded = false;
 225             this.pidIsKnown = false;
 226         }
 227 
 228         void setPid(long pid) {
 229             this.pid = pid;
 230             this.pidIsKnown = true;
 231         }
 232 
 233         String getPid() throws Throwable {
 234             while (!pidIsKnown) {
 235                 // Keep polling until the child process has been launched, and its pid is known.
 236                 // If for some reason the child process fails to launch, this test will be terminated
 237                 // by JTREG's time-out mechanism.
 238                 Thread.sleep(100);









 239             }
 240             System.out.println("pid = " + pid);
 241             return Long.toString(pid);
 242         }
 243 
 244         public void run() {
 245             try {
 246                 String pidStr = getPid();
 247                 VirtualMachine vm = VirtualMachine.attach(pidStr);
 248                 System.out.println(agentJar);
 249                 vm.loadAgent(agentJar);
 250             } catch (Throwable t) {
 251                 t.printStackTrace();
 252                 throw new RuntimeException(t);
 253             }
 254 
 255             // Delete the flagFile to indicate to the child process that we
 256             // have attached to it, so it should proceed.
 257             File f = new File(flagFile);
 258             for (int i=0; i<5; i++) {
 259                 // The detele may fail on Windows if the child JVM is checking
 260                 // f.exists() at exactly the same time?? Let's do a little
 261                 // dance.
 262                 f.delete();
 263                 try {
 264                     Thread.sleep(10);
 265                 } catch (Throwable t) {;}
 266             }
 267             if (f.exists()) {
< prev index next >