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/ciFlatArrayKlass.hpp"
 27 #include "ci/ciInlineKlass.hpp"
 28 #include "ci/ciObjArrayKlass.hpp"
 29 #include "ci/ciTypeArrayKlass.hpp"
 30 #include "ci/ciUtilities.inline.hpp"
 31 #include "memory/universe.hpp"
 32 #include "oops/inlineKlass.inline.hpp"
 33 
 34 // ciArrayKlass
 35 //
 36 // This class represents a Klass* in the HotSpot virtual machine
 37 // whose Klass part in an ArrayKlass.
 38 
 39 // ------------------------------------------------------------------
 40 // ciArrayKlass::ciArrayKlass
 41 //
 42 // Loaded array klass.
 43 ciArrayKlass::ciArrayKlass(Klass* k) : ciKlass(k) {
 44   assert(get_Klass()->is_array_klass(), "wrong type");
 45   _dimension = get_ArrayKlass()->dimension();
 46 }
 47 
 48 // ------------------------------------------------------------------
 49 // ciArrayKlass::ciArrayKlass
 50 //
 51 // Unloaded array klass.
 52 ciArrayKlass::ciArrayKlass(ciSymbol* name, int dimension, BasicType bt)
 53   : ciKlass(name, bt) {
 54   _dimension = dimension;
 55 }
 56 
 57 // ------------------------------------------------------------------
 58 // ciArrayKlass::element_type
 59 //
 60 // What type is obtained when this array is indexed once?
 61 ciType* ciArrayKlass::element_type() {
 62   if (is_type_array_klass()) {
 63     return ciType::make(as_type_array_klass()->element_type());
 64   } else {
 65     return element_klass()->as_klass();
 66   }
 67 }
 68 
 69 
 70 // ------------------------------------------------------------------
 71 // ciArrayKlass::base_element_type
 72 //
 73 // What type is obtained when this array is indexed as many times as possible?
 74 ciType* ciArrayKlass::base_element_type() {
 75   if (is_type_array_klass()) {
 76     return ciType::make(as_type_array_klass()->element_type());
 77   } else if (is_obj_array_klass()) {
 78     ciKlass* ek = as_obj_array_klass()->base_element_klass();
 79     if (ek->is_type_array_klass()) {
 80       return ciType::make(ek->as_type_array_klass()->element_type());
 81     }
 82     return ek;
 83   } else {
 84     return as_flat_array_klass()->base_element_klass();
 85   }
 86 }
 87 
 88 
 89 // ------------------------------------------------------------------
 90 // ciArrayKlass::is_leaf_type
 91 bool ciArrayKlass::is_leaf_type() {
 92   if (is_type_array_klass()) {
 93     return true;
 94   } else {
 95     return as_obj_array_klass()->base_element_klass()->is_leaf_type();
 96   }
 97 }
 98 
 99 
100 // ------------------------------------------------------------------
101 // ciArrayKlass::make
102 //
103 // Make an array klass of the specified element type.
104 ciArrayKlass* ciArrayKlass::make(ciType* element_type, bool null_free, bool atomic, bool vm_type) {
105   if (element_type->is_primitive_type()) {
106     return ciTypeArrayKlass::make(element_type->basic_type());
107   }
108 
109   ciKlass* klass = element_type->as_klass();
110   assert(!null_free || !klass->is_loaded() || klass->is_inlinetype() || klass->is_abstract() ||
111          klass->is_java_lang_Object(), "only value classes are null free");
112   if (klass->is_loaded() && klass->is_inlinetype() && vm_type) {
113     GUARDED_VM_ENTRY(
114       EXCEPTION_CONTEXT;
115       InlineKlass* vk = InlineKlass::cast(klass->get_Klass());
116       ArrayKlass::ArrayProperties props = ArrayKlass::ArrayProperties::DEFAULT;
117       if (null_free) {
118         props = (ArrayKlass::ArrayProperties)(props | ArrayKlass::ArrayProperties::NULL_RESTRICTED);
119       }
120       if (!atomic) {
121         props = (ArrayKlass::ArrayProperties)(props | ArrayKlass::ArrayProperties::NON_ATOMIC);
122       }
123       ArrayKlass* ak = vk->array_klass(THREAD);
124       ak = ObjArrayKlass::cast(ak)->klass_with_properties(props, THREAD);
125       if (HAS_PENDING_EXCEPTION) {
126         CLEAR_PENDING_EXCEPTION;
127       } else if (ak->is_flatArray_klass()) {
128         return CURRENT_THREAD_ENV->get_flat_array_klass(ak);
129       } else if (ak->is_refArray_klass()) {
130         return CURRENT_THREAD_ENV->get_obj_array_klass(ak);
131       }
132     )
133   }
134   return ciObjArrayKlass::make(klass, vm_type);
135 }
136 
137 int ciArrayKlass::array_header_in_bytes() {
138   return get_ArrayKlass()->array_header_in_bytes();
139 }
140 
141 ciInstance* ciArrayKlass::component_mirror_instance() const {
142   GUARDED_VM_ENTRY(
143     oop component_mirror = ArrayKlass::cast(get_Klass())->component_mirror();
144     return CURRENT_ENV->get_instance(component_mirror);
145   )
146 }
147 
148 bool ciArrayKlass::is_elem_null_free() const {
149   GUARDED_VM_ENTRY(return is_loaded() && get_Klass()->is_null_free_array_klass();)
150 }
151 
152 bool ciArrayKlass::is_elem_atomic() {
153   ciKlass* elem = element_klass();
154   GUARDED_VM_ENTRY(return elem != nullptr && elem->is_inlinetype() &&
155                           (ArrayKlass::cast(get_Klass())->properties() & ArrayKlass::ArrayProperties::INVALID) == 0 &&
156                           (ArrayKlass::cast(get_Klass())->properties() & ArrayKlass::ArrayProperties::NON_ATOMIC) == 0;)
157 }