1 /*
  2  * Copyright (c) 1999, 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 #include "ci/ciArrayKlass.hpp"
 26 #include "ci/ciObjArrayKlass.hpp"
 27 #include "ci/ciTypeArrayKlass.hpp"
 28 #include "ci/ciUtilities.inline.hpp"
 29 #include "memory/universe.hpp"
 30 #include "oops/arrayKlass.hpp"
 31 
 32 // ciArrayKlass
 33 //
 34 // This class represents a Klass* in the HotSpot virtual machine
 35 // whose Klass part in an ArrayKlass.
 36 
 37 // ------------------------------------------------------------------
 38 // ciArrayKlass::ciArrayKlass
 39 //
 40 // Loaded array klass.
 41 ciArrayKlass::ciArrayKlass(Klass* k) : ciKlass(k) {
 42   assert(get_Klass()->is_array_klass(), "wrong type");
 43   _dimension = get_ArrayKlass()->dimension();
 44 }
 45 
 46 // ------------------------------------------------------------------
 47 // ciArrayKlass::ciArrayKlass
 48 //
 49 // Unloaded array klass.
 50 ciArrayKlass::ciArrayKlass(ciSymbol* name, int dimension, BasicType bt)
 51   : ciKlass(name, bt) {
 52   _dimension = dimension;
 53 }
 54 
 55 // ------------------------------------------------------------------
 56 // ciArrayKlass::element_type
 57 //
 58 // What type is obtained when this array is indexed once?
 59 ciType* ciArrayKlass::element_type() {
 60   if (is_type_array_klass()) {
 61     return ciType::make(as_type_array_klass()->element_type());
 62   } else {
 63     return element_klass()->as_klass();
 64   }
 65 }
 66 
 67 
 68 // ------------------------------------------------------------------
 69 // ciArrayKlass::base_element_type
 70 //
 71 // What type is obtained when this array is indexed as many times as possible?
 72 ciType* ciArrayKlass::base_element_type() {
 73   if (is_type_array_klass()) {
 74     return ciType::make(as_type_array_klass()->element_type());
 75   } else {
 76     ciKlass* ek = as_obj_array_klass()->base_element_klass();
 77     if (ek->is_type_array_klass()) {
 78       return ciType::make(ek->as_type_array_klass()->element_type());
 79     }
 80     return ek;
 81   }
 82 }
 83 
 84 
 85 // ------------------------------------------------------------------
 86 // ciArrayKlass::is_leaf_type
 87 bool ciArrayKlass::is_leaf_type() {
 88   if (is_type_array_klass()) {
 89     return true;
 90   } else {
 91     return as_obj_array_klass()->base_element_klass()->is_leaf_type();
 92   }
 93 }
 94 
 95 
 96 // ------------------------------------------------------------------
 97 // ciArrayKlass::make
 98 //
 99 // Make an array klass of the specified element type.
100 ciArrayKlass* ciArrayKlass::make(ciType* element_type, bool null_free, bool atomic, bool refined_type) {
101   if (element_type->is_primitive_type()) {
102     return ciTypeArrayKlass::make(element_type->basic_type());
103   } else {
104     return ciObjArrayKlass::make(element_type->as_klass(), refined_type, null_free, atomic);
105   }
106 }
107 
108 int ciArrayKlass::array_header_in_bytes() {
109   return get_ArrayKlass()->array_header_in_bytes();
110 }
111 
112 ciInstance* ciArrayKlass::component_mirror_instance() const {
113   GUARDED_VM_ENTRY(
114     oop component_mirror = ArrayKlass::cast(get_Klass())->component_mirror();
115     return CURRENT_ENV->get_instance(component_mirror);
116   )
117 }
118 
119 bool ciArrayKlass::is_elem_null_free() const {
120   ArrayProperties props = properties();
121   assert(props.is_valid(), "meaningless");
122   return props.is_null_restricted();
123 }
124 
125 bool ciArrayKlass::is_elem_atomic() const {
126   ArrayProperties props = properties();
127   assert(props.is_valid(), "meaningless");
128   return !props.is_non_atomic();
129 }
130 
131 ArrayProperties ciArrayKlass::properties() const {
132   GUARDED_VM_ENTRY(return ArrayKlass::cast(get_Klass())->properties();)
133 }