1 /*
2 * Copyright (c) 2000, 2022, 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 package sun.jvm.hotspot.runtime;
26
27 import java.io.*;
28 import java.util.*;
29 import sun.jvm.hotspot.oops.*;
30 import sun.jvm.hotspot.utilities.*;
31 import sun.jvm.hotspot.debugger.*;
32
33 public abstract class JavaVFrame extends VFrame {
34
35 private static final String ADDRESS_FORMAT = VM.getVM().isLP64() ? "0x%016x"
36 : "0x%08x";
37
38 /** JVM state */
39 public abstract Method getMethod();
40 public abstract int getBCI();
41 public abstract StackValueCollection getLocals();
42 public abstract StackValueCollection getExpressions();
43 public abstract List<MonitorInfo> getMonitors();
44
45 /** Test operation */
46 public boolean isJavaFrame() { return true; }
47
48 /** Package-internal constructor */
49 JavaVFrame(Frame fr, RegisterMap regMap, JavaThread thread) {
50 super(fr, regMap, thread);
51 }
52
53 /** Get monitor (if any) that this JavaVFrame is trying to enter */
54 // FIXME: not yet implemented
55 // public Address getPendingMonitor(int frameCount);
56
57 public void printLockedObjectClassName(PrintStream tty,
58 OopHandle hobj, String lockState) {
59 if (hobj.asLongValue() != 0L) {
60 tty.format("\t- %s <" + ADDRESS_FORMAT + "> ",
61 lockState, hobj.asLongValue());
62
63 Klass klass = Oop.getKlassForOopHandle(hobj);
64 String klassName;
65 if (klass != null) {
66 klassName = klass.getName().asString();
67 } else {
68 klassName = "<unknown class>";
69 }
70 tty.print("(a ");
71 if (klassName.equals("java/lang/Class")) {
72 Oop obj = VM.getVM().getObjectHeap().newOop(hobj);
73 klassName = java_lang_Class.asExternalName(obj);
74 tty.print("java.lang.Class for ");
75 }
76 tty.println(klassName.replace('/', '.') + ")");
77 }
78 }
79
80 private String identifyLockState(MonitorInfo monitor, String waitingState) {
81 Mark mark = new Mark(monitor.owner());
82 if (mark.hasMonitor() &&
83 ( // we have marked ourself as pending on this monitor
84 mark.monitor().equals(thread.getCurrentPendingMonitor()) ||
85 // we are not the owner of this monitor
86 !mark.monitor().isEntered(thread)
87 )) {
88 return waitingState;
89 }
90 return "locked";
91 }
92
93 /** Printing used during stack dumps */
94 public void printLockInfo(PrintStream tty, int frameCount) {
95 // If this is the first frame and it is java.lang.Object.wait(...)
96 // then print out the receiver. Locals are not always available,
97 // e.g., compiled native frames have no scope so there are no locals.
98 if (frameCount == 0) {
99 if (getMethod().getName().asString().equals("wait") &&
100 getMethod().getMethodHolder().getName().asString().equals("java/lang/Object")) {
101 String waitState = "waiting on"; // assume we are waiting
102 // If earlier in the output we reported java.lang.Thread.State ==
103 // "WAITING (on object monitor)" and now we report "waiting on", then
104 // we are still waiting for notification or timeout. Otherwise if
105 // we earlier reported java.lang.Thread.State == "BLOCKED (on object
106 // monitor)", then we are actually waiting to re-lock the monitor.
107 StackValueCollection locs = getLocals();
108 if (!locs.isEmpty()) {
109 StackValue sv = locs.get(0);
110 if (sv.getType() == BasicType.getTObject()) {
111 OopHandle o = sv.getObject();
112 if (OopUtilities.threadOopGetThreadStatus(thread.getThreadObj()) == OopUtilities.THREAD_STATUS_BLOCKED_ON_MONITOR_ENTER) {
113 waitState = "waiting to re-lock in wait()";
114 }
115 printLockedObjectClassName(tty, o, waitState);
116 }
117 } else {
118 tty.println("\t- " + waitState + " <no object reference available>");
119 }
120 } else if (thread.getCurrentParkBlocker() != null) {
121 Oop obj = thread.getCurrentParkBlocker();
122 Klass k = obj.getKlass();
123 tty.format("\t- parking to wait for <" + ADDRESS_FORMAT + "> (a %s)",
124 obj.getHandle().asLongValue(), k.getName().asString());
125 tty.println();
126 }
127 }
128
129 // Print out all monitors that we have locked, or are trying to lock,
130 // including re-locking after being notified or timing out in a wait().
131 List<MonitorInfo> mons = getMonitors();
132 if (!mons.isEmpty()) {
133 boolean foundFirstMonitor = false;
134 for (int index = mons.size() - 1; index >= 0; index--) {
135 MonitorInfo monitor = mons.get(index);
136 if (monitor.eliminated() && isCompiledFrame()) { // Eliminated in compiled code
137 if (monitor.ownerIsScalarReplaced()) {
138 Klass k = Oop.getKlassForOopHandle(monitor.ownerKlass());
139 tty.println("\t- eliminated <owner is scalar replaced> (a " + k.getName().asString() + ")");
140 } else if (monitor.owner() != null) {
141 printLockedObjectClassName(tty, monitor.owner(), "eliminated");
142 }
143 continue;
144 }
145 if (monitor.owner() != null) {
146 // the monitor is associated with an object, i.e., it is locked
147 String lockState = "locked";
148 if (!foundFirstMonitor && frameCount == 0) {
149 // If this is the first frame and we haven't found an owned
150 // monitor before, then we need to see if we have completed
151 // the lock or if we are blocked trying to acquire it. Only
152 // an inflated monitor that is first on the monitor list in
153 // the first frame can block us on a monitor enter.
154 lockState = identifyLockState(monitor, "waiting to lock");
155 }
156 printLockedObjectClassName(tty, monitor.owner(), lockState);
157 foundFirstMonitor = true;
158 }
159 }
160 }
161 }
162
163 /** Printing operations */
164
165 //
166 // FIXME: implement visitor pattern for traversing vframe contents?
167 //
168
169 public void print() {
170 printOn(System.out);
171 }
172
173 public void printOn(PrintStream tty) {
174 super.printOn(tty);
175
176 tty.print("\t");
177 getMethod().printValueOn(tty);
178 tty.println();
179 tty.println("\tbci:\t" + getBCI());
180
181 printStackValuesOn(tty, "locals", getLocals());
182 printStackValuesOn(tty, "expressions", getExpressions());
183 }
184
185 public void printActivation(int index) {
186 printActivationOn(System.out, index);
187 }
188
189 public void printActivationOn(PrintStream tty, int index) {
190 // frame number and method
191 tty.print(index + " - ");
192 printValueOn(tty);
193 tty.println();
194
195 if (VM.getVM().wizardMode()) {
196 printOn(tty);
197 tty.println();
198 }
199 }
200
201 /** Verification operations */
202 public void verify() {
203 }
204
205 public boolean equals(Object o) {
206 if (!(o instanceof JavaVFrame other)) {
207 return false;
208 }
209
210 // Check static part
211 if (!getMethod().equals(other.getMethod())) {
212 return false;
213 }
214
215 if (getBCI() != other.getBCI()) {
216 return false;
217 }
218
219 // dynamic part - we just compare the frame pointer
220 if (! getFrame().equals(other.getFrame())) {
221 return false;
222 }
223 return true;
224 }
225
226 public int hashCode() {
227 return getMethod().hashCode() ^ getBCI() ^ getFrame().hashCode();
228 }
229
230 /** Structural compare */
231 public boolean structuralCompare(JavaVFrame other) {
232 // Check static part
233 if (!getMethod().equals(other.getMethod())) {
234 return false;
235 }
236
237 if (getBCI() != other.getBCI()) {
238 return false;
239 }
240
241 // Check locals
242 StackValueCollection locs = getLocals();
243 StackValueCollection otherLocs = other.getLocals();
244 if (Assert.ASSERTS_ENABLED) {
245 Assert.that(locs.size() == otherLocs.size(), "sanity check");
246 }
247 for (int i = 0; i < locs.size(); i++) {
248 // it might happen the compiler reports a conflict and
249 // the interpreter reports a bogus int.
250 if ( isCompiledFrame() && (locs.get(i)).getType() == BasicType.getTConflict()) continue;
251 if (other.isCompiledFrame() && (otherLocs.get(i)).getType() == BasicType.getTConflict()) continue;
252
253 if (!locs.get(i).equals(otherLocs.get(i))) {
254 return false;
255 }
256 }
257
258 // Check expressions
259 StackValueCollection exprs = getExpressions();
260 StackValueCollection otherExprs = other.getExpressions();
261 if (Assert.ASSERTS_ENABLED) {
262 Assert.that(exprs.size() == otherExprs.size(), "sanity check");
263 }
264 for (int i = 0; i < exprs.size(); i++) {
265 if (!exprs.get(i).equals(otherExprs.get(i))) {
266 return false;
267 }
268 }
269
270 return true;
271 }
272
273 //--------------------------------------------------------------------------------
274 // Internals only below this point
275 //
276
277 private void printStackValuesOn(PrintStream tty, String title, StackValueCollection values) {
278 if (values.isEmpty()) {
279 return;
280 }
281 tty.println("\t" + title + ":");
282 for (int index = 0; index < values.size(); index++) {
283 tty.print("\t" + index + "\t");
284 values.get(index).printOn(tty);
285 tty.println();
286 }
287 }
288 }