1 /*
2 * Copyright (c) 1998, 2026, 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/ciInstanceKlass.hpp"
26 #include "compiler/compileLog.hpp"
27 #include "interpreter/linkResolver.hpp"
28 #include "memory/universe.hpp"
29 #include "oops/accessDecorators.hpp"
30 #include "oops/flatArrayKlass.hpp"
31 #include "oops/objArrayKlass.hpp"
32 #include "opto/addnode.hpp"
33 #include "opto/castnode.hpp"
34 #include "opto/inlinetypenode.hpp"
35 #include "opto/memnode.hpp"
36 #include "opto/parse.hpp"
37 #include "opto/rootnode.hpp"
38 #include "opto/runtime.hpp"
39 #include "opto/subnode.hpp"
40 #include "runtime/deoptimization.hpp"
41 #include "runtime/handles.inline.hpp"
42
43 //=============================================================================
44 // Helper methods for _get* and _put* bytecodes
45 //=============================================================================
46
47 void Parse::do_field_access(bool is_get, bool is_field) {
48 bool will_link;
49 ciField* field = iter().get_field(will_link);
50 assert(will_link, "getfield: typeflow responsibility");
51
52 if (is_field == field->is_static()) {
53 // Interpreter will throw java_lang_IncompatibleClassChangeError
54 // Check this before allowing <clinit> methods to access static fields
55 uncommon_trap(Deoptimization::Reason_unhandled,
56 Deoptimization::Action_none);
57 return;
58 }
59
60 // Deoptimize on putfield writes to call site target field outside of CallSite ctor.
61 ciInstanceKlass* field_holder = field->holder();
62 if (!is_get && field->is_call_site_target() &&
63 !(method()->holder() == field_holder && method()->is_object_constructor())) {
64 uncommon_trap(Deoptimization::Reason_unhandled,
65 Deoptimization::Action_reinterpret,
66 nullptr, "put to call site target field");
67 return;
68 }
69
70 if (C->needs_clinit_barrier(field, method())) {
71 clinit_barrier(field_holder, method());
72 if (stopped()) return;
73 }
74
75 assert(field->will_link(method(), bc()), "getfield: typeflow responsibility");
76
77 // Note: We do not check for an unloaded field type here any more.
78
79 // Generate code for the object pointer.
80 Node* obj;
81 if (is_field) {
82 int obj_depth = is_get ? 0 : field->type()->size();
83 obj = null_check(peek(obj_depth));
84 // Compile-time detect of null-exception?
85 if (stopped()) return;
86
87 #ifdef ASSERT
88 const TypeInstPtr *tjp = TypeInstPtr::make(TypePtr::NotNull, iter().get_declared_field_holder());
89 assert(_gvn.type(obj)->higher_equal(tjp), "cast_up is no longer needed");
90 #endif
91
92 if (is_get) {
93 do_get_xxx(obj, field);
94 } else {
95 do_put_xxx(obj, field, is_field);
96 if (stopped()) {
97 return;
98 }
99 (void) pop(); // pop receiver after putting
100 }
101 } else {
102 const TypeInstPtr* tip = TypeInstPtr::make(field_holder->java_mirror());
103 obj = _gvn.makecon(tip);
104 if (is_get) {
105 do_get_xxx(obj, field);
106 } else {
107 do_put_xxx(obj, field, is_field);
108 }
109 }
110 }
111
112 void Parse::do_get_xxx(Node* obj, ciField* field) {
113 BasicType bt = field->layout_type();
114 // Does this field have a constant value? If so, just push the value.
115 if (field->is_constant() && !field->is_flat() &&
116 // Keep consistent with types found by ciTypeFlow: for an
117 // unloaded field type, ciTypeFlow::StateVector::do_getstatic()
118 // speculates the field is null. The code in the rest of this
119 // method does the same. We must not bypass it and use a non
120 // null constant here.
121 (bt != T_OBJECT || field->type()->is_loaded())) {
122 // final or stable field
123 Node* con = make_constant_from_field(field, obj);
124 if (con != nullptr) {
125 if (!field->is_static()) {
126 pop();
127 }
128 push_node(field->layout_type(), con);
129 return;
130 }
131 }
132
133 if (obj->is_InlineType()) {
134 assert(!field->is_static(), "must not be a static field");
135 InlineTypeNode* vt = obj->as_InlineType();
136 Node* value = vt->field_value_by_offset(field->offset_in_bytes(), false);
137 const Type* value_type = _gvn.type(value);
138 if (value->is_InlineType()) {
139 value = value->as_InlineType()->adjust_scalarization_depth(this);
140 } else if (value_type->is_inlinetypeptr()) {
141 value = InlineTypeNode::make_from_oop(this, value, value_type->inline_klass());
142 }
143 pop();
144 push_node(field->layout_type(), value);
145 return;
146 }
147
148 ciType* field_klass = field->type();
149 field_klass = improve_abstract_inline_type_klass(field_klass);
150 int offset = field->offset_in_bytes();
151 bool must_assert_null = false;
152 Node* adr = basic_plus_adr(obj, obj, offset);
153 assert(C->get_alias_index(C->alias_type(field)->adr_type()) == C->get_alias_index(_gvn.type(adr)->isa_ptr()),
154 "slice of address and input slice don't match");
155
156 Node* ld = nullptr;
157 if (field_klass->is_inlinetype()) { // could also have an abstract value class
158 ciInlineKlass* vk = field_klass->as_inline_klass();
159 if (field->is_null_free() && vk->is_empty()) {
160 // Loading from a field of an empty inline type. Just return the default instance.
161 ld = InlineTypeNode::make_all_zero(_gvn, vk);
162 } else if (field->is_flat()) {
163 // Loading from a flat inline type field.
164 bool is_immutable = field->is_final() && field->is_strict();
165 bool atomic = field->is_atomic();
166 ld = InlineTypeNode::make_from_flat(this, vk, obj, adr, atomic, is_immutable, field->is_null_free(), IN_HEAP | MO_UNORDERED);
167 }
168 }
169 if (ld == nullptr) {
170 // Build the resultant type of the load
171 assert(!field->is_flat(), "cannot be flat");
172 const Type* type;
173 if (is_reference_type(bt)) {
174 if (!field_klass->is_loaded()) {
175 type = TypeInstPtr::BOTTOM;
176 must_assert_null = true;
177 } else if (field->is_static_constant()) {
178 // This can happen if the constant oop is non-perm.
179 ciObject* con = field->constant_value().as_object();
180 // Do not "join" in the previous type; it doesn't add value,
181 // and may yield a vacuous result if the field is of interface type.
182 if (con->is_null_object()) {
183 type = TypePtr::NULL_PTR;
184 } else {
185 type = TypeOopPtr::make_from_constant(con)->isa_oopptr();
186 }
187 assert(type != nullptr, "field singleton type must be consistent");
188 } else {
189 type = TypeOopPtr::make_from_klass(field_klass->as_klass());
190 if (field->is_null_free()) {
191 type = type->join_speculative(TypePtr::NOTNULL);
192 }
193 }
194 } else {
195 type = Type::get_const_basic_type(bt);
196 }
197
198 const TypePtr* adr_type = C->alias_type(field)->adr_type();
199 DecoratorSet decorators = IN_HEAP;
200 decorators |= field->is_volatile() ? MO_SEQ_CST : MO_UNORDERED;
201 ld = access_load_at(obj, adr, adr_type, type, bt, decorators);
202 if (field_klass->is_inlinetype()) {
203 // Load a non-flattened inline type from memory
204 ld = InlineTypeNode::make_from_oop(this, ld, field_klass->as_inline_klass());
205 }
206 }
207
208 // Adjust Java stack
209 if (!field->is_static()) {
210 pop();
211 }
212 if (type2size[bt] == 1) {
213 push(ld);
214 } else {
215 push_pair(ld);
216 }
217
218 if (must_assert_null) {
219 // Do not take a trap here. It's possible that the program
220 // will never load the field's class, and will happily see
221 // null values in this field forever. Don't stumble into a
222 // trap for such a program, or we might get a long series
223 // of useless recompilations. (Or, we might load a class
224 // which should not be loaded.) If we ever see a non-null
225 // value, we will then trap and recompile. (The trap will
226 // not need to mention the class index, since the class will
227 // already have been loaded if we ever see a non-null value.)
228 // uncommon_trap(iter().get_field_signature_index());
229 if (PrintOpto && (Verbose || WizardMode)) {
230 method()->print_name(); tty->print_cr(" asserting nullness of field at bci: %d", bci());
231 }
232 if (C->log() != nullptr) {
233 C->log()->elem("assert_null reason='field' klass='%d'",
234 C->log()->identify(field_klass));
235 }
236 // If there is going to be a trap, put it at the next bytecode:
237 set_bci(iter().next_bci());
238 null_assert(peek());
239 set_bci(iter().cur_bci()); // put it back
240 }
241 }
242
243 // If the field klass is an abstract value klass (for which we do not know the layout, yet), it could have a unique
244 // concrete sub klass for which we have a fixed layout. This allows us to use InlineTypeNodes instead.
245 ciType* Parse::improve_abstract_inline_type_klass(ciType* field_klass) {
246 Dependencies* dependencies = C->dependencies();
247 if (UseUniqueSubclasses && dependencies != nullptr && field_klass->is_instance_klass()) {
248 ciInstanceKlass* instance_klass = field_klass->as_instance_klass();
249 if (instance_klass->is_loaded() && instance_klass->is_abstract_value_klass()) {
250 ciInstanceKlass* sub_klass = instance_klass->unique_concrete_subklass();
251 if (sub_klass != nullptr && sub_klass != field_klass) {
252 field_klass = sub_klass;
253 dependencies->assert_abstract_with_unique_concrete_subtype(instance_klass, sub_klass);
254 }
255 }
256 }
257 return field_klass;
258 }
259
260 void Parse::do_put_xxx(Node* obj, ciField* field, bool is_field) {
261 bool is_vol = field->is_volatile();
262 int offset = field->offset_in_bytes();
263
264 BasicType bt = field->layout_type();
265 Node* val = type2size[bt] == 1 ? pop() : pop_pair();
266 if (field->is_null_free()) {
267 PreserveReexecuteState preexecs(this);
268 jvms()->set_should_reexecute(true);
269 inc_sp(1);
270 val = null_check(val);
271 if (stopped()) {
272 return;
273 }
274 }
275
276 Node* adr = basic_plus_adr(obj, obj, offset);
277
278 // We cannot store into a non-larval object, so obj must not be an InlineTypeNode
279 assert(!obj->is_InlineType(), "InlineTypeNodes are non-larval value objects");
280 ciType* field_klass = field->type();
281 bool do_store = true;
282 if (field_klass->is_inlinetype()) { // could also have an abstract value class
283 ciInlineKlass* vk = field_klass->as_inline_klass();
284 if (field->is_null_free() && vk->is_empty() && (!method()->is_object_constructor() || field->is_flat())) {
285 // Storing to a field of an empty, null-free inline type that is already initialized. Ignore.
286 return;
287 }
288 if (field->is_flat()) {
289 // Storing to a flat inline type field.
290 if (!val->is_InlineType()) {
291 assert(gvn().type(val) == TypePtr::NULL_PTR, "Unexpected value");
292 val = InlineTypeNode::make_null(gvn(), vk);
293 }
294 inc_sp(1);
295 bool is_immutable = field->is_final() && field->is_strict();
296 bool atomic = field->is_atomic();
297 val->as_InlineType()->store_flat(this, obj, adr, atomic, is_immutable, field->is_null_free(), IN_HEAP | MO_UNORDERED);
298 dec_sp(1);
299 do_store = false;
300 }
301 }
302 if (do_store) {
303 // Store the value.
304 assert(!field->is_flat(), "cannot be flat");
305 const Type* field_type;
306 if (!field->type()->is_loaded()) {
307 field_type = TypeInstPtr::BOTTOM;
308 } else {
309 if (is_reference_type(bt)) {
310 field_type = TypeOopPtr::make_from_klass(field->type()->as_klass());
311 } else {
312 field_type = Type::BOTTOM;
313 }
314 }
315
316 const TypePtr* adr_type = C->alias_type(field)->adr_type();
317 assert(C->get_alias_index(adr_type) == C->get_alias_index(_gvn.type(adr)->isa_ptr()),
318 "slice of address and input slice don't match");
319 DecoratorSet decorators = IN_HEAP;
320 decorators |= is_vol ? MO_SEQ_CST : MO_UNORDERED;
321 inc_sp(1);
322 access_store_at(obj, adr, adr_type, val, field_type, bt, decorators);
323 dec_sp(1);
324 }
325
326 if (is_field) {
327 // Remember we wrote a volatile field.
328 // For not multiple copy atomic cpu (ppc64) a barrier should be issued
329 // in constructors which have such stores. See do_exits() in parse1.cpp.
330 if (is_vol) {
331 set_wrote_volatile(true);
332 }
333 set_wrote_fields(true);
334
335 // If the field is final, the rules of Java say we are in <init> or <clinit>.
336 // If the field is @Stable, we can be in any method, but we only care about
337 // constructors at this point.
338 //
339 // Note the presence of writes to final/@Stable non-static fields, so that we
340 // can insert a memory barrier later on to keep the writes from floating
341 // out of the constructor.
342 if (field->is_final() || field->is_stable()) {
343 if (field->is_final() && !field->is_strict()) {
344 set_wrote_non_strict_final(true);
345 }
346 if (field->is_stable()) {
347 set_wrote_stable(true);
348 }
349 if (AllocateNode::Ideal_allocation(obj) != nullptr) {
350 // Preserve allocation ptr to create precedent edge to it in membar
351 // generated on exit from constructor.
352 set_alloc_with_final_or_stable(obj);
353 }
354 }
355 }
356 }
357
358 //=============================================================================
359
360 void Parse::do_newarray() {
361 bool will_link;
362 ciKlass* klass = iter().get_klass(will_link);
363
364 // Uncommon Trap when class that array contains is not loaded
365 // we need the loaded class for the rest of graph; do not
366 // initialize the container class (see Java spec)!!!
367 assert(will_link, "newarray: typeflow responsibility");
368
369 ciArrayKlass* array_klass = ciArrayKlass::make(klass);
370
371 // Check that array_klass object is loaded
372 if (!array_klass->is_loaded()) {
373 // Generate uncommon_trap for unloaded array_class
374 uncommon_trap(Deoptimization::Reason_unloaded,
375 Deoptimization::Action_reinterpret,
376 array_klass);
377 return;
378 } else if (array_klass->element_klass() != nullptr &&
379 array_klass->element_klass()->is_inlinetype() &&
380 !array_klass->element_klass()->as_inline_klass()->is_initialized()) {
381 uncommon_trap(Deoptimization::Reason_uninitialized,
382 Deoptimization::Action_reinterpret,
383 nullptr);
384 return;
385 }
386
387 kill_dead_locals();
388
389 const TypeAryKlassPtr* array_klass_type = TypeAryKlassPtr::make(array_klass, Type::trust_interfaces);
390 array_klass_type = array_klass_type->cast_to_refined_array_klass_ptr();
391 Node* count_val = pop();
392 Node* obj = new_array(makecon(array_klass_type), count_val, 1);
393 push(obj);
394 }
395
396
397 void Parse::do_newarray(BasicType elem_type) {
398 kill_dead_locals();
399
400 Node* count_val = pop();
401 const TypeKlassPtr* array_klass = TypeKlassPtr::make(ciTypeArrayKlass::make(elem_type));
402 Node* obj = new_array(makecon(array_klass), count_val, 1);
403 // Push resultant oop onto stack
404 push(obj);
405 }
406
407 // Expand simple expressions like new int[3][5] and new Object[2][nonConLen].
408 // Also handle the degenerate 1-dimensional case of anewarray.
409 Node* Parse::expand_multianewarray(ciArrayKlass* array_klass, Node* *lengths, int ndimensions, int nargs) {
410 Node* length = lengths[0];
411 assert(length != nullptr, "");
412 const TypeAryKlassPtr* array_klass_type = TypeAryKlassPtr::make(array_klass, Type::trust_interfaces);
413 array_klass_type = array_klass_type->cast_to_refined_array_klass_ptr();
414 Node* array = new_array(makecon(array_klass_type), length, nargs);
415 if (ndimensions > 1) {
416 jint length_con = find_int_con(length, -1);
417 guarantee(length_con >= 0, "non-constant multianewarray");
418 ciArrayKlass* array_klass_1 = array_klass->as_obj_array_klass()->element_klass()->as_array_klass();
419 const TypePtr* adr_type = TypeAryPtr::OOPS;
420 const TypeOopPtr* elemtype = _gvn.type(array)->is_aryptr()->elem()->make_oopptr();
421 const intptr_t header = arrayOopDesc::base_offset_in_bytes(T_OBJECT);
422 for (jint i = 0; i < length_con; i++) {
423 Node* elem = expand_multianewarray(array_klass_1, &lengths[1], ndimensions-1, nargs);
424 intptr_t offset = header + ((intptr_t)i << LogBytesPerHeapOop);
425 Node* eaddr = basic_plus_adr(array, offset);
426 access_store_at(array, eaddr, adr_type, elem, elemtype, T_OBJECT, IN_HEAP | IS_ARRAY);
427 }
428 }
429 return array;
430 }
431
432 void Parse::do_multianewarray() {
433 int ndimensions = iter().get_dimensions();
434
435 // the m-dimensional array
436 bool will_link;
437 ciArrayKlass* array_klass = iter().get_klass(will_link)->as_array_klass();
438 assert(will_link, "multianewarray: typeflow responsibility");
439
440 // Note: Array classes are always initialized; no is_initialized check.
441
442 kill_dead_locals();
443
444 // get the lengths from the stack (first dimension is on top)
445 Node** length = NEW_RESOURCE_ARRAY(Node*, ndimensions + 1);
446 length[ndimensions] = nullptr; // terminating null for make_runtime_call
447 int j;
448 ciKlass* elem_klass = array_klass;
449 for (j = ndimensions-1; j >= 0; j--) {
450 length[j] = pop();
451 elem_klass = elem_klass->as_array_klass()->element_klass();
452 }
453 if (elem_klass != nullptr && elem_klass->is_inlinetype() && !elem_klass->as_inline_klass()->is_initialized()) {
454 inc_sp(ndimensions);
455 uncommon_trap(Deoptimization::Reason_uninitialized,
456 Deoptimization::Action_reinterpret,
457 nullptr);
458 return;
459 }
460
461 // The original expression was of this form: new T[length0][length1]...
462 // It is often the case that the lengths are small (except the last).
463 // If that happens, use the fast 1-d creator a constant number of times.
464 const int expand_limit = MIN2((int)MultiArrayExpandLimit, 100);
465 int64_t expand_count = 1; // count of allocations in the expansion
466 int64_t expand_fanout = 1; // running total fanout
467 for (j = 0; j < ndimensions-1; j++) {
468 int dim_con = find_int_con(length[j], -1);
469 // To prevent overflow, we use 64-bit values. Alternatively,
470 // we could clamp dim_con like so:
471 // dim_con = MIN2(dim_con, expand_limit);
472 expand_fanout *= dim_con;
473 expand_count += expand_fanout; // count the level-J sub-arrays
474 if (dim_con <= 0
475 || dim_con > expand_limit
476 || expand_count > expand_limit) {
477 expand_count = 0;
478 break;
479 }
480 }
481
482 // Can use multianewarray instead of [a]newarray if only one dimension,
483 // or if all non-final dimensions are small constants.
484 if (ndimensions == 1 || (1 <= expand_count && expand_count <= expand_limit)) {
485 Node* obj = nullptr;
486 // Set the original stack and the reexecute bit for the interpreter
487 // to reexecute the multianewarray bytecode if deoptimization happens.
488 // Do it unconditionally even for one dimension multianewarray.
489 // Note: the reexecute bit will be set in GraphKit::add_safepoint_edges()
490 // when AllocateArray node for newarray is created.
491 { PreserveReexecuteState preexecs(this);
492 inc_sp(ndimensions);
493 // Pass 0 as nargs since uncommon trap code does not need to restore stack.
494 obj = expand_multianewarray(array_klass, &length[0], ndimensions, 0);
495 } //original reexecute and sp are set back here
496 push(obj);
497 return;
498 }
499
500 address fun = nullptr;
501 switch (ndimensions) {
502 case 1: ShouldNotReachHere(); break;
503 case 2: fun = OptoRuntime::multianewarray2_Java(); break;
504 case 3: fun = OptoRuntime::multianewarray3_Java(); break;
505 case 4: fun = OptoRuntime::multianewarray4_Java(); break;
506 case 5: fun = OptoRuntime::multianewarray5_Java(); break;
507 };
508 Node* c = nullptr;
509
510 if (fun != nullptr) {
511 c = make_runtime_call(RC_NO_LEAF | RC_NO_IO,
512 OptoRuntime::multianewarray_Type(ndimensions),
513 fun, nullptr, TypeRawPtr::BOTTOM,
514 makecon(TypeKlassPtr::make(array_klass, Type::trust_interfaces)),
515 length[0], length[1], length[2],
516 (ndimensions > 2) ? length[3] : nullptr,
517 (ndimensions > 3) ? length[4] : nullptr);
518 } else {
519 // Create a java array for dimension sizes
520 Node* dims = nullptr;
521 { PreserveReexecuteState preexecs(this);
522 inc_sp(ndimensions);
523 Node* dims_array_klass = makecon(TypeKlassPtr::make(ciArrayKlass::make(ciType::make(T_INT))));
524 dims = new_array(dims_array_klass, intcon(ndimensions), 0);
525
526 // Fill-in it with values
527 for (j = 0; j < ndimensions; j++) {
528 Node *dims_elem = array_element_address(dims, intcon(j), T_INT);
529 store_to_memory(control(), dims_elem, length[j], T_INT, MemNode::unordered);
530 }
531 }
532
533 c = make_runtime_call(RC_NO_LEAF | RC_NO_IO,
534 OptoRuntime::multianewarrayN_Type(),
535 OptoRuntime::multianewarrayN_Java(), nullptr, TypeRawPtr::BOTTOM,
536 makecon(TypeKlassPtr::make(array_klass, Type::trust_interfaces)),
537 dims);
538 }
539 make_slow_call_ex(c, env()->Throwable_klass(), false);
540
541 Node* res = _gvn.transform(new ProjNode(c, TypeFunc::Parms));
542
543 const Type* type = TypeOopPtr::make_from_klass_raw(array_klass, Type::trust_interfaces);
544
545 // Improve the type: We know it's not null, exact, and of a given length.
546 type = type->is_ptr()->cast_to_ptr_type(TypePtr::NotNull);
547 type = type->is_aryptr()->cast_to_exactness(true);
548
549 const TypeInt* ltype = _gvn.find_int_type(length[0]);
550 if (ltype != nullptr)
551 type = type->is_aryptr()->cast_to_size(ltype);
552
553 // We cannot sharpen the nested sub-arrays, since the top level is mutable.
554
555 Node* cast = _gvn.transform( new CheckCastPPNode(control(), res, type) );
556 push(cast);
557
558 // Possible improvements:
559 // - Make a fast path for small multi-arrays. (W/ implicit init. loops.)
560 // - Issue CastII against length[*] values, to TypeInt::POS.
561 }