1/*
2 * Copyright (c) 2015, 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#ifndef SHARE_GC_Z_ZADDRESS_INLINE_HPP
25#define SHARE_GC_Z_ZADDRESS_INLINE_HPP
26
27#include "gc/z/zAddress.hpp"
28#include "gc/z/zGlobals.hpp"
29#include "utilities/globalDefinitions.hpp"
30#include "utilities/macros.hpp"
31
32inline bool ZAddress::is_null(uintptr_t value) {
33 return value == 0;
34}
35
36inline bool ZAddress::is_bad(uintptr_t value) {
37 return value & ZAddressBadMask;
38}
39
40inline bool ZAddress::is_good(uintptr_t value) {
41 return !is_bad(value) && !is_null(value);
42}
43
44inline bool ZAddress::is_good_or_null(uintptr_t value) {
45 // Checking if an address is "not bad" is an optimized version of
46 // checking if it's "good or null", which eliminates an explicit
47 // null check. However, the implicit null check only checks that
48 // the mask bits are zero, not that the entire address is zero.
49 // This means that an address without mask bits would pass through
50 // the barrier as if it was null. This should be harmless as such
51 // addresses should ever be passed through the barrier.
52 const bool result = !is_bad(value);
53 assert((is_good(value) || is_null(value)) == result, "Bad address");
54 return result;
55}
56
57inline bool ZAddress::is_weak_bad(uintptr_t value) {
58 return value & ZAddressWeakBadMask;
59}
60
61inline bool ZAddress::is_weak_good(uintptr_t value) {
62 return !is_weak_bad(value) && !is_null(value);
63}
64
65inline bool ZAddress::is_weak_good_or_null(uintptr_t value) {
66 return !is_weak_bad(value);
67}
68
69inline bool ZAddress::is_marked(uintptr_t value) {
70 return value & ZAddressMetadataMarked;
71}
72
73inline bool ZAddress::is_finalizable(uintptr_t value) {
74 return value & ZAddressMetadataFinalizable;
75}
76
77inline bool ZAddress::is_finalizable_good(uintptr_t value) {
78 return is_finalizable(value) && is_good(value ^ ZAddressMetadataFinalizable);
79}
80
81inline bool ZAddress::is_remapped(uintptr_t value) {
82 return value & ZAddressMetadataRemapped;
83}
84
85inline bool ZAddress::is_in(uintptr_t value) {
86 // Check that exactly one non-offset bit is set
87 if (!is_power_of_2(value & ~ZAddressOffsetMask)) {
88 return false;
89 }
90
91 // Check that one of the non-finalizable metadata is set
92 return value & (ZAddressMetadataMask & ~ZAddressMetadataFinalizable);
93}
94
95inline uintptr_t ZAddress::address(uintptr_t value) {
96 return value | ZAddressBase;
97}
98
99inline uintptr_t ZAddress::offset(uintptr_t value) {
100 return value & ZAddressOffsetMask;
101}
102
103inline uintptr_t ZAddress::good(uintptr_t value) {
104 return address(offset(value) | ZAddressGoodMask);
105}
106
107inline uintptr_t ZAddress::good_or_null(uintptr_t value) {
108 return is_null(value) ? 0 : good(value);
109}
110
111inline uintptr_t ZAddress::finalizable_good(uintptr_t value) {
112 return address(offset(value) | ZAddressMetadataFinalizable | ZAddressGoodMask);
113}
114
115inline uintptr_t ZAddress::marked(uintptr_t value) {
116 return address(offset(value) | ZAddressMetadataMarked);
117}
118
119inline uintptr_t ZAddress::marked0(uintptr_t value) {
120 return address(offset(value) | ZAddressMetadataMarked0);
121}
122
123inline uintptr_t ZAddress::marked1(uintptr_t value) {
124 return address(offset(value) | ZAddressMetadataMarked1);
125}
126
127inline uintptr_t ZAddress::remapped(uintptr_t value) {
128 return address(offset(value) | ZAddressMetadataRemapped);
129}
130
131inline uintptr_t ZAddress::remapped_or_null(uintptr_t value) {
132 return is_null(value) ? 0 : remapped(value);
133}
134
135#endif // SHARE_GC_Z_ZADDRESS_INLINE_HPP
136