File: HeapwalkingDebugger.java

package info (click to toggle)
openjdk-11-jre-dcevm 11.0.15%2B1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 221,420 kB
  • sloc: java: 1,363,561; cpp: 967,919; ansic: 69,480; xml: 62,475; sh: 8,106; asm: 3,475; python: 1,667; javascript: 943; makefile: 397; sed: 172; perl: 114
file content (196 lines) | stat: -rw-r--r-- 8,438 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
 * Copyright (c) 2006, 2018, 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.share.jdi;

import java.util.*;
import com.sun.jdi.*;
import nsk.share.TestBug;

/*
 * Debugger class used in tests for heapwalking(tests for VirtualMachine.instanceCounts, ReferenceType.instances, ObjectReference.referrers)
 * Contains several common checking and auxiliary methods.
 */
public class HeapwalkingDebugger extends TestDebuggerType2 {
    // instances of some classes couldn't be strictly controlled during test execution, use non-strict checks for this classes
    protected boolean strictCheck(String className) {
        boolean otherThreadPresent = isJFR_active();
        return HeapwalkingDebuggee.useStrictCheck(className, otherThreadPresent);
    }

    // wrapper for VirtualMachine.instanceCounts
    public long getInstanceCount(String className) {
        List<ReferenceType> list = vm.classesByName(className);

        if (list.size() == 0)
            return 0;

        if (list.size() > 1) {
            setSuccess(false);
            log.complain("Unexpected collection size returned by VirtualMachine.classesByName(" + className + "): " + list.size()
                    + ", only 1 entry was expected.");
        }

        long result[] = (vm.instanceCounts(list));

        return result[0];
    }

    // tests that vm.instanceCounts(vm.allClasses()) doesn't throws any exceptions
    protected void testInstanceCounts() {
        try {
            vm.instanceCounts(vm.allClasses());
        } catch (Throwable t) {
            setSuccess(false);
            log.complain("Unexpected exception: " + t);
            t.printStackTrace(log.getOutStream());
        }

    }

    // check size of list returned by ReferenceType.instances
    protected void checkDebugeeAnswer_instances(String className, int expectedCount) {
        ReferenceType referenceType = debuggee.classByName(className);

        int instanceCounts = referenceType.instances(0).size();

        if (strictCheck(className)) {
            if (referenceType.instances(0).size() != expectedCount) {
                setSuccess(false);
                log.complain("Unexpected size of referenceType.instances(" + className + "): " + instanceCounts + ", expected: " + expectedCount);
            }
        } else {
            if (referenceType.instances(0).size() < expectedCount) {
                setSuccess(false);
                log.complain("Unexpected size of referenceType.instances(" + className + "): " + instanceCounts + ", expected: >= " + expectedCount);
            }
        }
    }

    // check value returned by VirtualMachine.instanceCounts,
    // note that method call method isDebuggeeReady() which check that debuggee completed pervious command and is ready for new one
    public void checkDebugeeAnswer_instanceCounts(String className, int expectedValue) {
        if (!isDebuggeeReady())
            return;

        try {
            long instanceCounts = getInstanceCount(className);

            if (strictCheck(className)) {
                if (instanceCounts != expectedValue) {
                    setSuccess(false);
                    log.complain("Wrong value was returned  by VirtualMachine.instanceCounts(" + className + "): " + instanceCounts + ", expected: "
                            + expectedValue);
                }
            } else {
                if (instanceCounts < expectedValue) {
                    setSuccess(false);
                    log.complain("Wrong value was returned  by VirtualMachine.instanceCounts(" + className + "): " + instanceCounts
                            + ", expected: >= " + expectedValue);
                }
            }
        } catch (Throwable e) {
            setSuccess(false);

            log.complain("Unexpected exception when getting instance count info:");
            e.printStackTrace(log.getOutStream());
        }
    }

    // Verifies number of instances of a class.
    // Two types of checks are done:
    //   1. Current instances >= old instances + created instances.
    //   2. New instances >= created instances.
    //
    // The check in case 1 can only be done for classes where the test controls
    // all created and deleted instances.
    // Other classes, like java.lang.String, can not make this check since
    // an instance in "old instances" may have been removed by a GC.
    // In that case the tetst would fail because it finds too few current instances.
    public void checkDebugeeAnswer_instanceCounts(String className, int countCreated, List<ObjectReference> oldReferences) {
        if (strictCheck(className)) {
            int countAll = countCreated + oldReferences.size();
            checkDebugeeAnswer_instanceCounts(className, countAll);
            checkDebugeeAnswer_instances(className, countAll);
        } else {
            // isDebuggeeReady() check is hidden in checkDebugeeAnswer_instanceCounts() above.
            // Must call it separately if we don't call checkDebugeeAnswer_instanceCounts().
            if (!isDebuggeeReady()) {
                return;
            }
        }

        // Verify number of new instances created.
        int countFoundCreated = countNewInstances(className, oldReferences);
        if (countFoundCreated < countCreated) {
            setSuccess(false);
            log.complain("Too few new instances(" + className + "). Expected >= " + countCreated + ", found " + countFoundCreated);
        }
    }

    private int countNewInstances(String className, List<ObjectReference> oldReferences) {
        // New references = current references - old references.
        List<ObjectReference> newReferences = new ArrayList<ObjectReference>(getObjectReferences(className, vm));
        newReferences.removeAll(oldReferences);
        return newReferences.size();
    }

    // check value returned by InterfaceType.instances
    protected void checkDebugeeAnswer_InterfaceType_instances(InterfaceType interfaceType, int expectedInstances) {
        int instanceCounts = interfaceType.instances(0).size();

        if (instanceCounts != expectedInstances) {
            setSuccess(false);
            log.complain("List with wrong size was returned by InterfaceType.instances(" + interfaceType.name() + "): " + instanceCounts
                         + ", expected: " + expectedInstances);
        }
    }

    static public List<ObjectReference> filterObjectReferrence(List<ObjectReference> objectsToFilter, List<ObjectReference> sourceList) {
        List<ObjectReference> result = new ArrayList<ObjectReference>();

        for (ObjectReference object : sourceList) {
            if (!objectsToFilter.contains(object))
                result.add(object);
        }

        return result;
    }

    static public List<ObjectReference> getObjectReferences(String className, VirtualMachine vm) {
        List<ReferenceType> referenceTypes = vm.classesByName(className);

        List<ObjectReference> objectReferences;

        if (referenceTypes.size() == 0)
            objectReferences = new ArrayList<ObjectReference>();
        else if (referenceTypes.size() == 1)
            objectReferences = referenceTypes.get(0).instances(0);
        else {
            throw new TestBug("Unexpected collection size returned by VirtualMachine.classesByName: " + referenceTypes.size()
                    + ", only 1 entry was expected.");
        }

        return objectReferences;
    }

}