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