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/ciArray.hpp"
 26 #include "ci/ciArrayKlass.hpp"
 27 #include "ci/ciConstant.hpp"
 28 #include "ci/ciKlass.hpp"
 29 #include "ci/ciUtilities.inline.hpp"
 30 #include "oops/flatArrayKlass.hpp"
 31 #include "oops/layoutKind.hpp"
 32 #include "oops/objArrayOop.inline.hpp"
 33 #include "oops/oop.inline.hpp"
 34 #include "oops/typeArrayOop.inline.hpp"
 35 #include "utilities/powerOfTwo.hpp"
 36 
 37 // ciArray
 38 //
 39 // This class represents an arrayOop in the HotSpot virtual
 40 // machine.
 41 static BasicType fixup_element_type(BasicType bt) {
 42   if (bt == T_FLAT_ELEMENT) return T_OBJECT;
 43   if (is_reference_type(bt))  return T_OBJECT;
 44   if (bt == T_BOOLEAN)  return T_BYTE;
 45   return bt;
 46 }
 47 
 48 ciConstant ciArray::element_value_impl(BasicType elembt,
 49                                        arrayOop ary,
 50                                        int index) {
 51   if (ary == nullptr)
 52     return ciConstant();
 53   assert(ary->is_array(), "");
 54   if (index < 0 || index >= ary->length())
 55     return ciConstant();
 56   ArrayKlass* ak = (ArrayKlass*) ary->klass();
 57   BasicType abt = ak->element_type();
 58   if (fixup_element_type(elembt) !=
 59       fixup_element_type(abt))
 60     return ciConstant();
 61   switch (elembt) {
 62   case T_ARRAY:
 63   case T_OBJECT:
 64     {
 65       assert(ary->is_objArray(), "");
 66       objArrayOop objary = (objArrayOop) ary;
 67       oop elem = objary->obj_at(index);
 68       return ciConstant(elembt, CURRENT_ENV->get_object(elem));
 69     }
 70   default:
 71     break;
 72   }
 73   assert(ary->is_typeArray(), "");
 74   typeArrayOop tary = (typeArrayOop) ary;
 75   jint value = 0;
 76   switch (elembt) {
 77   case T_LONG:          return ciConstant(tary->long_at(index));
 78   case T_FLOAT:         return ciConstant(tary->float_at(index));
 79   case T_DOUBLE:        return ciConstant(tary->double_at(index));
 80   default:              return ciConstant();
 81   case T_BYTE:          value = tary->byte_at(index);           break;
 82   case T_BOOLEAN:       value = tary->byte_at(index) & 1;       break;
 83   case T_SHORT:         value = tary->short_at(index);          break;
 84   case T_CHAR:          value = tary->char_at(index);           break;
 85   case T_INT:           value = tary->int_at(index);            break;
 86   }
 87   return ciConstant(elembt, value);
 88 }
 89 
 90 // ------------------------------------------------------------------
 91 // ciArray::element_value
 92 //
 93 // Current value of an element.
 94 // Returns T_ILLEGAL if there is no element at the given index.
 95 ciConstant ciArray::element_value(int index) {
 96   BasicType elembt = element_basic_type();
 97   ciConstant value = check_constant_value_cache(index, elembt);
 98   if (value.is_valid()) {
 99     return value;
100   }
101   GUARDED_VM_ENTRY(
102     value = element_value_impl(elembt, get_arrayOop(), index);
103   )
104   add_to_constant_value_cache(index, value);
105   return value;
106 }
107 
108 // ------------------------------------------------------------------
109 // ciArray::element_value_by_offset
110 //
111 // Current value of an element at the specified offset.
112 // Returns T_ILLEGAL if there is no element at the given offset.
113 ciConstant ciArray::element_value_by_offset(intptr_t element_offset) {
114   BasicType elembt = element_basic_type();
115   intptr_t shift  = exact_log2(type2aelembytes(elembt));
116   intptr_t header = arrayOopDesc::base_offset_in_bytes(elembt);
117   intptr_t index = (element_offset - header) >> shift;
118   intptr_t offset = header + ((intptr_t)index << shift);
119   if (offset != element_offset || index != (jint)index || index < 0 || index >= length()) {
120     return ciConstant();
121   }
122   return element_value((jint) index);
123 }
124 
125 bool ciArray::is_null_free() {
126   VM_ENTRY_MARK;
127   return get_oop()->is_null_free_array();
128 }
129 
130 bool ciArray::is_atomic() {
131   VM_ENTRY_MARK;
132   arrayOop oop = get_arrayOop();
133   return !oop->is_flatArray() || LayoutKindHelper::is_atomic_flat(FlatArrayKlass::cast(oop->klass())->layout_kind());
134 }
135 
136 // ------------------------------------------------------------------
137 // ciArray::print_impl
138 //
139 // Implementation of the print method.
140 void ciArray::print_impl(outputStream* st) {
141   st->print(" length=%d type=", length());
142   klass()->print(st);
143 }