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