1 /*
  2  * Copyright (c) 2015, 2026, 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_ZUTILS_INLINE_HPP
 25 #define SHARE_GC_Z_ZUTILS_INLINE_HPP
 26 
 27 #include "gc/z/zUtils.hpp"
 28 
 29 #include "gc/z/zAddress.inline.hpp"
 30 #include "oops/oop.inline.hpp"
 31 #include "runtime/os.hpp"
 32 #include "utilities/align.hpp"
 33 #include "utilities/copy.hpp"
 34 #include "utilities/debug.hpp"
 35 #include "utilities/globalDefinitions.hpp"
 36 
 37 inline uintptr_t ZUtils::alloc_aligned_unfreeable(size_t alignment, size_t size) {
 38   const size_t padded_size = size + (alignment - 1);
 39   void* const addr = os::malloc(padded_size, mtGC);
 40   if (addr == nullptr) {
 41     vm_exit_out_of_memory(padded_size, OOM_MALLOC_ERROR, "ZGC alloc_aligned_unfreeable malloc failed");
 42   }
 43   void* const aligned_addr = align_up(addr, alignment);
 44 
 45   memset(aligned_addr, 0, size);
 46 
 47   // Since free expects pointers returned by malloc, aligned_addr cannot be
 48   // freed since it is most likely not the same as addr after alignment.
 49   return (uintptr_t)aligned_addr;
 50 }
 51 
 52 inline size_t ZUtils::bytes_to_words(size_t size_in_bytes) {
 53   assert(is_aligned(size_in_bytes, BytesPerWord), "Size not word aligned");
 54   return size_in_bytes >> LogBytesPerWord;
 55 }
 56 
 57 inline size_t ZUtils::words_to_bytes(size_t size_in_words) {
 58   return size_in_words << LogBytesPerWord;
 59 }
 60 
 61 inline size_t ZUtils::object_size(zaddress addr) {
 62   return words_to_bytes(to_oop(addr)->size());
 63 }
 64 
 65 inline void ZUtils::object_copy_disjoint(zaddress from, zaddress to, size_t size) {
 66   Copy::aligned_disjoint_words((HeapWord*)untype(from), (HeapWord*)untype(to), bytes_to_words(size));
 67 }
 68 
 69 inline void ZUtils::object_copy_conjoint(zaddress from, zaddress to, size_t size) {
 70   if (from != to) {
 71     Copy::aligned_conjoint_words((HeapWord*)untype(from), (HeapWord*)untype(to), bytes_to_words(size));
 72   }
 73 }
 74 
 75 template <typename T>
 76 inline void ZUtils::copy_disjoint(T* dest, const T* src, size_t count) {
 77   memcpy(dest, src, sizeof(T) * count);
 78 }
 79 
 80 template <typename T>
 81 inline void ZUtils::copy_disjoint(T* dest, const T* src, int count) {
 82   assert(count >= 0, "must be positive %d", count);
 83 
 84   copy_disjoint(dest, src, static_cast<size_t>(count));
 85 }
 86 
 87 template <typename T, typename Comparator>
 88 inline void ZUtils::sort(T* array, size_t count, Comparator comparator) {
 89   using SortType = int(const void*, const void*);
 90   using ComparatorType = int(const T*, const T*);
 91 
 92   ComparatorType* const comparator_fn_ptr = comparator;
 93 
 94   // We rely on ABI compatibility between ComparatorType and SortType
 95   qsort(array, count, sizeof(T), reinterpret_cast<SortType*>(comparator_fn_ptr));
 96 }
 97 
 98 template <typename T, typename Comparator>
 99 inline void ZUtils::sort(T* array, int count, Comparator comparator) {
100   assert(count >= 0, "must be positive %d", count);
101 
102   sort(array, static_cast<size_t>(count), comparator);
103 }
104 
105 #endif // SHARE_GC_Z_ZUTILS_INLINE_HPP