1 /*
  2  * Copyright (c) 1997, 2021, 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_OBJARRAYOOP_HPP
 26 #define SHARE_OOPS_OBJARRAYOOP_HPP
 27 
 28 #include "oops/arrayOop.hpp"
 29 #include "utilities/align.hpp"
 30 #include <type_traits>
 31 
 32 class Klass;
 33 
 34 // An objArrayOop is an array containing oops.
 35 // Evaluating "String arg[10]" will create an objArrayOop.
 36 
 37 class objArrayOopDesc : public arrayOopDesc {
 38   friend class ObjArrayKlass;
 39   friend class Runtime1;
 40   friend class psPromotionManager;
 41   friend class CSetMarkWordClosure;
 42   friend class Continuation;
 43   template <typename T>
 44   friend class RawOopWriter;
 45 
 46   template <class T> T* obj_at_addr(int index) const;
 47 
 48 public:
 49   template <class T> T* obj_at_address(int index) const {
 50     return obj_at_addr<T>(index);
 51   }
 52 
 53   template <class T>
 54   static ptrdiff_t obj_at_offset(int index) {
 55     return base_offset_in_bytes() + sizeof(T) * index;
 56   }
 57 
 58 private:
 59   // Give size of objArrayOop in HeapWords minus the header
 60   static int array_size(int length) {
 61     const uint OopsPerHeapWord = HeapWordSize/heapOopSize;
 62     assert(OopsPerHeapWord >= 1 && (HeapWordSize % heapOopSize == 0),
 63            "Else the following (new) computation would be in error");
 64     uint res = ((uint)length + OopsPerHeapWord - 1)/OopsPerHeapWord;
 65 #ifdef ASSERT
 66     // The old code is left in for sanity-checking; it'll
 67     // go away pretty soon. XXX
 68     // Without UseCompressedOops, this is simply:
 69     // oop->length() * HeapWordsPerOop;
 70     // With narrowOops, HeapWordsPerOop is 1/2 or equal 0 as an integer.
 71     // The oop elements are aligned up to wordSize
 72     const uint HeapWordsPerOop = heapOopSize/HeapWordSize;
 73     uint old_res;
 74     if (HeapWordsPerOop > 0) {
 75       old_res = length * HeapWordsPerOop;
 76     } else {
 77       old_res = align_up((uint)length, OopsPerHeapWord)/OopsPerHeapWord;
 78     }
 79     assert(res == old_res, "Inconsistency between old and new.");
 80 #endif  // ASSERT
 81     return res;
 82   }
 83 
 84  public:
 85   // Returns the offset of the first element.
 86   static int base_offset_in_bytes() {
 87     return arrayOopDesc::base_offset_in_bytes(T_OBJECT);
 88   }
 89 
 90   // base is the address following the header.
 91   HeapWord* base() const;
 92 
 93   // Accessing
 94   oop obj_at(int index) const;
 95 
 96   void obj_at_put(int index, oop value);
 97   template <DecoratorSet ds>
 98   void obj_at_put_access(int index, oop value);
 99 
100   oop atomic_compare_exchange_oop(int index, oop exchange_value, oop compare_value);
101 
102   // Sizing
103   static int header_size()    { return arrayOopDesc::header_size(T_OBJECT); }
104   int object_size()           { return object_size(length()); }
105 
106   static int object_size(int length) {
107     // This returns the object size in HeapWords.
108     uint asz = array_size(length);
109     uint osz = align_object_size(header_size() + asz);
110     assert(osz >= asz,   "no overflow");
111     assert((int)osz > 0, "no overflow");
112     return (int)osz;
113   }
114 
115   Klass* element_klass();
116 
117 public:
118   // special iterators for index ranges, returns size of object
119   template <typename OopClosureType>
120   void oop_iterate_range(OopClosureType* blk, int start, int end);
121 };
122 
123 // See similar requirement for oopDesc.
124 static_assert(std::is_trivially_default_constructible<objArrayOopDesc>::value, "required");
125 
126 #endif // SHARE_OOPS_OBJARRAYOOP_HPP