336 lines
13 KiB
Java
336 lines
13 KiB
Java
/*
|
|
* Copyright (c) 2001, 2024, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
package nsk.jdi.ObjectReference.disableCollection;
|
|
|
|
import nsk.share.*;
|
|
import nsk.share.jpda.*;
|
|
import nsk.share.jdi.*;
|
|
|
|
import com.sun.jdi.*;
|
|
import com.sun.jdi.event.*;
|
|
import com.sun.jdi.request.*;
|
|
|
|
import java.util.*;
|
|
import java.io.*;
|
|
|
|
/**
|
|
* The test for the implementation of an object of the type <BR>
|
|
* ObjectReference. <BR>
|
|
* <BR>
|
|
* The test checks that results of the method <BR>
|
|
* <code>com.sun.jdi.ObjectReference.disableCollection()</code> <BR>
|
|
* complies with its spec. <BR>
|
|
* <BR>
|
|
* The test checks up on the following assertion: <BR>
|
|
* Prevents garbage collection for this object. <BR>
|
|
* By default all ObjectReference values returned by JDI <BR>
|
|
* may be collected at any time the target VM is running. <BR>
|
|
* A call to this method guarantees that <BR>
|
|
* the object will not be collected. <BR>
|
|
* <BR>
|
|
* The test has three phases and works as follows. <BR>
|
|
* <BR>
|
|
* In first phase, <BR>
|
|
* upon launching debuggee's VM which will be suspended, <BR>
|
|
* a debugger waits for the VMStartEvent within a predefined <BR>
|
|
* time interval. If no the VMStartEvent received, the test is FAILED. <BR>
|
|
* Upon getting the VMStartEvent, it makes the request for debuggee's <BR>
|
|
* ClassPrepareEvent with SUSPEND_EVENT_THREAD, resumes the VM, <BR>
|
|
* and waits for the event within the predefined time interval. <BR>
|
|
* If no the ClassPrepareEvent received, the test is FAILED. <BR>
|
|
* Upon getting the ClassPrepareEvent, <BR>
|
|
* the debugger sets up the breakpoint with SUSPEND_EVENT_THREAD <BR>
|
|
* within debuggee's special methodForCommunication(). <BR>
|
|
* <BR>
|
|
* In second phase to check the assetion, <BR>
|
|
* the debugger and the debuggee perform the following. <BR>
|
|
* - The debugger resumes the debuggee and waits for the BreakpointEvent.<BR>
|
|
* - The debuggee prepares new array object "arr1" to be tested on <BR>
|
|
* collection and invokes the methodForCommunication to be suspended <BR>
|
|
* and to inform the debugger with the event. <BR>
|
|
* - Upon getting the BreakpointEvent, <BR>
|
|
* the debugger gets ObjectReference mirroring arr1, <BR>
|
|
* disables collecting "arr1" resumes the debuggee and waits for new <BR>
|
|
* BreakpointEvent. <BR>
|
|
* - The debuggee assigns null to arr1 to make object's memory available<BR>
|
|
* to be collected and pertforms a loop in which it creates new <BR>
|
|
* objects until VM throws OutOfMemoryError. Then it informs the <BR>
|
|
* debugger of the ERROR with new BreakPoint event. <BR>
|
|
* - Upon getting the event, <BR>
|
|
* the debugger gets new ObjectReference mirroring arr1, <BR>
|
|
* resumes the debuggee, and waits for new breakpoint. <BR>
|
|
* - The debuggee invokes a garbage collector and informs the debugger <BR>
|
|
* with new breakpoint event. <BR>
|
|
* - Upon getting the event, <BR>
|
|
* the debugger gets new ObjectReference mirroring arr1 once again. <BR>
|
|
* <BR>
|
|
* If no ObjectCollectedexception is thrown during the above cooperation<BR>
|
|
* the test is PASSED, othewise, FAILED. <BR>
|
|
* <BR>
|
|
* Note. To inform each other of needed actions, the debugger and <BR>
|
|
* and the debuggee use debuggeee's variable "instruction". <BR>
|
|
* <BR>
|
|
* In third phase when at the end, <BR>
|
|
* the debuggee changes the value of the "instruction" <BR>
|
|
* to inform the debugger of checks finished, and both end. <BR>
|
|
* <BR>
|
|
*/
|
|
|
|
public class disablecollection002 extends JDIBase {
|
|
|
|
public static void main (String argv[]) {
|
|
|
|
int result = run(argv, System.out);
|
|
|
|
if (result != 0) {
|
|
throw new RuntimeException("TEST FAILED with result " + result);
|
|
}
|
|
}
|
|
|
|
public static int run (String argv[], PrintStream out) {
|
|
|
|
int exitCode = new disablecollection002().runThis(argv, out);
|
|
|
|
if (exitCode != PASSED) {
|
|
System.out.println("TEST FAILED");
|
|
}
|
|
return exitCode;
|
|
}
|
|
|
|
// ************************************************ test parameters
|
|
|
|
private String debuggeeName =
|
|
"nsk.jdi.ObjectReference.disableCollection.disablecollection002a";
|
|
|
|
//====================================================== test program
|
|
|
|
private int runThis (String argv[], PrintStream out) {
|
|
|
|
argsHandler = new ArgumentHandler(argv);
|
|
logHandler = new Log(out, argsHandler);
|
|
Binder binder = new Binder(argsHandler, logHandler);
|
|
|
|
waitTime = argsHandler.getWaitTime() * 60000;
|
|
try {
|
|
log2("launching a debuggee :");
|
|
log2(" " + debuggeeName);
|
|
if (argsHandler.verbose()) {
|
|
debuggee = binder.bindToDebugee(debuggeeName + " -vbs");
|
|
} else {
|
|
debuggee = binder.bindToDebugee(debuggeeName);
|
|
}
|
|
if (debuggee == null) {
|
|
log3("ERROR: no debuggee launched");
|
|
return FAILED;
|
|
}
|
|
log2("debuggee launched");
|
|
} catch ( Exception e ) {
|
|
log3("ERROR: Exception : " + e);
|
|
log2(" test cancelled");
|
|
return FAILED;
|
|
}
|
|
|
|
debuggee.redirectOutput(logHandler);
|
|
|
|
vm = debuggee.VM();
|
|
|
|
eventQueue = vm.eventQueue();
|
|
if (eventQueue == null) {
|
|
log3("ERROR: eventQueue == null : TEST ABORTED");
|
|
vm.exit(PASS_BASE);
|
|
return FAILED;
|
|
}
|
|
|
|
log2("invocation of the method runTest()");
|
|
switch (runTest()) {
|
|
|
|
case 0 : log2("test phase has finished normally");
|
|
log2(" waiting for the debuggee to finish ...");
|
|
debuggee.waitFor();
|
|
|
|
log2("......getting the debuggee's exit status");
|
|
int status = debuggee.getStatus();
|
|
if (status != PASS_BASE) {
|
|
log3("ERROR: debuggee returned UNEXPECTED exit status: " +
|
|
status + " != PASS_BASE");
|
|
testExitCode = FAILED;
|
|
} else {
|
|
log2("......debuggee returned expected exit status: " +
|
|
status + " == PASS_BASE");
|
|
}
|
|
break;
|
|
|
|
default : log3("ERROR: runTest() returned unexpected value");
|
|
|
|
case 1 : log3("test phase has not finished normally: debuggee is still alive");
|
|
log2("......forcing: vm.exit();");
|
|
testExitCode = FAILED;
|
|
try {
|
|
vm.exit(PASS_BASE);
|
|
} catch ( Exception e ) {
|
|
log3("ERROR: Exception : e");
|
|
}
|
|
break;
|
|
|
|
case 2 : log3("test cancelled due to VMDisconnectedException");
|
|
log2("......trying: vm.process().destroy();");
|
|
testExitCode = FAILED;
|
|
try {
|
|
Process vmProcess = vm.process();
|
|
if (vmProcess != null) {
|
|
vmProcess.destroy();
|
|
}
|
|
} catch ( Exception e ) {
|
|
log3("ERROR: Exception : e");
|
|
}
|
|
break;
|
|
}
|
|
|
|
return testExitCode;
|
|
}
|
|
|
|
|
|
/*
|
|
* Return value: 0 - normal end of the test
|
|
* 1 - ubnormal end of the test
|
|
* 2 - VMDisconnectedException while test phase
|
|
*/
|
|
|
|
private int runTest() {
|
|
|
|
try {
|
|
testRun();
|
|
|
|
log2("waiting for VMDeathEvent");
|
|
getEventSet();
|
|
if (eventIterator.nextEvent() instanceof VMDeathEvent)
|
|
return 0;
|
|
|
|
log3("ERROR: last event is not the VMDeathEvent");
|
|
return 1;
|
|
} catch ( VMDisconnectedException e ) {
|
|
log3("ERROR: VMDisconnectedException : " + e);
|
|
return 2;
|
|
} catch ( Exception e ) {
|
|
log3("ERROR: Exception : " + e);
|
|
return 1;
|
|
}
|
|
|
|
}
|
|
|
|
private void testRun()
|
|
throws JDITestRuntimeException, Exception {
|
|
|
|
eventRManager = vm.eventRequestManager();
|
|
|
|
ClassPrepareRequest cpRequest = eventRManager.createClassPrepareRequest();
|
|
cpRequest.setSuspendPolicy( EventRequest.SUSPEND_EVENT_THREAD);
|
|
cpRequest.addClassFilter(debuggeeName);
|
|
|
|
cpRequest.enable();
|
|
vm.resume();
|
|
getEventSet();
|
|
cpRequest.disable();
|
|
|
|
ClassPrepareEvent event = (ClassPrepareEvent) eventIterator.next();
|
|
debuggeeClass = event.referenceType();
|
|
|
|
if (!debuggeeClass.name().equals(debuggeeName))
|
|
throw new JDITestRuntimeException("** Unexpected ClassName for ClassPrepareEvent **");
|
|
|
|
log2(" received: ClassPrepareEvent for debuggeeClass");
|
|
|
|
String bPointMethod = "methodForCommunication";
|
|
String lineForComm = "lineForComm";
|
|
BreakpointRequest bpRequest;
|
|
|
|
bpRequest = settingBreakpoint(debuggee.threadByNameOrThrow("main"),
|
|
debuggeeClass,
|
|
bPointMethod, lineForComm, "zero");
|
|
bpRequest.enable();
|
|
|
|
//------------------------------------------------------ testing section
|
|
|
|
log1(" TESTING BEGINS");
|
|
|
|
for (int i = 0; ; i++) {
|
|
|
|
vm.resume();
|
|
breakpointForCommunication();
|
|
|
|
int instruction = ((IntegerValue)
|
|
(debuggeeClass.getValue(debuggeeClass.fieldByName("instruction")))).value();
|
|
|
|
if (instruction == 0) {
|
|
vm.resume();
|
|
break;
|
|
}
|
|
|
|
log1(":::::: case: # " + i);
|
|
|
|
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ variable part
|
|
|
|
String name = "arr1";
|
|
|
|
ReferenceType arr1RefType = null;
|
|
ObjectReference arr1ObjRef = null;
|
|
|
|
try {
|
|
log2("......getting: arr1ObjRef = (ObjectReference) debuggeeClass.getValue(debuggeeClass.fieldByName(name));");
|
|
arr1ObjRef = (ObjectReference)
|
|
debuggeeClass.getValue(debuggeeClass.fieldByName(name));
|
|
|
|
log2("...... arr1ObjRef.disableCollection();");
|
|
arr1ObjRef.disableCollection();
|
|
|
|
log2("......vm.resume();");
|
|
vm.resume();
|
|
breakpointForCommunication();
|
|
log2(" after breakpointForCommunication();");
|
|
|
|
log2("......getting: arr1RefType = arr1ObjRef.referenceType();");
|
|
arr1RefType = arr1ObjRef.referenceType();
|
|
|
|
log2("......vm.resume();");
|
|
vm.resume();
|
|
breakpointForCommunication();
|
|
log2(" after breakpointForCommunication();");
|
|
|
|
log2("......after debuggee invoked runTime.gc() :");
|
|
log2(" getting: arr1RefType = arr1ObjRef.referenceType();");
|
|
arr1RefType = arr1ObjRef.referenceType();
|
|
|
|
} catch ( ObjectCollectedException e ) {
|
|
log3("ERROR: caught ObjectCollectedException");
|
|
throw new JDITestRuntimeException("** unexpected ObjectCollectedException **");
|
|
}
|
|
|
|
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
}
|
|
log1(" TESTING ENDS");
|
|
return;
|
|
}
|
|
|
|
}
|