1 /*
 2  * Copyright (c) 2025, 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 #ifndef SHARE_OOPS_REFARRAYOOP_HPP
26 #define SHARE_OOPS_REFARRAYOOP_HPP
27 
28 #include "oops/arrayOop.hpp"
29 #include "utilities/align.hpp"
30 
31 #include <type_traits>
32 
33 class Klass;
34 
35 // An refArrayOop is an array containing references (oops).
36 // Evaluating "String arg[10]" will create an refArrayOop.
37 
38 class refArrayOopDesc : public arrayOopDesc {
39   friend class ArchiveHeapWriter;
40   friend class RefArrayKlass;
41   friend class Runtime1;
42   friend class psPromotionManager;
43   friend class CSetMarkWordClosure;
44   friend class Continuation;
45   template <typename T>
46   friend class RawOopWriter;
47   friend class AOTMapLogger;
48 
49   template <class T> T* obj_at_addr(int index) const;
50 
51   template <class T>
52   static ptrdiff_t obj_at_offset(int index) {
53     return base_offset_in_bytes() + sizeof(T) * index;
54   }
55 
56  public:
57   // Returns the offset of the first element.
58   static int base_offset_in_bytes() {
59     return arrayOopDesc::base_offset_in_bytes(T_OBJECT);
60   }
61 
62   inline static refArrayOop cast(oop o);
63 
64   // base is the address following the header.
65   inline HeapWord* base() const;
66 
67   // Accessing
68   oop obj_at(int index) const;
69   oop obj_at(int index, TRAPS) const;
70 
71   void obj_at_put(int index, oop value);
72   void obj_at_put(int index, oop value, TRAPS);
73 
74   oop replace_if_null(int index, oop exchange_value);
75 
76   // Sizing
77   size_t object_size()        { return object_size(length()); }
78 
79   static size_t object_size(int length) {
80     // This returns the object size in HeapWords.
81     size_t asz = (size_t)length * heapOopSize;
82     size_t size_words = heap_word_size(base_offset_in_bytes() + asz);
83     size_t osz = align_object_size(size_words);
84     assert(osz < max_jint, "no overflow");
85     return osz;
86   }
87 
88   Klass* element_klass();
89 
90 public:
91   // special iterators for index ranges, returns size of object
92   template <typename OopClosureType>
93   void oop_iterate_range(OopClosureType* blk, int start, int end);
94 };
95 
96 // See similar requirement for oopDesc.
97 static_assert(std::is_trivially_default_constructible<refArrayOopDesc>::value, "required");
98 
99 #endif // SHARE_OOPS_REFARRAYOOP_HPP