1 /*
2 * Copyright (c) 2001, 2023, 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.oops;
26
27 import java.io.*;
28 import java.util.*;
29
30 import sun.jvm.hotspot.debugger.*;
31 import sun.jvm.hotspot.runtime.*;
32 import sun.jvm.hotspot.types.*;
33 import sun.jvm.hotspot.utilities.*;
34 import sun.jvm.hotspot.utilities.Observable;
35 import sun.jvm.hotspot.utilities.Observer;
36
37 public class Mark extends VMObject {
38 static {
39 VM.registerVMInitializedObserver(new Observer() {
40 public void update(Observable o, Object data) {
41 initialize(VM.getVM().getTypeDataBase());
42 }
43 });
44 }
45
46 private static synchronized void initialize(TypeDataBase db) throws WrongTypeException {
47 Type type = db.lookupType("oopDesc");
48 markField = type.getCIntegerField("_mark");
49
50 ageBits = db.lookupLongConstant("markWord::age_bits").longValue();
51 lockBits = db.lookupLongConstant("markWord::lock_bits").longValue();
52 maxHashBits = db.lookupLongConstant("markWord::max_hash_bits").longValue();
53 hashBits = db.lookupLongConstant("markWord::hash_bits").longValue();
54 lockShift = db.lookupLongConstant("markWord::lock_shift").longValue();
55 ageShift = db.lookupLongConstant("markWord::age_shift").longValue();
56 hashShift = db.lookupLongConstant("markWord::hash_shift").longValue();
57 lockMask = db.lookupLongConstant("markWord::lock_mask").longValue();
58 lockMaskInPlace = db.lookupLongConstant("markWord::lock_mask_in_place").longValue();
59 ageMask = db.lookupLongConstant("markWord::age_mask").longValue();
60 ageMaskInPlace = db.lookupLongConstant("markWord::age_mask_in_place").longValue();
61 hashMask = db.lookupLongConstant("markWord::hash_mask").longValue();
62 hashMaskInPlace = db.lookupLongConstant("markWord::hash_mask_in_place").longValue();
63 lockedValue = db.lookupLongConstant("markWord::locked_value").longValue();
64 unlockedValue = db.lookupLongConstant("markWord::unlocked_value").longValue();
65 monitorValue = db.lookupLongConstant("markWord::monitor_value").longValue();
66 markedValue = db.lookupLongConstant("markWord::marked_value").longValue();
67 noHash = db.lookupLongConstant("markWord::no_hash").longValue();
68 noHashInPlace = db.lookupLongConstant("markWord::no_hash_in_place").longValue();
69 noLockInPlace = db.lookupLongConstant("markWord::no_lock_in_place").longValue();
70 maxAge = db.lookupLongConstant("markWord::max_age").longValue();
71 }
72
73 // Field accessors
74 private static CIntegerField markField;
75
76 // Constants -- read from VM
77 private static long ageBits;
78 private static long lockBits;
79 private static long maxHashBits;
80 private static long hashBits;
81
82 private static long lockShift;
83 private static long ageShift;
84 private static long hashShift;
85
86 private static long lockMask;
87 private static long lockMaskInPlace;
88 private static long ageMask;
89 private static long ageMaskInPlace;
90 private static long hashMask;
91 private static long hashMaskInPlace;
92
93 private static long lockedValue;
94 private static long unlockedValue;
95 private static long monitorValue;
96 private static long markedValue;
97
98 private static long noHash;
99
100 private static long noHashInPlace;
101 private static long noLockInPlace;
102
103 private static long maxAge;
104
105 public Mark(Address addr) {
106 super(addr);
107 }
108
109 public long value() {
110 return markField.getValue(addr);
111 }
112
113 public Address valueAsAddress() {
114 return addr.getAddressAt(markField.getOffset());
115 }
116
117 // lock accessors (note that these assume lock_shift == 0)
118 public boolean isLocked() {
119 return (Bits.maskBitsLong(value(), lockMaskInPlace) != unlockedValue);
120 }
121 public boolean isUnlocked() {
122 return (Bits.maskBitsLong(value(), lockMaskInPlace) == unlockedValue);
123 }
124 public boolean isMarked() {
125 return (Bits.maskBitsLong(value(), lockMaskInPlace) == markedValue);
126 }
127
128 // Special temporary state of the markWord while being inflated.
129 // Code that looks at mark outside a lock need to take this into account.
130 public boolean isBeingInflated() {
131 return (value() == 0);
132 }
133
134 // Should this header be preserved during GC?
135 public boolean mustBePreserved() {
136 return (!isUnlocked() || !hasNoHash());
137 }
138
139 // WARNING: The following routines are used EXCLUSIVELY by
140 // synchronization functions. They are not really gc safe.
141 // They must get updated if markWord layout get changed.
142
143 public boolean hasLocker() {
144 return ((value() & lockMaskInPlace) == lockedValue);
145 }
146 public BasicLock locker() {
147 if (Assert.ASSERTS_ENABLED) {
148 Assert.that(hasLocker(), "check");
149 }
150 return new BasicLock(valueAsAddress());
151 }
152 public boolean hasMonitor() {
153 return ((value() & monitorValue) != 0);
154 }
155 public ObjectMonitor monitor() {
156 if (Assert.ASSERTS_ENABLED) {
157 Assert.that(hasMonitor(), "check");
158 }
159 // Use xor instead of &~ to provide one extra tag-bit check.
160 Address monAddr = valueAsAddress().xorWithMask(monitorValue);
161 return new ObjectMonitor(monAddr);
162 }
163 public boolean hasDisplacedMarkHelper() {
164 return ((value() & unlockedValue) == 0);
165 }
166 public Mark displacedMarkHelper() {
167 if (Assert.ASSERTS_ENABLED) {
168 Assert.that(hasDisplacedMarkHelper(), "check");
169 }
170 Address addr = valueAsAddress().andWithMask(~monitorValue);
171 return new Mark(addr.getAddressAt(0));
172 }
173 public int age() { return (int) Bits.maskBitsLong(value() >> ageShift, ageMask); }
174
175 // hash operations
176 public long hash() {
177 return Bits.maskBitsLong(value() >> hashShift, hashMask);
178 }
179
180 public boolean hasNoHash() {
181 return hash() == noHash;
182 }
183
184 // Debugging
185 public void printOn(PrintStream tty) {
186 if (isLocked()) {
187 tty.print("locked(0x" +
188 Long.toHexString(value()) + ")->");
189 displacedMarkHelper().printOn(tty);
190 } else {
191 if (Assert.ASSERTS_ENABLED) {
192 Assert.that(isUnlocked(), "just checking");
193 }
194 tty.print("mark(");
195 tty.print("hash " + Long.toHexString(hash()) + ",");
196 tty.print("age " + age() + ")");
197 }
198 }
199
200 public long getSize() { return (long)value(); }
201 }