1 /*
2 * Copyright (c) 2001, 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 "asm/register.hpp"
26 #include "ci/ciFlatArrayKlass.hpp"
27 #include "ci/ciInlineKlass.hpp"
28 #include "ci/ciMethod.hpp"
29 #include "ci/ciObjArray.hpp"
30 #include "ci/ciUtilities.hpp"
31 #include "classfile/javaClasses.hpp"
32 #include "compiler/compileLog.hpp"
33 #include "gc/shared/barrierSet.hpp"
34 #include "gc/shared/c2/barrierSetC2.hpp"
35 #include "interpreter/interpreter.hpp"
36 #include "memory/resourceArea.hpp"
37 #include "oops/flatArrayKlass.hpp"
38 #include "opto/addnode.hpp"
39 #include "opto/callnode.hpp"
40 #include "opto/castnode.hpp"
41 #include "opto/convertnode.hpp"
42 #include "opto/graphKit.hpp"
43 #include "opto/idealKit.hpp"
44 #include "opto/inlinetypenode.hpp"
45 #include "opto/intrinsicnode.hpp"
46 #include "opto/locknode.hpp"
47 #include "opto/machnode.hpp"
48 #include "opto/memnode.hpp"
49 #include "opto/multnode.hpp"
50 #include "opto/narrowptrnode.hpp"
51 #include "opto/opaquenode.hpp"
52 #include "opto/opcodes.hpp"
53 #include "opto/parse.hpp"
54 #include "opto/reachability.hpp"
55 #include "opto/rootnode.hpp"
56 #include "opto/runtime.hpp"
57 #include "opto/subtypenode.hpp"
58 #include "opto/type.hpp"
59 #include "runtime/arguments.hpp"
60 #include "runtime/deoptimization.hpp"
61 #include "runtime/sharedRuntime.hpp"
62 #include "runtime/stubRoutines.hpp"
63 #include "utilities/bitMap.inline.hpp"
64 #include "utilities/growableArray.hpp"
65 #include "utilities/powerOfTwo.hpp"
66
67 //----------------------------GraphKit-----------------------------------------
68 // Main utility constructor.
69 GraphKit::GraphKit(JVMState* jvms, PhaseGVN* gvn)
70 : Phase(Phase::Parser),
71 _env(C->env()),
72 _gvn((gvn != nullptr) ? *gvn : *C->initial_gvn()),
73 _barrier_set(BarrierSet::barrier_set()->barrier_set_c2())
74 {
75 assert(gvn == nullptr || !gvn->is_IterGVN() || gvn->is_IterGVN()->delay_transform(), "delay transform should be enabled");
76 _exceptions = jvms->map()->next_exception();
77 if (_exceptions != nullptr) jvms->map()->set_next_exception(nullptr);
78 set_jvms(jvms);
79 #ifdef ASSERT
80 if (_gvn.is_IterGVN() != nullptr) {
81 assert(_gvn.is_IterGVN()->delay_transform(), "Transformation must be delayed if IterGVN is used");
82 // Save the initial size of _for_igvn worklist for verification (see ~GraphKit)
83 _worklist_size = _gvn.C->igvn_worklist()->size();
84 }
85 #endif
86 }
87
88 // Private constructor for parser.
89 GraphKit::GraphKit()
90 : Phase(Phase::Parser),
91 _env(C->env()),
92 _gvn(*C->initial_gvn()),
93 _barrier_set(BarrierSet::barrier_set()->barrier_set_c2())
94 {
95 _exceptions = nullptr;
96 set_map(nullptr);
97 DEBUG_ONLY(_sp = -99);
98 DEBUG_ONLY(set_bci(-99));
99 }
100
101 GraphKit::GraphKit(const SafePointNode* sft, PhaseIterGVN& igvn)
102 : Phase(Phase::Parser),
103 _env(C->env()),
104 _gvn(igvn),
105 _exceptions(nullptr),
106 _barrier_set(BarrierSet::barrier_set()->barrier_set_c2()) {
107 assert(igvn.delay_transform(), "must delay transformation during macro expansion");
108 assert(sft->next_exception() == nullptr, "must not have a pending exception");
109 JVMState* cloned_jvms = sft->jvms()->clone_deep(C);
110 SafePointNode* cloned_map = new SafePointNode(sft->req(), cloned_jvms);
111 for (uint i = 0; i < sft->req(); i++) {
112 cloned_map->init_req(i, sft->in(i));
113 }
114 igvn.record_for_igvn(cloned_map);
115 for (JVMState* current = cloned_jvms; current != nullptr; current = current->caller()) {
116 current->set_map(cloned_map);
117 }
118 set_jvms(cloned_jvms);
119 set_all_memory(cloned_map->memory());
120 }
121
122 //---------------------------clean_stack---------------------------------------
123 // Clear away rubbish from the stack area of the JVM state.
124 // This destroys any arguments that may be waiting on the stack.
125 void GraphKit::clean_stack(int from_sp) {
126 SafePointNode* map = this->map();
127 JVMState* jvms = this->jvms();
128 int stk_size = jvms->stk_size();
129 int stkoff = jvms->stkoff();
130 Node* top = this->top();
131 for (int i = from_sp; i < stk_size; i++) {
132 if (map->in(stkoff + i) != top) {
133 map->set_req(stkoff + i, top);
134 }
135 }
136 }
137
138
139 //--------------------------------sync_jvms-----------------------------------
140 // Make sure our current jvms agrees with our parse state.
141 JVMState* GraphKit::sync_jvms() const {
142 JVMState* jvms = this->jvms();
143 jvms->set_bci(bci()); // Record the new bci in the JVMState
144 jvms->set_sp(sp()); // Record the new sp in the JVMState
145 assert(jvms_in_sync(), "jvms is now in sync");
146 return jvms;
147 }
148
149 //--------------------------------sync_jvms_for_reexecute---------------------
150 // Make sure our current jvms agrees with our parse state. This version
151 // uses the reexecute_sp for reexecuting bytecodes.
152 JVMState* GraphKit::sync_jvms_for_reexecute() {
153 JVMState* jvms = this->jvms();
154 jvms->set_bci(bci()); // Record the new bci in the JVMState
155 jvms->set_sp(reexecute_sp()); // Record the new sp in the JVMState
156 return jvms;
157 }
158
159 #ifdef ASSERT
160 bool GraphKit::jvms_in_sync() const {
161 Parse* parse = is_Parse();
162 if (parse == nullptr) {
163 if (bci() != jvms()->bci()) return false;
164 if (sp() != (int)jvms()->sp()) return false;
165 return true;
166 }
167 if (jvms()->method() != parse->method()) return false;
168 if (jvms()->bci() != parse->bci()) return false;
169 int jvms_sp = jvms()->sp();
170 if (jvms_sp != parse->sp()) return false;
171 int jvms_depth = jvms()->depth();
172 if (jvms_depth != parse->depth()) return false;
173 return true;
174 }
175
176 // Local helper checks for special internal merge points
177 // used to accumulate and merge exception states.
178 // They are marked by the region's in(0) edge being the map itself.
179 // Such merge points must never "escape" into the parser at large,
180 // until they have been handed to gvn.transform.
181 static bool is_hidden_merge(Node* reg) {
182 if (reg == nullptr) return false;
183 if (reg->is_Phi()) {
184 reg = reg->in(0);
185 if (reg == nullptr) return false;
186 }
187 return reg->is_Region() && reg->in(0) != nullptr && reg->in(0)->is_Root();
188 }
189
190 void GraphKit::verify_map() const {
191 if (map() == nullptr) return; // null map is OK
192 assert(map()->req() <= jvms()->endoff(), "no extra garbage on map");
193 assert(!map()->has_exceptions(), "call add_exception_states_from 1st");
194 assert(!is_hidden_merge(control()), "call use_exception_state, not set_map");
195 }
196
197 void GraphKit::verify_exception_state(SafePointNode* ex_map) {
198 assert(ex_map->next_exception() == nullptr, "not already part of a chain");
199 assert(has_saved_ex_oop(ex_map), "every exception state has an ex_oop");
200 }
201 #endif
202
203 //---------------------------stop_and_kill_map---------------------------------
204 // Set _map to null, signalling a stop to further bytecode execution.
205 // First smash the current map's control to a constant, to mark it dead.
206 void GraphKit::stop_and_kill_map() {
207 SafePointNode* dead_map = stop();
208 if (dead_map != nullptr) {
209 dead_map->disconnect_inputs(C); // Mark the map as killed.
210 assert(dead_map->is_killed(), "must be so marked");
211 }
212 }
213
214
215 //--------------------------------stopped--------------------------------------
216 // Tell if _map is null, or control is top.
217 bool GraphKit::stopped() {
218 if (map() == nullptr) return true;
219 else if (control() == top()) return true;
220 else return false;
221 }
222
223
224 //-----------------------------has_exception_handler----------------------------------
225 // Tell if this method or any caller method has exception handlers.
226 bool GraphKit::has_exception_handler() {
227 for (JVMState* jvmsp = jvms(); jvmsp != nullptr; jvmsp = jvmsp->caller()) {
228 if (jvmsp->has_method() && jvmsp->method()->has_exception_handlers()) {
229 return true;
230 }
231 }
232 return false;
233 }
234
235 //------------------------------save_ex_oop------------------------------------
236 // Save an exception without blowing stack contents or other JVM state.
237 void GraphKit::set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop) {
238 assert(!has_saved_ex_oop(ex_map), "clear ex-oop before setting again");
239 ex_map->add_req(ex_oop);
240 DEBUG_ONLY(verify_exception_state(ex_map));
241 }
242
243 inline static Node* common_saved_ex_oop(SafePointNode* ex_map, bool clear_it) {
244 assert(GraphKit::has_saved_ex_oop(ex_map), "ex_oop must be there");
245 Node* ex_oop = ex_map->in(ex_map->req()-1);
246 if (clear_it) ex_map->del_req(ex_map->req()-1);
247 return ex_oop;
248 }
249
250 //-----------------------------saved_ex_oop------------------------------------
251 // Recover a saved exception from its map.
252 Node* GraphKit::saved_ex_oop(SafePointNode* ex_map) {
253 return common_saved_ex_oop(ex_map, false);
254 }
255
256 //--------------------------clear_saved_ex_oop---------------------------------
257 // Erase a previously saved exception from its map.
258 Node* GraphKit::clear_saved_ex_oop(SafePointNode* ex_map) {
259 return common_saved_ex_oop(ex_map, true);
260 }
261
262 #ifdef ASSERT
263 //---------------------------has_saved_ex_oop----------------------------------
264 // Erase a previously saved exception from its map.
265 bool GraphKit::has_saved_ex_oop(SafePointNode* ex_map) {
266 return ex_map->req() == ex_map->jvms()->endoff()+1;
267 }
268 #endif
269
270 //-------------------------make_exception_state--------------------------------
271 // Turn the current JVM state into an exception state, appending the ex_oop.
272 SafePointNode* GraphKit::make_exception_state(Node* ex_oop) {
273 sync_jvms();
274 SafePointNode* ex_map = stop(); // do not manipulate this map any more
275 set_saved_ex_oop(ex_map, ex_oop);
276 return ex_map;
277 }
278
279
280 //--------------------------add_exception_state--------------------------------
281 // Add an exception to my list of exceptions.
282 void GraphKit::add_exception_state(SafePointNode* ex_map) {
283 if (ex_map == nullptr || ex_map->control() == top()) {
284 return;
285 }
286 #ifdef ASSERT
287 verify_exception_state(ex_map);
288 if (has_exceptions()) {
289 assert(ex_map->jvms()->same_calls_as(_exceptions->jvms()), "all collected exceptions must come from the same place");
290 }
291 #endif
292
293 // If there is already an exception of exactly this type, merge with it.
294 // In particular, null-checks and other low-level exceptions common up here.
295 Node* ex_oop = saved_ex_oop(ex_map);
296 const Type* ex_type = _gvn.type(ex_oop);
297 if (ex_oop == top()) {
298 // No action needed.
299 return;
300 }
301 assert(ex_type->isa_instptr(), "exception must be an instance");
302 for (SafePointNode* e2 = _exceptions; e2 != nullptr; e2 = e2->next_exception()) {
303 const Type* ex_type2 = _gvn.type(saved_ex_oop(e2));
304 // We check sp also because call bytecodes can generate exceptions
305 // both before and after arguments are popped!
306 if (ex_type2 == ex_type
307 && e2->_jvms->sp() == ex_map->_jvms->sp()) {
308 combine_exception_states(ex_map, e2);
309 return;
310 }
311 }
312
313 // No pre-existing exception of the same type. Chain it on the list.
314 push_exception_state(ex_map);
315 }
316
317 //-----------------------add_exception_states_from-----------------------------
318 void GraphKit::add_exception_states_from(JVMState* jvms) {
319 SafePointNode* ex_map = jvms->map()->next_exception();
320 if (ex_map != nullptr) {
321 jvms->map()->set_next_exception(nullptr);
322 for (SafePointNode* next_map; ex_map != nullptr; ex_map = next_map) {
323 next_map = ex_map->next_exception();
324 ex_map->set_next_exception(nullptr);
325 add_exception_state(ex_map);
326 }
327 }
328 }
329
330 //-----------------------transfer_exceptions_into_jvms-------------------------
331 JVMState* GraphKit::transfer_exceptions_into_jvms() {
332 if (map() == nullptr) {
333 // We need a JVMS to carry the exceptions, but the map has gone away.
334 // Create a scratch JVMS, cloned from any of the exception states...
335 if (has_exceptions()) {
336 _map = _exceptions;
337 _map = clone_map();
338 _map->set_next_exception(nullptr);
339 clear_saved_ex_oop(_map);
340 DEBUG_ONLY(verify_map());
341 } else {
342 // ...or created from scratch
343 JVMState* jvms = new (C) JVMState(_method, nullptr);
344 jvms->set_bci(_bci);
345 jvms->set_sp(_sp);
346 jvms->set_map(new SafePointNode(TypeFunc::Parms, jvms));
347 set_jvms(jvms);
348 for (uint i = 0; i < map()->req(); i++) map()->init_req(i, top());
349 set_all_memory(top());
350 while (map()->req() < jvms->endoff()) map()->add_req(top());
351 }
352 // (This is a kludge, in case you didn't notice.)
353 set_control(top());
354 }
355 JVMState* jvms = sync_jvms();
356 assert(!jvms->map()->has_exceptions(), "no exceptions on this map yet");
357 jvms->map()->set_next_exception(_exceptions);
358 _exceptions = nullptr; // done with this set of exceptions
359 return jvms;
360 }
361
362 static inline void add_n_reqs(Node* dstphi, Node* srcphi) {
363 assert(is_hidden_merge(dstphi), "must be a special merge node");
364 assert(is_hidden_merge(srcphi), "must be a special merge node");
365 uint limit = srcphi->req();
366 for (uint i = PhiNode::Input; i < limit; i++) {
367 dstphi->add_req(srcphi->in(i));
368 }
369 }
370 static inline void add_one_req(Node* dstphi, Node* src) {
371 assert(is_hidden_merge(dstphi), "must be a special merge node");
372 assert(!is_hidden_merge(src), "must not be a special merge node");
373 dstphi->add_req(src);
374 }
375
376 //-----------------------combine_exception_states------------------------------
377 // This helper function combines exception states by building phis on a
378 // specially marked state-merging region. These regions and phis are
379 // untransformed, and can build up gradually. The region is marked by
380 // having a control input of its exception map, rather than null. Such
381 // regions do not appear except in this function, and in use_exception_state.
382 void GraphKit::combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map) {
383 if (failing_internal()) {
384 return; // dying anyway...
385 }
386 JVMState* ex_jvms = ex_map->_jvms;
387 assert(ex_jvms->same_calls_as(phi_map->_jvms), "consistent call chains");
388 assert(ex_jvms->stkoff() == phi_map->_jvms->stkoff(), "matching locals");
389 assert(ex_jvms->sp() == phi_map->_jvms->sp(), "matching stack sizes");
390 assert(ex_jvms->monoff() == phi_map->_jvms->monoff(), "matching JVMS");
391 assert(ex_jvms->scloff() == phi_map->_jvms->scloff(), "matching scalar replaced objects");
392 assert(ex_map->req() == phi_map->req(), "matching maps");
393 uint tos = ex_jvms->stkoff() + ex_jvms->sp();
394 Node* hidden_merge_mark = root();
395 Node* region = phi_map->control();
396 MergeMemNode* phi_mem = phi_map->merged_memory();
397 MergeMemNode* ex_mem = ex_map->merged_memory();
398 if (region->in(0) != hidden_merge_mark) {
399 // The control input is not (yet) a specially-marked region in phi_map.
400 // Make it so, and build some phis.
401 region = new RegionNode(2);
402 _gvn.set_type(region, Type::CONTROL);
403 region->set_req(0, hidden_merge_mark); // marks an internal ex-state
404 region->init_req(1, phi_map->control());
405 phi_map->set_control(region);
406 Node* io_phi = PhiNode::make(region, phi_map->i_o(), Type::ABIO);
407 record_for_igvn(io_phi);
408 _gvn.set_type(io_phi, Type::ABIO);
409 phi_map->set_i_o(io_phi);
410 for (MergeMemStream mms(phi_mem); mms.next_non_empty(); ) {
411 Node* m = mms.memory();
412 Node* m_phi = PhiNode::make(region, m, Type::MEMORY, mms.adr_type(C));
413 record_for_igvn(m_phi);
414 _gvn.set_type(m_phi, Type::MEMORY);
415 mms.set_memory(m_phi);
416 }
417 }
418
419 // Either or both of phi_map and ex_map might already be converted into phis.
420 Node* ex_control = ex_map->control();
421 // if there is special marking on ex_map also, we add multiple edges from src
422 bool add_multiple = (ex_control->in(0) == hidden_merge_mark);
423 // how wide was the destination phi_map, originally?
424 uint orig_width = region->req();
425
426 if (add_multiple) {
427 add_n_reqs(region, ex_control);
428 add_n_reqs(phi_map->i_o(), ex_map->i_o());
429 } else {
430 // ex_map has no merges, so we just add single edges everywhere
431 add_one_req(region, ex_control);
432 add_one_req(phi_map->i_o(), ex_map->i_o());
433 }
434 for (MergeMemStream mms(phi_mem, ex_mem); mms.next_non_empty2(); ) {
435 if (mms.is_empty()) {
436 // get a copy of the base memory, and patch some inputs into it
437 const TypePtr* adr_type = mms.adr_type(C);
438 Node* phi = mms.force_memory()->as_Phi()->slice_memory(adr_type);
439 assert(phi->as_Phi()->region() == mms.base_memory()->in(0), "");
440 mms.set_memory(phi);
441 // Prepare to append interesting stuff onto the newly sliced phi:
442 while (phi->req() > orig_width) phi->del_req(phi->req()-1);
443 }
444 // Append stuff from ex_map:
445 if (add_multiple) {
446 add_n_reqs(mms.memory(), mms.memory2());
447 } else {
448 add_one_req(mms.memory(), mms.memory2());
449 }
450 }
451 uint limit = ex_map->req();
452 for (uint i = TypeFunc::Parms; i < limit; i++) {
453 // Skip everything in the JVMS after tos. (The ex_oop follows.)
454 if (i == tos) i = ex_jvms->monoff();
455 Node* src = ex_map->in(i);
456 Node* dst = phi_map->in(i);
457 if (src != dst) {
458 PhiNode* phi;
459 if (dst->in(0) != region) {
460 dst = phi = PhiNode::make(region, dst, _gvn.type(dst));
461 record_for_igvn(phi);
462 _gvn.set_type(phi, phi->type());
463 phi_map->set_req(i, dst);
464 // Prepare to append interesting stuff onto the new phi:
465 while (dst->req() > orig_width) dst->del_req(dst->req()-1);
466 } else {
467 assert(dst->is_Phi(), "nobody else uses a hidden region");
468 phi = dst->as_Phi();
469 }
470 if (add_multiple && src->in(0) == ex_control) {
471 // Both are phis.
472 add_n_reqs(dst, src);
473 } else {
474 while (dst->req() < region->req()) add_one_req(dst, src);
475 }
476 const Type* srctype = _gvn.type(src);
477 if (phi->type() != srctype) {
478 const Type* dsttype = phi->type()->meet_speculative(srctype);
479 if (phi->type() != dsttype) {
480 phi->set_type(dsttype);
481 _gvn.set_type(phi, dsttype);
482 }
483 }
484 }
485 }
486 phi_map->merge_replaced_nodes_with(ex_map);
487 }
488
489 //--------------------------use_exception_state--------------------------------
490 Node* GraphKit::use_exception_state(SafePointNode* phi_map) {
491 if (failing_internal()) { stop(); return top(); }
492 Node* region = phi_map->control();
493 Node* hidden_merge_mark = root();
494 assert(phi_map->jvms()->map() == phi_map, "sanity: 1-1 relation");
495 Node* ex_oop = clear_saved_ex_oop(phi_map);
496 if (region->in(0) == hidden_merge_mark) {
497 // Special marking for internal ex-states. Process the phis now.
498 region->set_req(0, region); // now it's an ordinary region
499 set_jvms(phi_map->jvms()); // ...so now we can use it as a map
500 // Note: Setting the jvms also sets the bci and sp.
501 set_control(_gvn.transform(region));
502 uint tos = jvms()->stkoff() + sp();
503 for (uint i = 1; i < tos; i++) {
504 Node* x = phi_map->in(i);
505 if (x->in(0) == region) {
506 assert(x->is_Phi(), "expected a special phi");
507 phi_map->set_req(i, _gvn.transform(x));
508 }
509 }
510 for (MergeMemStream mms(merged_memory()); mms.next_non_empty(); ) {
511 Node* x = mms.memory();
512 if (x->in(0) == region) {
513 assert(x->is_Phi(), "nobody else uses a hidden region");
514 mms.set_memory(_gvn.transform(x));
515 }
516 }
517 if (ex_oop->in(0) == region) {
518 assert(ex_oop->is_Phi(), "expected a special phi");
519 ex_oop = _gvn.transform(ex_oop);
520 }
521 } else {
522 set_jvms(phi_map->jvms());
523 }
524
525 assert(!is_hidden_merge(phi_map->control()), "hidden ex. states cleared");
526 assert(!is_hidden_merge(phi_map->i_o()), "hidden ex. states cleared");
527 return ex_oop;
528 }
529
530 //---------------------------------java_bc-------------------------------------
531 Bytecodes::Code GraphKit::java_bc() const {
532 ciMethod* method = this->method();
533 int bci = this->bci();
534 if (method != nullptr && bci != InvocationEntryBci)
535 return method->java_code_at_bci(bci);
536 else
537 return Bytecodes::_illegal;
538 }
539
540 void GraphKit::uncommon_trap_if_should_post_on_exceptions(Deoptimization::DeoptReason reason,
541 bool must_throw) {
542 // if the exception capability is set, then we will generate code
543 // to check the JavaThread.should_post_on_exceptions flag to see
544 // if we actually need to report exception events (for this
545 // thread). If we don't need to report exception events, we will
546 // take the normal fast path provided by add_exception_events. If
547 // exception event reporting is enabled for this thread, we will
548 // take the uncommon_trap in the BuildCutout below.
549
550 // first must access the should_post_on_exceptions_flag in this thread's JavaThread
551 Node* jthread = _gvn.transform(new ThreadLocalNode());
552 Node* adr = off_heap_plus_addr(jthread, in_bytes(JavaThread::should_post_on_exceptions_flag_offset()));
553 Node* should_post_flag = make_load(control(), adr, TypeInt::INT, T_INT, MemNode::unordered);
554
555 // Test the should_post_on_exceptions_flag vs. 0
556 Node* chk = _gvn.transform( new CmpINode(should_post_flag, intcon(0)) );
557 Node* tst = _gvn.transform( new BoolNode(chk, BoolTest::eq) );
558
559 // Branch to slow_path if should_post_on_exceptions_flag was true
560 { BuildCutout unless(this, tst, PROB_MAX);
561 // Do not try anything fancy if we're notifying the VM on every throw.
562 // Cf. case Bytecodes::_athrow in parse2.cpp.
563 uncommon_trap(reason, Deoptimization::Action_none,
564 (ciKlass*)nullptr, (char*)nullptr, must_throw);
565 }
566
567 }
568
569 //------------------------------builtin_throw----------------------------------
570 void GraphKit::builtin_throw(Deoptimization::DeoptReason reason) {
571 builtin_throw(reason, builtin_throw_exception(reason), /*allow_too_many_traps*/ true);
572 }
573
574 void GraphKit::builtin_throw(Deoptimization::DeoptReason reason,
575 ciInstance* ex_obj,
576 bool allow_too_many_traps) {
577 // If this throw happens frequently, an uncommon trap might cause
578 // a performance pothole. If there is a local exception handler,
579 // and if this particular bytecode appears to be deoptimizing often,
580 // let us handle the throw inline, with a preconstructed instance.
581 // Note: If the deopt count has blown up, the uncommon trap
582 // runtime is going to flush this nmethod, not matter what.
583 if (is_builtin_throw_hot(reason)) {
584 if (method()->can_omit_stack_trace() && ex_obj != nullptr) {
585 // If the throw is local, we use a pre-existing instance and
586 // punt on the backtrace. This would lead to a missing backtrace
587 // (a repeat of 4292742) if the backtrace object is ever asked
588 // for its backtrace.
589 // Fixing this remaining case of 4292742 requires some flavor of
590 // escape analysis. Leave that for the future.
591 if (env()->jvmti_can_post_on_exceptions()) {
592 // check if we must post exception events, take uncommon trap if so
593 uncommon_trap_if_should_post_on_exceptions(reason, true /*must_throw*/);
594 // here if should_post_on_exceptions is false
595 // continue on with the normal codegen
596 }
597
598 // Cheat with a preallocated exception object.
599 if (C->log() != nullptr)
600 C->log()->elem("hot_throw preallocated='1' reason='%s'",
601 Deoptimization::trap_reason_name(reason));
602 const TypeInstPtr* ex_con = TypeInstPtr::make(ex_obj);
603 Node* ex_node = _gvn.transform(ConNode::make(ex_con));
604
605 // Clear the detail message of the preallocated exception object.
606 // Weblogic sometimes mutates the detail message of exceptions
607 // using reflection.
608 int offset = java_lang_Throwable::get_detailMessage_offset();
609 const TypePtr* adr_typ = ex_con->add_offset(offset);
610
611 Node *adr = basic_plus_adr(ex_node, ex_node, offset);
612 const TypeOopPtr* val_type = TypeOopPtr::make_from_klass(env()->String_klass());
613 Node *store = access_store_at(ex_node, adr, adr_typ, null(), val_type, T_OBJECT, IN_HEAP);
614
615 if (!method()->has_exception_handlers()) {
616 // We don't need to preserve the stack if there's no handler as the entire frame is going to be popped anyway.
617 // This prevents issues with exception handling and late inlining.
618 set_sp(0);
619 clean_stack(0);
620 }
621
622 add_exception_state(make_exception_state(ex_node));
623 return;
624 } else if (builtin_throw_too_many_traps(reason, ex_obj)) {
625 // We cannot afford to take too many traps here. Suffer in the interpreter instead.
626 assert(allow_too_many_traps, "not allowed");
627 if (C->log() != nullptr) {
628 C->log()->elem("hot_throw preallocated='0' reason='%s' mcount='%d'",
629 Deoptimization::trap_reason_name(reason),
630 C->trap_count(reason));
631 }
632 uncommon_trap(reason, Deoptimization::Action_none,
633 (ciKlass*) nullptr, (char*) nullptr,
634 true /*must_throw*/);
635 return;
636 }
637 }
638
639 // %%% Maybe add entry to OptoRuntime which directly throws the exc.?
640 // It won't be much cheaper than bailing to the interp., since we'll
641 // have to pass up all the debug-info, and the runtime will have to
642 // create the stack trace.
643
644 // Usual case: Bail to interpreter.
645 // Reserve the right to recompile if we haven't seen anything yet.
646
647 // "must_throw" prunes the JVM state to include only the stack, if there
648 // are no local exception handlers. This should cut down on register
649 // allocation time and code size, by drastically reducing the number
650 // of in-edges on the call to the uncommon trap.
651 uncommon_trap(reason, Deoptimization::Action_maybe_recompile,
652 (ciKlass*) nullptr, (char*) nullptr,
653 true /*must_throw*/);
654 }
655
656 bool GraphKit::is_builtin_throw_hot(Deoptimization::DeoptReason reason) {
657 // If this particular condition has not yet happened at this
658 // bytecode, then use the uncommon trap mechanism, and allow for
659 // a future recompilation if several traps occur here.
660 // If the throw is hot, try to use a more complicated inline mechanism
661 // which keeps execution inside the compiled code.
662 if (ProfileTraps) {
663 if (too_many_traps(reason)) {
664 return true;
665 }
666 // (If there is no MDO at all, assume it is early in
667 // execution, and that any deopts are part of the
668 // startup transient, and don't need to be remembered.)
669
670 // Also, if there is a local exception handler, treat all throws
671 // as hot if there has been at least one in this method.
672 if (C->trap_count(reason) != 0 &&
673 method()->method_data()->trap_count(reason) != 0 &&
674 has_exception_handler()) {
675 return true;
676 }
677 }
678 return false;
679 }
680
681 bool GraphKit::builtin_throw_too_many_traps(Deoptimization::DeoptReason reason,
682 ciInstance* ex_obj) {
683 if (is_builtin_throw_hot(reason)) {
684 if (method()->can_omit_stack_trace() && ex_obj != nullptr) {
685 return false; // no traps; throws preallocated exception instead
686 }
687 ciMethod* m = Deoptimization::reason_is_speculate(reason) ? C->method() : nullptr;
688 if (method()->method_data()->trap_recompiled_at(bci(), m) ||
689 C->too_many_traps(reason)) {
690 return true;
691 }
692 }
693 return false;
694 }
695
696 ciInstance* GraphKit::builtin_throw_exception(Deoptimization::DeoptReason reason) const {
697 // Preallocated exception objects to use when we don't need the backtrace.
698 switch (reason) {
699 case Deoptimization::Reason_null_check:
700 return env()->NullPointerException_instance();
701 case Deoptimization::Reason_div0_check:
702 return env()->ArithmeticException_instance();
703 case Deoptimization::Reason_range_check:
704 return env()->ArrayIndexOutOfBoundsException_instance();
705 case Deoptimization::Reason_class_check:
706 return env()->ClassCastException_instance();
707 case Deoptimization::Reason_array_check:
708 return env()->ArrayStoreException_instance();
709 default:
710 return nullptr;
711 }
712 }
713
714 GraphKit::SavedState::SavedState(GraphKit* kit) :
715 _kit(kit),
716 _sp(kit->sp()),
717 _jvms(kit->jvms()),
718 _map(kit->clone_map()),
719 _discarded(false)
720 {
721 for (DUIterator_Fast imax, i = kit->control()->fast_outs(imax); i < imax; i++) {
722 Node* out = kit->control()->fast_out(i);
723 if (out->is_CFG()) {
724 _ctrl_succ.push(out);
725 }
726 }
727 }
728
729 GraphKit::SavedState::~SavedState() {
730 if (_discarded) {
731 _kit->destruct_map_clone(_map);
732 return;
733 }
734 _kit->jvms()->set_map(_map);
735 _kit->jvms()->set_sp(_sp);
736 _map->set_jvms(_kit->jvms());
737 _kit->set_map(_map);
738 _kit->set_sp(_sp);
739 for (DUIterator_Fast imax, i = _kit->control()->fast_outs(imax); i < imax; i++) {
740 Node* out = _kit->control()->fast_out(i);
741 if (out->is_CFG() && out->in(0) == _kit->control() && out != _kit->map() && !_ctrl_succ.member(out)) {
742 _kit->_gvn.hash_delete(out);
743 out->set_req(0, _kit->C->top());
744 _kit->C->record_for_igvn(out);
745 --i; --imax;
746 _kit->_gvn.hash_find_insert(out);
747 }
748 }
749 }
750
751 void GraphKit::SavedState::discard() {
752 _discarded = true;
753 }
754
755
756 //----------------------------PreserveJVMState---------------------------------
757 PreserveJVMState::PreserveJVMState(GraphKit* kit, bool clone_map) {
758 DEBUG_ONLY(kit->verify_map());
759 _kit = kit;
760 _map = kit->map(); // preserve the map
761 _sp = kit->sp();
762 kit->set_map(clone_map ? kit->clone_map() : nullptr);
763 #ifdef ASSERT
764 _bci = kit->bci();
765 Parse* parser = kit->is_Parse();
766 int block = (parser == nullptr || parser->block() == nullptr) ? -1 : parser->block()->rpo();
767 _block = block;
768 #endif
769 }
770 PreserveJVMState::~PreserveJVMState() {
771 GraphKit* kit = _kit;
772 #ifdef ASSERT
773 assert(kit->bci() == _bci, "bci must not shift");
774 Parse* parser = kit->is_Parse();
775 int block = (parser == nullptr || parser->block() == nullptr) ? -1 : parser->block()->rpo();
776 assert(block == _block, "block must not shift");
777 #endif
778 kit->set_map(_map);
779 kit->set_sp(_sp);
780 }
781
782
783 //-----------------------------BuildCutout-------------------------------------
784 BuildCutout::BuildCutout(GraphKit* kit, Node* p, float prob, float cnt)
785 : PreserveJVMState(kit)
786 {
787 assert(p->is_Con() || p->is_Bool(), "test must be a bool");
788 SafePointNode* outer_map = _map; // preserved map is caller's
789 SafePointNode* inner_map = kit->map();
790 IfNode* iff = kit->create_and_map_if(outer_map->control(), p, prob, cnt);
791 outer_map->set_control(kit->gvn().transform( new IfTrueNode(iff) ));
792 inner_map->set_control(kit->gvn().transform( new IfFalseNode(iff) ));
793 }
794 BuildCutout::~BuildCutout() {
795 GraphKit* kit = _kit;
796 assert(kit->stopped(), "cutout code must stop, throw, return, etc.");
797 }
798
799 //---------------------------PreserveReexecuteState----------------------------
800 PreserveReexecuteState::PreserveReexecuteState(GraphKit* kit) {
801 assert(!kit->stopped(), "must call stopped() before");
802 _kit = kit;
803 _sp = kit->sp();
804 _reexecute = kit->jvms()->_reexecute;
805 }
806 PreserveReexecuteState::~PreserveReexecuteState() {
807 if (_kit->stopped()) return;
808 _kit->jvms()->_reexecute = _reexecute;
809 _kit->set_sp(_sp);
810 }
811
812 //------------------------------clone_map--------------------------------------
813 // Implementation of PreserveJVMState
814 //
815 // Only clone_map(...) here. If this function is only used in the
816 // PreserveJVMState class we may want to get rid of this extra
817 // function eventually and do it all there.
818
819 SafePointNode* GraphKit::clone_map() {
820 if (map() == nullptr) return nullptr;
821
822 // Clone the memory edge first
823 Node* mem = MergeMemNode::make(map()->memory());
824 gvn().set_type_bottom(mem);
825
826 SafePointNode *clonemap = (SafePointNode*)map()->clone();
827 JVMState* jvms = this->jvms();
828 JVMState* clonejvms = jvms->clone_shallow(C);
829 clonemap->set_memory(mem);
830 clonemap->set_jvms(clonejvms);
831 clonejvms->set_map(clonemap);
832 record_for_igvn(clonemap);
833 gvn().set_type_bottom(clonemap);
834 return clonemap;
835 }
836
837 //-----------------------------destruct_map_clone------------------------------
838 //
839 // Order of destruct is important to increase the likelyhood that memory can be re-used. We need
840 // to destruct/free/delete in the exact opposite order as clone_map().
841 void GraphKit::destruct_map_clone(SafePointNode* sfp) {
842 if (sfp == nullptr) return;
843
844 Node* mem = sfp->memory();
845 JVMState* jvms = sfp->jvms();
846
847 if (jvms != nullptr) {
848 delete jvms;
849 }
850
851 remove_for_igvn(sfp);
852 gvn().clear_type(sfp);
853 sfp->destruct(&_gvn);
854
855 if (mem != nullptr) {
856 gvn().clear_type(mem);
857 mem->destruct(&_gvn);
858 }
859 }
860
861 //-----------------------------set_map_clone-----------------------------------
862 void GraphKit::set_map_clone(SafePointNode* m) {
863 _map = m;
864 _map = clone_map();
865 _map->set_next_exception(nullptr);
866 DEBUG_ONLY(verify_map());
867 }
868
869
870 //----------------------------kill_dead_locals---------------------------------
871 // Detect any locals which are known to be dead, and force them to top.
872 void GraphKit::kill_dead_locals() {
873 // Consult the liveness information for the locals. If any
874 // of them are unused, then they can be replaced by top(). This
875 // should help register allocation time and cut down on the size
876 // of the deoptimization information.
877
878 // This call is made from many of the bytecode handling
879 // subroutines called from the Big Switch in do_one_bytecode.
880 // Every bytecode which might include a slow path is responsible
881 // for killing its dead locals. The more consistent we
882 // are about killing deads, the fewer useless phis will be
883 // constructed for them at various merge points.
884
885 // bci can be -1 (InvocationEntryBci). We return the entry
886 // liveness for the method.
887
888 if (method() == nullptr || method()->code_size() == 0) {
889 // We are building a graph for a call to a native method.
890 // All locals are live.
891 return;
892 }
893
894 ResourceMark rm;
895
896 // Consult the liveness information for the locals. If any
897 // of them are unused, then they can be replaced by top(). This
898 // should help register allocation time and cut down on the size
899 // of the deoptimization information.
900 MethodLivenessResult live_locals = method()->liveness_at_bci(bci());
901
902 int len = (int)live_locals.size();
903 assert(len <= jvms()->loc_size(), "too many live locals");
904 for (int local = 0; local < len; local++) {
905 if (!live_locals.at(local)) {
906 set_local(local, top());
907 }
908 }
909 }
910
911 #ifdef ASSERT
912 //-------------------------dead_locals_are_killed------------------------------
913 // Return true if all dead locals are set to top in the map.
914 // Used to assert "clean" debug info at various points.
915 bool GraphKit::dead_locals_are_killed() {
916 if (method() == nullptr || method()->code_size() == 0) {
917 // No locals need to be dead, so all is as it should be.
918 return true;
919 }
920
921 // Make sure somebody called kill_dead_locals upstream.
922 ResourceMark rm;
923 for (JVMState* jvms = this->jvms(); jvms != nullptr; jvms = jvms->caller()) {
924 if (jvms->loc_size() == 0) continue; // no locals to consult
925 SafePointNode* map = jvms->map();
926 ciMethod* method = jvms->method();
927 int bci = jvms->bci();
928 if (jvms == this->jvms()) {
929 bci = this->bci(); // it might not yet be synched
930 }
931 MethodLivenessResult live_locals = method->liveness_at_bci(bci);
932 int len = (int)live_locals.size();
933 if (!live_locals.is_valid() || len == 0)
934 // This method is trivial, or is poisoned by a breakpoint.
935 return true;
936 assert(len == jvms->loc_size(), "live map consistent with locals map");
937 for (int local = 0; local < len; local++) {
938 if (!live_locals.at(local) && map->local(jvms, local) != top()) {
939 if (PrintMiscellaneous && (Verbose || WizardMode)) {
940 tty->print_cr("Zombie local %d: ", local);
941 jvms->dump();
942 }
943 return false;
944 }
945 }
946 }
947 return true;
948 }
949
950 #endif //ASSERT
951
952 // Helper function for enforcing certain bytecodes to reexecute if deoptimization happens.
953 static bool should_reexecute_implied_by_bytecode(JVMState *jvms, bool is_anewarray) {
954 ciMethod* cur_method = jvms->method();
955 int cur_bci = jvms->bci();
956 if (cur_method != nullptr && cur_bci != InvocationEntryBci) {
957 Bytecodes::Code code = cur_method->java_code_at_bci(cur_bci);
958 return Interpreter::bytecode_should_reexecute(code) ||
959 (is_anewarray && (code == Bytecodes::_multianewarray));
960 // Reexecute _multianewarray bytecode which was replaced with
961 // sequence of [a]newarray. See Parse::do_multianewarray().
962 //
963 // Note: interpreter should not have it set since this optimization
964 // is limited by dimensions and guarded by flag so in some cases
965 // multianewarray() runtime calls will be generated and
966 // the bytecode should not be reexecutes (stack will not be reset).
967 } else {
968 return false;
969 }
970 }
971
972 // Helper function for adding JVMState and debug information to node
973 void GraphKit::add_safepoint_edges(SafePointNode* call, bool must_throw) {
974 // Add the safepoint edges to the call (or other safepoint).
975
976 // Make sure dead locals are set to top. This
977 // should help register allocation time and cut down on the size
978 // of the deoptimization information.
979 assert(dead_locals_are_killed(), "garbage in debug info before safepoint");
980
981 // Walk the inline list to fill in the correct set of JVMState's
982 // Also fill in the associated edges for each JVMState.
983
984 // If the bytecode needs to be reexecuted we need to put
985 // the arguments back on the stack.
986 const bool should_reexecute = jvms()->should_reexecute();
987 JVMState* youngest_jvms = should_reexecute ? sync_jvms_for_reexecute() : sync_jvms();
988
989 // NOTE: set_bci (called from sync_jvms) might reset the reexecute bit to
990 // undefined if the bci is different. This is normal for Parse but it
991 // should not happen for LibraryCallKit because only one bci is processed.
992 assert(!is_LibraryCallKit() || (jvms()->should_reexecute() == should_reexecute),
993 "in LibraryCallKit the reexecute bit should not change");
994
995 // If we are guaranteed to throw, we can prune everything but the
996 // input to the current bytecode.
997 bool can_prune_locals = false;
998 uint stack_slots_not_pruned = 0;
999 int inputs = 0, depth = 0;
1000 if (must_throw) {
1001 assert(method() == youngest_jvms->method(), "sanity");
1002 if (compute_stack_effects(inputs, depth)) {
1003 can_prune_locals = true;
1004 stack_slots_not_pruned = inputs;
1005 }
1006 }
1007
1008 if (env()->should_retain_local_variables()) {
1009 // At any safepoint, this method can get breakpointed, which would
1010 // then require an immediate deoptimization.
1011 can_prune_locals = false; // do not prune locals
1012 stack_slots_not_pruned = 0;
1013 }
1014
1015 // do not scribble on the input jvms
1016 JVMState* out_jvms = youngest_jvms->clone_deep(C);
1017 call->set_jvms(out_jvms); // Start jvms list for call node
1018
1019 // For a known set of bytecodes, the interpreter should reexecute them if
1020 // deoptimization happens. We set the reexecute state for them here
1021 if (out_jvms->is_reexecute_undefined() && //don't change if already specified
1022 should_reexecute_implied_by_bytecode(out_jvms, call->is_AllocateArray())) {
1023 #ifdef ASSERT
1024 int inputs = 0, not_used; // initialized by GraphKit::compute_stack_effects()
1025 assert(method() == youngest_jvms->method(), "sanity");
1026 assert(compute_stack_effects(inputs, not_used), "unknown bytecode: %s", Bytecodes::name(java_bc()));
1027 assert(out_jvms->sp() >= (uint)inputs, "not enough operands for reexecution");
1028 #endif // ASSERT
1029 out_jvms->set_should_reexecute(true); //NOTE: youngest_jvms not changed
1030 }
1031
1032 // Presize the call:
1033 DEBUG_ONLY(uint non_debug_edges = call->req());
1034 call->add_req_batch(top(), youngest_jvms->debug_depth());
1035 assert(call->req() == non_debug_edges + youngest_jvms->debug_depth(), "");
1036
1037 // Set up edges so that the call looks like this:
1038 // Call [state:] ctl io mem fptr retadr
1039 // [parms:] parm0 ... parmN
1040 // [root:] loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN
1041 // [...mid:] loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN [...]
1042 // [young:] loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN
1043 // Note that caller debug info precedes callee debug info.
1044
1045 // Fill pointer walks backwards from "young:" to "root:" in the diagram above:
1046 uint debug_ptr = call->req();
1047
1048 // Loop over the map input edges associated with jvms, add them
1049 // to the call node, & reset all offsets to match call node array.
1050 for (JVMState* in_jvms = youngest_jvms; in_jvms != nullptr; ) {
1051 uint debug_end = debug_ptr;
1052 uint debug_start = debug_ptr - in_jvms->debug_size();
1053 debug_ptr = debug_start; // back up the ptr
1054
1055 uint p = debug_start; // walks forward in [debug_start, debug_end)
1056 uint j, k, l;
1057 SafePointNode* in_map = in_jvms->map();
1058 out_jvms->set_map(call);
1059
1060 if (can_prune_locals) {
1061 assert(in_jvms->method() == out_jvms->method(), "sanity");
1062 // If the current throw can reach an exception handler in this JVMS,
1063 // then we must keep everything live that can reach that handler.
1064 // As a quick and dirty approximation, we look for any handlers at all.
1065 if (in_jvms->method()->has_exception_handlers()) {
1066 can_prune_locals = false;
1067 }
1068 }
1069
1070 // Add the Locals
1071 k = in_jvms->locoff();
1072 l = in_jvms->loc_size();
1073 out_jvms->set_locoff(p);
1074 if (!can_prune_locals) {
1075 for (j = 0; j < l; j++) {
1076 call->set_req(p++, in_map->in(k + j));
1077 }
1078 } else {
1079 p += l; // already set to top above by add_req_batch
1080 }
1081
1082 // Add the Expression Stack
1083 k = in_jvms->stkoff();
1084 l = in_jvms->sp();
1085 out_jvms->set_stkoff(p);
1086 if (!can_prune_locals) {
1087 for (j = 0; j < l; j++) {
1088 call->set_req(p++, in_map->in(k + j));
1089 }
1090 } else if (can_prune_locals && stack_slots_not_pruned != 0) {
1091 // Divide stack into {S0,...,S1}, where S0 is set to top.
1092 uint s1 = stack_slots_not_pruned;
1093 stack_slots_not_pruned = 0; // for next iteration
1094 if (s1 > l) s1 = l;
1095 uint s0 = l - s1;
1096 p += s0; // skip the tops preinstalled by add_req_batch
1097 for (j = s0; j < l; j++)
1098 call->set_req(p++, in_map->in(k+j));
1099 } else {
1100 p += l; // already set to top above by add_req_batch
1101 }
1102
1103 // Add the Monitors
1104 k = in_jvms->monoff();
1105 l = in_jvms->mon_size();
1106 out_jvms->set_monoff(p);
1107 for (j = 0; j < l; j++)
1108 call->set_req(p++, in_map->in(k+j));
1109
1110 // Copy any scalar object fields.
1111 k = in_jvms->scloff();
1112 l = in_jvms->scl_size();
1113 out_jvms->set_scloff(p);
1114 for (j = 0; j < l; j++)
1115 call->set_req(p++, in_map->in(k+j));
1116
1117 // Finish the new jvms.
1118 out_jvms->set_endoff(p);
1119
1120 assert(out_jvms->endoff() == debug_end, "fill ptr must match");
1121 assert(out_jvms->depth() == in_jvms->depth(), "depth must match");
1122 assert(out_jvms->loc_size() == in_jvms->loc_size(), "size must match");
1123 assert(out_jvms->mon_size() == in_jvms->mon_size(), "size must match");
1124 assert(out_jvms->scl_size() == in_jvms->scl_size(), "size must match");
1125 assert(out_jvms->debug_size() == in_jvms->debug_size(), "size must match");
1126
1127 // Update the two tail pointers in parallel.
1128 out_jvms = out_jvms->caller();
1129 in_jvms = in_jvms->caller();
1130 }
1131
1132 assert(debug_ptr == non_debug_edges, "debug info must fit exactly");
1133
1134 // Test the correctness of JVMState::debug_xxx accessors:
1135 assert(call->jvms()->debug_start() == non_debug_edges, "");
1136 assert(call->jvms()->debug_end() == call->req(), "");
1137 assert(call->jvms()->debug_depth() == call->req() - non_debug_edges, "");
1138 }
1139
1140 bool GraphKit::compute_stack_effects(int& inputs, int& depth) {
1141 Bytecodes::Code code = java_bc();
1142 if (code == Bytecodes::_wide) {
1143 code = method()->java_code_at_bci(bci() + 1);
1144 }
1145
1146 if (code != Bytecodes::_illegal) {
1147 depth = Bytecodes::depth(code); // checkcast=0, athrow=-1
1148 }
1149
1150 auto rsize = [&]() {
1151 assert(code != Bytecodes::_illegal, "code is illegal!");
1152 BasicType rtype = Bytecodes::result_type(code); // checkcast=P, athrow=V
1153 return (rtype < T_CONFLICT) ? type2size[rtype] : 0;
1154 };
1155
1156 switch (code) {
1157 case Bytecodes::_illegal:
1158 return false;
1159
1160 case Bytecodes::_ldc:
1161 case Bytecodes::_ldc_w:
1162 case Bytecodes::_ldc2_w:
1163 inputs = 0;
1164 break;
1165
1166 case Bytecodes::_dup: inputs = 1; break;
1167 case Bytecodes::_dup_x1: inputs = 2; break;
1168 case Bytecodes::_dup_x2: inputs = 3; break;
1169 case Bytecodes::_dup2: inputs = 2; break;
1170 case Bytecodes::_dup2_x1: inputs = 3; break;
1171 case Bytecodes::_dup2_x2: inputs = 4; break;
1172 case Bytecodes::_swap: inputs = 2; break;
1173 case Bytecodes::_arraylength: inputs = 1; break;
1174
1175 case Bytecodes::_getstatic:
1176 case Bytecodes::_putstatic:
1177 case Bytecodes::_getfield:
1178 case Bytecodes::_putfield:
1179 {
1180 bool ignored_will_link;
1181 ciField* field = method()->get_field_at_bci(bci(), ignored_will_link);
1182 int size = field->type()->size();
1183 bool is_get = (depth >= 0), is_static = (depth & 1);
1184 inputs = (is_static ? 0 : 1);
1185 if (is_get) {
1186 depth = size - inputs;
1187 } else {
1188 inputs += size; // putxxx pops the value from the stack
1189 depth = - inputs;
1190 }
1191 }
1192 break;
1193
1194 case Bytecodes::_invokevirtual:
1195 case Bytecodes::_invokespecial:
1196 case Bytecodes::_invokestatic:
1197 case Bytecodes::_invokedynamic:
1198 case Bytecodes::_invokeinterface:
1199 {
1200 bool ignored_will_link;
1201 ciSignature* declared_signature = nullptr;
1202 ciMethod* ignored_callee = method()->get_method_at_bci(bci(), ignored_will_link, &declared_signature);
1203 assert(declared_signature != nullptr, "cannot be null");
1204 inputs = declared_signature->arg_size_for_bc(code);
1205 int size = declared_signature->return_type()->size();
1206 depth = size - inputs;
1207 }
1208 break;
1209
1210 case Bytecodes::_multianewarray:
1211 {
1212 ciBytecodeStream iter(method());
1213 iter.reset_to_bci(bci());
1214 iter.next();
1215 inputs = iter.get_dimensions();
1216 assert(rsize() == 1, "");
1217 depth = 1 - inputs;
1218 }
1219 break;
1220
1221 case Bytecodes::_ireturn:
1222 case Bytecodes::_lreturn:
1223 case Bytecodes::_freturn:
1224 case Bytecodes::_dreturn:
1225 case Bytecodes::_areturn:
1226 assert(rsize() == -depth, "");
1227 inputs = -depth;
1228 break;
1229
1230 case Bytecodes::_jsr:
1231 case Bytecodes::_jsr_w:
1232 inputs = 0;
1233 depth = 1; // S.B. depth=1, not zero
1234 break;
1235
1236 default:
1237 // bytecode produces a typed result
1238 inputs = rsize() - depth;
1239 assert(inputs >= 0, "");
1240 break;
1241 }
1242
1243 #ifdef ASSERT
1244 // spot check
1245 int outputs = depth + inputs;
1246 assert(outputs >= 0, "sanity");
1247 switch (code) {
1248 case Bytecodes::_checkcast: assert(inputs == 1 && outputs == 1, ""); break;
1249 case Bytecodes::_athrow: assert(inputs == 1 && outputs == 0, ""); break;
1250 case Bytecodes::_aload_0: assert(inputs == 0 && outputs == 1, ""); break;
1251 case Bytecodes::_return: assert(inputs == 0 && outputs == 0, ""); break;
1252 case Bytecodes::_drem: assert(inputs == 4 && outputs == 2, ""); break;
1253 default: break;
1254 }
1255 #endif //ASSERT
1256
1257 return true;
1258 }
1259
1260
1261
1262 //------------------------------basic_plus_adr---------------------------------
1263 Node* GraphKit::basic_plus_adr(Node* base, Node* ptr, Node* offset) {
1264 // short-circuit a common case
1265 if (offset == MakeConX(0)) {
1266 return ptr;
1267 }
1268 #ifdef ASSERT
1269 // Both 32-bit and 64-bit zeros should have been handled by the previous `if`
1270 // statement, so if we see either 32-bit or 64-bit zeros here, then we have a
1271 // problem.
1272 if (offset->is_Con()) {
1273 const Type* t = offset->bottom_type();
1274 bool is_zero_int = t->isa_int() && t->is_int()->get_con() == 0;
1275 bool is_zero_long = t->isa_long() && t->is_long()->get_con() == 0;
1276 assert(!is_zero_int && !is_zero_long,
1277 "Unexpected zero offset - should have matched MakeConX(0)");
1278 }
1279 #endif
1280 return _gvn.transform(AddPNode::make_with_base(base, ptr, offset));
1281 }
1282
1283 Node* GraphKit::ConvI2L(Node* offset) {
1284 // short-circuit a common case
1285 jint offset_con = find_int_con(offset, Type::OffsetBot);
1286 if (offset_con != Type::OffsetBot) {
1287 return longcon((jlong) offset_con);
1288 }
1289 return _gvn.transform( new ConvI2LNode(offset));
1290 }
1291
1292 Node* GraphKit::ConvI2UL(Node* offset) {
1293 juint offset_con = (juint) find_int_con(offset, Type::OffsetBot);
1294 if (offset_con != (juint) Type::OffsetBot) {
1295 return longcon((julong) offset_con);
1296 }
1297 Node* conv = _gvn.transform( new ConvI2LNode(offset));
1298 Node* mask = _gvn.transform(ConLNode::make((julong) max_juint));
1299 return _gvn.transform( new AndLNode(conv, mask) );
1300 }
1301
1302 Node* GraphKit::ConvL2I(Node* offset) {
1303 // short-circuit a common case
1304 jlong offset_con = find_long_con(offset, (jlong)Type::OffsetBot);
1305 if (offset_con != (jlong)Type::OffsetBot) {
1306 return intcon((int) offset_con);
1307 }
1308 return _gvn.transform( new ConvL2INode(offset));
1309 }
1310
1311 //-------------------------load_object_klass-----------------------------------
1312 Node* GraphKit::load_object_klass(Node* obj) {
1313 // Special-case a fresh allocation to avoid building nodes:
1314 Node* akls = AllocateNode::Ideal_klass(obj, &_gvn);
1315 if (akls != nullptr) return akls;
1316 Node* k_adr = basic_plus_adr(obj, oopDesc::klass_offset_in_bytes());
1317 return _gvn.transform(LoadKlassNode::make(_gvn, immutable_memory(), k_adr, TypeInstPtr::KLASS, TypeInstKlassPtr::OBJECT));
1318 }
1319
1320 //-------------------------load_array_length-----------------------------------
1321 Node* GraphKit::load_array_length(Node* array) {
1322 // Special-case a fresh allocation to avoid building nodes:
1323 AllocateArrayNode* alloc = AllocateArrayNode::Ideal_array_allocation(array);
1324 Node *alen;
1325 if (alloc == nullptr) {
1326 Node *r_adr = basic_plus_adr(array, arrayOopDesc::length_offset_in_bytes());
1327 alen = _gvn.transform( new LoadRangeNode(nullptr, immutable_memory(), r_adr, TypeInt::POS));
1328 } else {
1329 alen = array_ideal_length(alloc, _gvn.type(array)->is_oopptr(), false);
1330 }
1331 return alen;
1332 }
1333
1334 Node* GraphKit::array_ideal_length(AllocateArrayNode* alloc,
1335 const TypeOopPtr* oop_type,
1336 bool replace_length_in_map) {
1337 Node* length = alloc->Ideal_length();
1338 if (replace_length_in_map == false || map()->find_edge(length) >= 0) {
1339 Node* ccast = alloc->make_ideal_length(oop_type, &_gvn);
1340 if (ccast != length) {
1341 // do not transform ccast here, it might convert to top node for
1342 // negative array length and break assumptions in parsing stage.
1343 _gvn.set_type_bottom(ccast);
1344 record_for_igvn(ccast);
1345 if (replace_length_in_map) {
1346 replace_in_map(length, ccast);
1347 }
1348 return ccast;
1349 }
1350 }
1351 return length;
1352 }
1353
1354 //------------------------------do_null_check----------------------------------
1355 // Helper function to do a null pointer check. Returned value is
1356 // the incoming address with null casted away. You are allowed to use the
1357 // not-null value only if you are control dependent on the test.
1358 #ifndef PRODUCT
1359 extern uint explicit_null_checks_inserted,
1360 explicit_null_checks_elided;
1361 #endif
1362 Node* GraphKit::null_check_common(Node* value, BasicType type,
1363 // optional arguments for variations:
1364 bool assert_null,
1365 Node* *null_control,
1366 bool speculative,
1367 bool null_marker_check) {
1368 assert(!assert_null || null_control == nullptr, "not both at once");
1369 if (stopped()) return top();
1370 NOT_PRODUCT(explicit_null_checks_inserted++);
1371
1372 if (value->is_InlineType()) {
1373 // Null checking a scalarized but nullable inline type. Check the null marker
1374 // input instead of the oop input to avoid keeping buffer allocations alive.
1375 null_check_common(value->as_InlineType()->get_null_marker(), T_INT, assert_null, null_control, speculative, true);
1376 if (stopped()) {
1377 return top();
1378 }
1379 if (assert_null) {
1380 replace_in_map(value, null());
1381 return null();
1382 }
1383 bool do_replace_in_map = (null_control == nullptr || (*null_control) == top());
1384 return cast_not_null(value, do_replace_in_map);
1385 }
1386
1387 // Construct null check
1388 Node *chk = nullptr;
1389 switch(type) {
1390 case T_LONG : chk = new CmpLNode(value, _gvn.zerocon(T_LONG)); break;
1391 case T_INT : chk = new CmpINode(value, _gvn.intcon(0)); break;
1392 case T_ARRAY : // fall through
1393 type = T_OBJECT; // simplify further tests
1394 case T_OBJECT : {
1395 const Type *t = _gvn.type( value );
1396
1397 const TypeOopPtr* tp = t->isa_oopptr();
1398 if (tp != nullptr && !tp->is_loaded()
1399 // Only for do_null_check, not any of its siblings:
1400 && !assert_null && null_control == nullptr) {
1401 // Usually, any field access or invocation on an unloaded oop type
1402 // will simply fail to link, since the statically linked class is
1403 // likely also to be unloaded. However, in -Xcomp mode, sometimes
1404 // the static class is loaded but the sharper oop type is not.
1405 // Rather than checking for this obscure case in lots of places,
1406 // we simply observe that a null check on an unloaded class
1407 // will always be followed by a nonsense operation, so we
1408 // can just issue the uncommon trap here.
1409 // Our access to the unloaded class will only be correct
1410 // after it has been loaded and initialized, which requires
1411 // a trip through the interpreter.
1412 ciKlass* klass = tp->unloaded_klass();
1413 #ifndef PRODUCT
1414 if (WizardMode) { tty->print("Null check of unloaded "); klass->print(); tty->cr(); }
1415 #endif
1416 uncommon_trap(Deoptimization::Reason_unloaded,
1417 Deoptimization::Action_reinterpret,
1418 klass, "!loaded");
1419 return top();
1420 }
1421
1422 if (assert_null) {
1423 // See if the type is contained in NULL_PTR.
1424 // If so, then the value is already null.
1425 if (t->higher_equal(TypePtr::NULL_PTR)) {
1426 NOT_PRODUCT(explicit_null_checks_elided++);
1427 return value; // Elided null assert quickly!
1428 }
1429 } else {
1430 // See if mixing in the null pointer changes type.
1431 // If so, then the null pointer was not allowed in the original
1432 // type. In other words, "value" was not-null.
1433 if (t->meet(TypePtr::NULL_PTR) != t->remove_speculative()) {
1434 // same as: if (!TypePtr::NULL_PTR->higher_equal(t)) ...
1435 NOT_PRODUCT(explicit_null_checks_elided++);
1436 return value; // Elided null check quickly!
1437 }
1438 }
1439 chk = new CmpPNode( value, null() );
1440 break;
1441 }
1442
1443 default:
1444 fatal("unexpected type: %s", type2name(type));
1445 }
1446 assert(chk != nullptr, "sanity check");
1447 chk = _gvn.transform(chk);
1448
1449 BoolTest::mask btest = assert_null ? BoolTest::eq : BoolTest::ne;
1450 BoolNode *btst = new BoolNode( chk, btest);
1451 Node *tst = _gvn.transform( btst );
1452
1453 //-----------
1454 // if peephole optimizations occurred, a prior test existed.
1455 // If a prior test existed, maybe it dominates as we can avoid this test.
1456 if (tst != btst && type == T_OBJECT) {
1457 // At this point we want to scan up the CFG to see if we can
1458 // find an identical test (and so avoid this test altogether).
1459 Node *cfg = control();
1460 int depth = 0;
1461 while( depth < 16 ) { // Limit search depth for speed
1462 if( cfg->Opcode() == Op_IfTrue &&
1463 cfg->in(0)->in(1) == tst ) {
1464 // Found prior test. Use "cast_not_null" to construct an identical
1465 // CastPP (and hence hash to) as already exists for the prior test.
1466 // Return that casted value.
1467 if (assert_null) {
1468 replace_in_map(value, null());
1469 return null(); // do not issue the redundant test
1470 }
1471 Node *oldcontrol = control();
1472 set_control(cfg);
1473 Node *res = cast_not_null(value);
1474 set_control(oldcontrol);
1475 NOT_PRODUCT(explicit_null_checks_elided++);
1476 return res;
1477 }
1478 cfg = IfNode::up_one_dom(cfg, /*linear_only=*/ true);
1479 if (cfg == nullptr) break; // Quit at region nodes
1480 depth++;
1481 }
1482 }
1483
1484 //-----------
1485 // Branch to failure if null
1486 float ok_prob = PROB_MAX; // a priori estimate: nulls never happen
1487 Deoptimization::DeoptReason reason;
1488 if (assert_null) {
1489 reason = Deoptimization::reason_null_assert(speculative);
1490 } else if (type == T_OBJECT || null_marker_check) {
1491 reason = Deoptimization::reason_null_check(speculative);
1492 } else {
1493 reason = Deoptimization::Reason_div0_check;
1494 }
1495 // %%% Since Reason_unhandled is not recorded on a per-bytecode basis,
1496 // ciMethodData::has_trap_at will return a conservative -1 if any
1497 // must-be-null assertion has failed. This could cause performance
1498 // problems for a method after its first do_null_assert failure.
1499 // Consider using 'Reason_class_check' instead?
1500
1501 // To cause an implicit null check, we set the not-null probability
1502 // to the maximum (PROB_MAX). For an explicit check the probability
1503 // is set to a smaller value.
1504 if (null_control != nullptr || too_many_traps(reason)) {
1505 // probability is less likely
1506 ok_prob = PROB_LIKELY_MAG(3);
1507 } else if (!assert_null &&
1508 (ImplicitNullCheckThreshold > 0) &&
1509 method() != nullptr &&
1510 (method()->method_data()->trap_count(reason)
1511 >= (uint)ImplicitNullCheckThreshold)) {
1512 ok_prob = PROB_LIKELY_MAG(3);
1513 }
1514
1515 if (null_control != nullptr) {
1516 IfNode* iff = create_and_map_if(control(), tst, ok_prob, COUNT_UNKNOWN);
1517 Node* null_true = _gvn.transform( new IfFalseNode(iff));
1518 set_control( _gvn.transform( new IfTrueNode(iff)));
1519 #ifndef PRODUCT
1520 if (null_true == top()) {
1521 explicit_null_checks_elided++;
1522 }
1523 #endif
1524 (*null_control) = null_true;
1525 } else {
1526 BuildCutout unless(this, tst, ok_prob);
1527 // Check for optimizer eliding test at parse time
1528 if (stopped()) {
1529 // Failure not possible; do not bother making uncommon trap.
1530 NOT_PRODUCT(explicit_null_checks_elided++);
1531 } else if (assert_null) {
1532 uncommon_trap(reason,
1533 Deoptimization::Action_make_not_entrant,
1534 nullptr, "assert_null");
1535 } else {
1536 replace_in_map(value, zerocon(type));
1537 builtin_throw(reason);
1538 }
1539 }
1540
1541 // Must throw exception, fall-thru not possible?
1542 if (stopped()) {
1543 return top(); // No result
1544 }
1545
1546 if (assert_null) {
1547 // Cast obj to null on this path.
1548 replace_in_map(value, zerocon(type));
1549 return zerocon(type);
1550 }
1551
1552 // Cast obj to not-null on this path, if there is no null_control.
1553 // (If there is a null_control, a non-null value may come back to haunt us.)
1554 if (type == T_OBJECT) {
1555 Node* cast = cast_not_null(value, false);
1556 if (null_control == nullptr || (*null_control) == top())
1557 replace_in_map(value, cast);
1558 value = cast;
1559 }
1560
1561 return value;
1562 }
1563
1564 //------------------------------cast_not_null----------------------------------
1565 // Cast obj to not-null on this path
1566 Node* GraphKit::cast_not_null(Node* obj, bool do_replace_in_map) {
1567 const Type* t = _gvn.type(obj);
1568 const Type* t_not_null = t->join_speculative(TypePtr::NOTNULL);
1569 if (t == t_not_null) {
1570 return obj;
1571 }
1572
1573 Node* cast = new CastPPNode(control(), obj, t_not_null);
1574 cast = _gvn.transform(cast);
1575
1576 // Scan for instances of 'obj' in the current JVM mapping.
1577 // These instances are known to be not-null after the test.
1578 if (do_replace_in_map) {
1579 replace_in_map(obj, cast);
1580 }
1581 return cast;
1582 }
1583
1584 // Sometimes in intrinsics, we implicitly know an object is not null
1585 // (there's no actual null check) so we can cast it to not null. In
1586 // the course of optimizations, the input to the cast can become null.
1587 // In that case that data path will die and we need the control path
1588 // to become dead as well to keep the graph consistent. So we have to
1589 // add a check for null for which one branch can't be taken. It uses
1590 // an OpaqueConstantBool node that will cause the check to be removed after loop
1591 // opts so the test goes away and the compiled code doesn't execute a
1592 // useless check.
1593 Node* GraphKit::must_be_not_null(Node* value, bool do_replace_in_map) {
1594 if (!TypePtr::NULL_PTR->higher_equal(_gvn.type(value))) {
1595 return value;
1596 }
1597 Node* chk = _gvn.transform(new CmpPNode(value, null()));
1598 Node* tst = _gvn.transform(new BoolNode(chk, BoolTest::ne));
1599 Node* opaq = _gvn.transform(new OpaqueConstantBoolNode(C, tst, true));
1600 IfNode* iff = new IfNode(control(), opaq, PROB_MAX, COUNT_UNKNOWN);
1601 _gvn.set_type(iff, iff->Value(&_gvn));
1602 if (!tst->is_Con()) {
1603 record_for_igvn(iff);
1604 }
1605 Node *if_f = _gvn.transform(new IfFalseNode(iff));
1606 Node *frame = _gvn.transform(new ParmNode(C->start(), TypeFunc::FramePtr));
1607 halt(if_f, frame, "unexpected null in intrinsic");
1608 Node *if_t = _gvn.transform(new IfTrueNode(iff));
1609 set_control(if_t);
1610 return cast_not_null(value, do_replace_in_map);
1611 }
1612
1613
1614 //--------------------------replace_in_map-------------------------------------
1615 void GraphKit::replace_in_map(Node* old, Node* neww) {
1616 if (old == neww) {
1617 return;
1618 }
1619
1620 map()->replace_edge(old, neww);
1621
1622 // Note: This operation potentially replaces any edge
1623 // on the map. This includes locals, stack, and monitors
1624 // of the current (innermost) JVM state.
1625
1626 // don't let inconsistent types from profiling escape this
1627 // method
1628
1629 const Type* told = _gvn.type(old);
1630 const Type* tnew = _gvn.type(neww);
1631
1632 if (!tnew->higher_equal(told)) {
1633 return;
1634 }
1635
1636 map()->record_replaced_node(old, neww);
1637 }
1638
1639
1640 //=============================================================================
1641 //--------------------------------memory---------------------------------------
1642 Node* GraphKit::memory(uint alias_idx) {
1643 MergeMemNode* mem = merged_memory();
1644 Node* p = mem->memory_at(alias_idx);
1645 assert(p != mem->empty_memory(), "empty");
1646 _gvn.set_type(p, Type::MEMORY); // must be mapped
1647 return p;
1648 }
1649
1650 //-----------------------------reset_memory------------------------------------
1651 Node* GraphKit::reset_memory() {
1652 Node* mem = map()->memory();
1653 // do not use this node for any more parsing!
1654 DEBUG_ONLY( map()->set_memory((Node*)nullptr) );
1655 return _gvn.transform( mem );
1656 }
1657
1658 //------------------------------set_all_memory---------------------------------
1659 void GraphKit::set_all_memory(Node* newmem) {
1660 // The 2 cases are semantically equivalent
1661 MergeMemNode* mergemem;
1662 if (_gvn.is_IterGVN()) {
1663 // During IGVN, create a more predictable pattern so it is easier to verify that the GraphKit
1664 // does not modify memory
1665 mergemem = MergeMemNode::make(C->top());
1666 mergemem->set_base_memory(newmem);
1667 } else {
1668 // During parsing, be a little more aggressive so that GVN can fold accesses more easily
1669 mergemem = MergeMemNode::make(newmem);
1670 }
1671 _gvn.set_type_bottom(mergemem);
1672 record_for_igvn(mergemem);
1673 map()->set_memory(mergemem);
1674 }
1675
1676 //------------------------------set_all_memory_call----------------------------
1677 void GraphKit::set_all_memory_call(Node* call, bool separate_io_proj) {
1678 Node* newmem = _gvn.transform( new ProjNode(call, TypeFunc::Memory, separate_io_proj) );
1679 set_all_memory(newmem);
1680 }
1681
1682 //=============================================================================
1683 //
1684 // parser factory methods for MemNodes
1685 //
1686 // These are layered on top of the factory methods in LoadNode and StoreNode,
1687 // and integrate with the parser's memory state and _gvn engine.
1688 //
1689
1690 // factory methods in "int adr_idx"
1691 Node* GraphKit::make_load(Node* ctl, Node* adr, const Type* t, BasicType bt,
1692 MemNode::MemOrd mo,
1693 LoadNode::ControlDependency control_dependency,
1694 bool require_atomic_access,
1695 bool unaligned,
1696 bool mismatched,
1697 bool unsafe,
1698 uint8_t barrier_data) {
1699 int adr_idx = C->get_alias_index(_gvn.type(adr)->isa_ptr());
1700 assert(adr_idx != Compile::AliasIdxTop, "use other make_load factory" );
1701 const TypePtr* adr_type = nullptr; // debug-mode-only argument
1702 DEBUG_ONLY(adr_type = C->get_adr_type(adr_idx));
1703 Node* mem = memory(adr_idx);
1704 Node* ld = LoadNode::make(_gvn, ctl, mem, adr, adr_type, t, bt, mo, control_dependency, require_atomic_access, unaligned, mismatched, unsafe, barrier_data);
1705 ld = _gvn.transform(ld);
1706
1707 if (((bt == T_OBJECT) && C->do_escape_analysis()) || C->eliminate_boxing()) {
1708 // Improve graph before escape analysis and boxing elimination.
1709 record_for_igvn(ld);
1710 if (ld->is_DecodeN()) {
1711 // Also record the actual load (LoadN) in case ld is DecodeN. In some
1712 // rare corner cases, ld->in(1) can be something other than LoadN (e.g.,
1713 // a Phi). Recording such cases is still perfectly sound, but may be
1714 // unnecessary and result in some minor IGVN overhead.
1715 record_for_igvn(ld->in(1));
1716 }
1717 }
1718 return ld;
1719 }
1720
1721 Node* GraphKit::store_to_memory(Node* ctl, Node* adr, Node *val, BasicType bt,
1722 MemNode::MemOrd mo,
1723 bool require_atomic_access,
1724 bool unaligned,
1725 bool mismatched,
1726 bool unsafe,
1727 int barrier_data) {
1728 int adr_idx = C->get_alias_index(_gvn.type(adr)->isa_ptr());
1729 assert(adr_idx != Compile::AliasIdxTop, "use other store_to_memory factory" );
1730 const TypePtr* adr_type = nullptr;
1731 DEBUG_ONLY(adr_type = C->get_adr_type(adr_idx));
1732 Node *mem = memory(adr_idx);
1733 Node* st = StoreNode::make(_gvn, ctl, mem, adr, adr_type, val, bt, mo, require_atomic_access);
1734 if (unaligned) {
1735 st->as_Store()->set_unaligned_access();
1736 }
1737 if (mismatched) {
1738 st->as_Store()->set_mismatched_access();
1739 }
1740 if (unsafe) {
1741 st->as_Store()->set_unsafe_access();
1742 }
1743 st->as_Store()->set_barrier_data(barrier_data);
1744 st = _gvn.transform(st);
1745 set_memory(st, adr_idx);
1746 // Back-to-back stores can only remove intermediate store with DU info
1747 // so push on worklist for optimizer.
1748 if (mem->req() > MemNode::Address && adr == mem->in(MemNode::Address))
1749 record_for_igvn(st);
1750
1751 return st;
1752 }
1753
1754 Node* GraphKit::access_store_at(Node* obj,
1755 Node* adr,
1756 const TypePtr* adr_type,
1757 Node* val,
1758 const Type* val_type,
1759 BasicType bt,
1760 DecoratorSet decorators,
1761 bool safe_for_replace,
1762 const InlineTypeNode* vt) {
1763 // Transformation of a value which could be null pointer (CastPP #null)
1764 // could be delayed during Parse (for example, in adjust_map_after_if()).
1765 // Execute transformation here to avoid barrier generation in such case.
1766 if (_gvn.type(val) == TypePtr::NULL_PTR) {
1767 val = _gvn.makecon(TypePtr::NULL_PTR);
1768 }
1769
1770 if (stopped()) {
1771 return top(); // Dead path ?
1772 }
1773
1774 assert(val != nullptr, "not dead path");
1775 if (val->is_InlineType()) {
1776 // Store to non-flat field. Buffer the inline type and make sure
1777 // the store is re-executed if the allocation triggers deoptimization.
1778 PreserveReexecuteState preexecs(this);
1779 jvms()->set_should_reexecute(true);
1780 val = val->as_InlineType()->buffer(this, safe_for_replace);
1781 }
1782
1783 C2AccessValuePtr addr(adr, adr_type);
1784 C2AccessValue value(val, val_type);
1785 C2ParseAccess access(this, decorators | C2_WRITE_ACCESS, bt, obj, addr, nullptr, vt);
1786 if (access.is_raw()) {
1787 return _barrier_set->BarrierSetC2::store_at(access, value);
1788 } else {
1789 return _barrier_set->store_at(access, value);
1790 }
1791 }
1792
1793 Node* GraphKit::access_load_at(Node* obj, // containing obj
1794 Node* adr, // actual address to store val at
1795 const TypePtr* adr_type,
1796 const Type* val_type,
1797 BasicType bt,
1798 DecoratorSet decorators,
1799 Node* ctl) {
1800 if (stopped()) {
1801 return top(); // Dead path ?
1802 }
1803
1804 SavedState old_state(this);
1805 C2AccessValuePtr addr(adr, adr_type);
1806 C2ParseAccess access(this, decorators | C2_READ_ACCESS, bt, obj, addr, ctl);
1807 Node* load;
1808 if (access.is_raw()) {
1809 load = _barrier_set->BarrierSetC2::load_at(access, val_type);
1810 } else {
1811 load = _barrier_set->load_at(access, val_type);
1812 }
1813
1814 // Restore the previous state only if the load got folded to a constant
1815 // and we can discard any barriers that might have been added.
1816 if (load == nullptr || !load->is_Con()) {
1817 old_state.discard();
1818 }
1819 return load;
1820 }
1821
1822 Node* GraphKit::access_load(Node* adr, // actual address to load val at
1823 const Type* val_type,
1824 BasicType bt,
1825 DecoratorSet decorators) {
1826 if (stopped()) {
1827 return top(); // Dead path ?
1828 }
1829
1830 SavedState old_state(this);
1831 C2AccessValuePtr addr(adr, adr->bottom_type()->is_ptr());
1832 C2ParseAccess access(this, decorators | C2_READ_ACCESS, bt, nullptr, addr);
1833 Node* load;
1834 if (access.is_raw()) {
1835 load = _barrier_set->BarrierSetC2::load_at(access, val_type);
1836 } else {
1837 load = _barrier_set->load_at(access, val_type);
1838 }
1839
1840 // Restore the previous state only if the load got folded to a constant
1841 // and we can discard any barriers that might have been added.
1842 if (load == nullptr || !load->is_Con()) {
1843 old_state.discard();
1844 }
1845 return load;
1846 }
1847
1848 Node* GraphKit::access_atomic_cmpxchg_val_at(Node* obj,
1849 Node* adr,
1850 const TypePtr* adr_type,
1851 int alias_idx,
1852 Node* expected_val,
1853 Node* new_val,
1854 const Type* value_type,
1855 BasicType bt,
1856 DecoratorSet decorators) {
1857 C2AccessValuePtr addr(adr, adr_type);
1858 C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS,
1859 bt, obj, addr, alias_idx);
1860 if (access.is_raw()) {
1861 return _barrier_set->BarrierSetC2::atomic_cmpxchg_val_at(access, expected_val, new_val, value_type);
1862 } else {
1863 return _barrier_set->atomic_cmpxchg_val_at(access, expected_val, new_val, value_type);
1864 }
1865 }
1866
1867 Node* GraphKit::access_atomic_cmpxchg_bool_at(Node* obj,
1868 Node* adr,
1869 const TypePtr* adr_type,
1870 int alias_idx,
1871 Node* expected_val,
1872 Node* new_val,
1873 const Type* value_type,
1874 BasicType bt,
1875 DecoratorSet decorators) {
1876 C2AccessValuePtr addr(adr, adr_type);
1877 C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS,
1878 bt, obj, addr, alias_idx);
1879 if (access.is_raw()) {
1880 return _barrier_set->BarrierSetC2::atomic_cmpxchg_bool_at(access, expected_val, new_val, value_type);
1881 } else {
1882 return _barrier_set->atomic_cmpxchg_bool_at(access, expected_val, new_val, value_type);
1883 }
1884 }
1885
1886 Node* GraphKit::access_atomic_xchg_at(Node* obj,
1887 Node* adr,
1888 const TypePtr* adr_type,
1889 int alias_idx,
1890 Node* new_val,
1891 const Type* value_type,
1892 BasicType bt,
1893 DecoratorSet decorators) {
1894 C2AccessValuePtr addr(adr, adr_type);
1895 C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS,
1896 bt, obj, addr, alias_idx);
1897 if (access.is_raw()) {
1898 return _barrier_set->BarrierSetC2::atomic_xchg_at(access, new_val, value_type);
1899 } else {
1900 return _barrier_set->atomic_xchg_at(access, new_val, value_type);
1901 }
1902 }
1903
1904 Node* GraphKit::access_atomic_add_at(Node* obj,
1905 Node* adr,
1906 const TypePtr* adr_type,
1907 int alias_idx,
1908 Node* new_val,
1909 const Type* value_type,
1910 BasicType bt,
1911 DecoratorSet decorators) {
1912 C2AccessValuePtr addr(adr, adr_type);
1913 C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS, bt, obj, addr, alias_idx);
1914 if (access.is_raw()) {
1915 return _barrier_set->BarrierSetC2::atomic_add_at(access, new_val, value_type);
1916 } else {
1917 return _barrier_set->atomic_add_at(access, new_val, value_type);
1918 }
1919 }
1920
1921 void GraphKit::access_clone(Node* src, Node* dst, Node* size, bool is_array) {
1922 return _barrier_set->clone(this, src, dst, size, is_array);
1923 }
1924
1925 //-------------------------array_element_address-------------------------
1926 Node* GraphKit::array_element_address(Node* ary, Node* idx, BasicType elembt,
1927 const TypeInt* sizetype, Node* ctrl) {
1928 const TypeAryPtr* arytype = _gvn.type(ary)->is_aryptr();
1929 uint shift;
1930 uint header;
1931 if (arytype->is_flat() && arytype->klass_is_exact()) {
1932 // We can only determine the flat array layout statically if the klass is exact. Otherwise, we could have different
1933 // value classes at runtime with a potentially different layout. The caller needs to fall back to call
1934 // load/store_unknown_inline_Type() at runtime. We could return a sentinel node for the non-exact case but that
1935 // might mess with other GVN transformations in between. Thus, we just continue in the else branch normally, even
1936 // though we don't need the address node in this case and throw it away again.
1937 shift = arytype->flat_log_elem_size();
1938 header = arrayOopDesc::base_offset_in_bytes(T_FLAT_ELEMENT);
1939 } else {
1940 shift = exact_log2(type2aelembytes(elembt));
1941 header = arrayOopDesc::base_offset_in_bytes(elembt);
1942 }
1943
1944 // short-circuit a common case (saves lots of confusing waste motion)
1945 jint idx_con = find_int_con(idx, -1);
1946 if (idx_con >= 0) {
1947 intptr_t offset = header + ((intptr_t)idx_con << shift);
1948 return basic_plus_adr(ary, offset);
1949 }
1950
1951 // must be correct type for alignment purposes
1952 Node* base = basic_plus_adr(ary, header);
1953 idx = Compile::conv_I2X_index(&_gvn, idx, sizetype, ctrl);
1954 Node* scale = _gvn.transform( new LShiftXNode(idx, intcon(shift)) );
1955 return basic_plus_adr(ary, base, scale);
1956 }
1957
1958 Node* GraphKit::cast_to_flat_array(Node* array, ciInlineKlass* elem_vk) {
1959 assert(elem_vk->maybe_flat_in_array(), "no flat array for %s", elem_vk->name()->as_utf8());
1960 if (!elem_vk->has_null_free_atomic_layout() && !elem_vk->has_nullable_atomic_layout()) {
1961 return cast_to_flat_array_exact(array, elem_vk, true, false);
1962 } else if (!elem_vk->has_nullable_atomic_layout() && !elem_vk->has_null_free_non_atomic_layout()) {
1963 return cast_to_flat_array_exact(array, elem_vk, true, true);
1964 } else if (!elem_vk->has_null_free_atomic_layout() && !elem_vk->has_null_free_non_atomic_layout()) {
1965 return cast_to_flat_array_exact(array, elem_vk, false, true);
1966 }
1967
1968 bool is_null_free = false;
1969 if (!elem_vk->has_nullable_atomic_layout()) {
1970 // Element does not have a nullable flat layout, cannot be nullable
1971 is_null_free = true;
1972 }
1973
1974 ciArrayKlass* array_klass = ciObjArrayKlass::make(elem_vk, false);
1975 const TypeAryPtr* arytype = TypeOopPtr::make_from_klass(array_klass)->isa_aryptr();
1976 arytype = arytype->cast_to_flat(true)->cast_to_null_free(is_null_free);
1977 return _gvn.transform(new CheckCastPPNode(control(), array, arytype, ConstraintCastNode::DependencyType::NonFloatingNarrowing));
1978 }
1979
1980 Node* GraphKit::cast_to_flat_array_exact(Node* array, ciInlineKlass* elem_vk, bool is_null_free, bool is_atomic) {
1981 assert(is_null_free || is_atomic, "nullable arrays must be atomic");
1982 ciArrayKlass* array_klass = ciObjArrayKlass::make(elem_vk, true, is_null_free, is_atomic);
1983 const TypeAryPtr* arytype = TypeOopPtr::make_from_klass(array_klass)->isa_aryptr();
1984 assert(arytype->klass_is_exact(), "inconsistency");
1985 assert(arytype->is_flat(), "inconsistency");
1986 assert(arytype->is_null_free() == is_null_free, "inconsistency");
1987 assert(arytype->is_not_null_free() == !is_null_free, "inconsistency");
1988 return _gvn.transform(new CheckCastPPNode(control(), array, arytype, ConstraintCastNode::DependencyType::NonFloatingNarrowing));
1989 }
1990
1991 //-------------------------load_array_element-------------------------
1992 Node* GraphKit::load_array_element(Node* ary, Node* idx, const TypeAryPtr* arytype, bool set_ctrl) {
1993 const Type* elemtype = arytype->elem();
1994 BasicType elembt = elemtype->array_element_basic_type();
1995 Node* adr = array_element_address(ary, idx, elembt, arytype->size());
1996 if (elembt == T_NARROWOOP) {
1997 elembt = T_OBJECT; // To satisfy switch in LoadNode::make()
1998 }
1999 Node* ld = access_load_at(ary, adr, arytype, elemtype, elembt,
2000 IN_HEAP | IS_ARRAY | (set_ctrl ? C2_CONTROL_DEPENDENT_LOAD : 0));
2001 return ld;
2002 }
2003
2004 //-------------------------set_arguments_for_java_call-------------------------
2005 // Arguments (pre-popped from the stack) are taken from the JVMS.
2006 void GraphKit::set_arguments_for_java_call(CallJavaNode* call) {
2007 PreserveReexecuteState preexecs(this);
2008 if (Arguments::is_valhalla_enabled()) {
2009 // Make sure the call is "re-executed", if buffering of inline type arguments triggers deoptimization.
2010 // At this point, the call hasn't been executed yet, so we will only ever execute the call once.
2011 jvms()->set_should_reexecute(true);
2012 int arg_size = method()->get_declared_signature_at_bci(bci())->arg_size_for_bc(java_bc());
2013 inc_sp(arg_size);
2014 }
2015 // Add the call arguments
2016 const TypeTuple* domain = call->tf()->domain_sig();
2017 uint nargs = domain->cnt();
2018 int arg_num = 0;
2019 for (uint i = TypeFunc::Parms, idx = TypeFunc::Parms; i < nargs; i++) {
2020 uint arg_idx = i - TypeFunc::Parms;
2021 Node* arg = argument(arg_idx);
2022 const Type* t = domain->field_at(i);
2023 if (t->is_inlinetypeptr() && !call->method()->mismatch() && call->method()->is_scalarized_arg(arg_num)) {
2024 // We don't pass inline type arguments by reference but instead pass each field of the inline type
2025 if (!arg->is_InlineType()) {
2026 // There are 2 cases in which the argument has not been scalarized
2027 if (_gvn.type(arg)->is_zero_type()) {
2028 arg = InlineTypeNode::make_null(_gvn, t->inline_klass());
2029 } else {
2030 // During parsing, a method is called with an abstract (or j.l.Object) receiver, the
2031 // receiver is a non-scalarized oop. CHA or IGVN might then prove that the receiver
2032 // type must be an exact value class. The method is devirtualized, and replaced with
2033 // a direct call with a scalarized receiver instead.
2034 assert(arg_idx == 0 && !call->method()->is_static(), "must be the receiver");
2035 assert(call->is_optimized_virtual(), "must be during devirtualization of calls");
2036 arg = InlineTypeNode::make_from_oop(this, arg, t->inline_klass());
2037 }
2038 }
2039 InlineTypeNode* vt = arg->as_InlineType();
2040 vt->pass_fields(this, call, idx, true, !t->maybe_null(), true);
2041 // If an inline type argument is passed as fields, attach the Method* to the call site
2042 // to be able to access the extended signature later via attached_method_before_pc().
2043 // For example, see CompiledMethod::preserve_callee_argument_oops().
2044 call->set_override_symbolic_info(true);
2045 // Register a calling convention dependency on the callee method to make sure that this method is deoptimized and
2046 // re-compiled with a non-scalarized calling convention if the callee method is later marked as mismatched.
2047 C->dependencies()->assert_mismatch_calling_convention(call->method());
2048 arg_num++;
2049 continue;
2050 } else if (arg->is_InlineType()) {
2051 // Pass inline type argument via oop to callee
2052 arg = arg->as_InlineType()->buffer(this, true);
2053 }
2054 if (t != Type::HALF) {
2055 arg_num++;
2056 }
2057 call->init_req(idx++, arg);
2058 }
2059 }
2060
2061 //---------------------------set_edges_for_java_call---------------------------
2062 // Connect a newly created call into the current JVMS.
2063 // A return value node (if any) is returned from set_edges_for_java_call.
2064 void GraphKit::set_edges_for_java_call(CallJavaNode* call, bool must_throw, bool separate_io_proj) {
2065
2066 // Add the predefined inputs:
2067 call->init_req( TypeFunc::Control, control() );
2068 call->init_req( TypeFunc::I_O , i_o() );
2069 call->init_req( TypeFunc::Memory , reset_memory() );
2070 call->init_req( TypeFunc::FramePtr, frameptr() );
2071 call->init_req( TypeFunc::ReturnAdr, top() );
2072
2073 add_safepoint_edges(call, must_throw);
2074
2075 Node* xcall = _gvn.transform(call);
2076
2077 if (xcall == top()) {
2078 set_control(top());
2079 return;
2080 }
2081 assert(xcall == call, "call identity is stable");
2082
2083 // Re-use the current map to produce the result.
2084
2085 set_control(_gvn.transform(new ProjNode(call, TypeFunc::Control)));
2086 set_i_o( _gvn.transform(new ProjNode(call, TypeFunc::I_O , separate_io_proj)));
2087 set_all_memory_call(xcall, separate_io_proj);
2088
2089 //return xcall; // no need, caller already has it
2090 }
2091
2092 Node* GraphKit::set_results_for_java_call(CallJavaNode* call, bool separate_io_proj, bool deoptimize) {
2093 if (stopped()) return top(); // maybe the call folded up?
2094
2095 // Note: Since any out-of-line call can produce an exception,
2096 // we always insert an I_O projection from the call into the result.
2097
2098 make_slow_call_ex(call, env()->Throwable_klass(), separate_io_proj, deoptimize);
2099
2100 if (separate_io_proj) {
2101 // The caller requested separate projections be used by the fall
2102 // through and exceptional paths, so replace the projections for
2103 // the fall through path.
2104 set_i_o(_gvn.transform( new ProjNode(call, TypeFunc::I_O) ));
2105 set_all_memory(_gvn.transform( new ProjNode(call, TypeFunc::Memory) ));
2106 }
2107
2108 // Capture the return value, if any.
2109 Node* ret;
2110 if (call->method() == nullptr || call->method()->return_type()->basic_type() == T_VOID) {
2111 ret = top();
2112 } else if (call->tf()->returns_inline_type_as_fields()) {
2113 // Return of multiple values (inline type fields): we create a
2114 // InlineType node, each field is a projection from the call.
2115 ciInlineKlass* vk = call->method()->return_type()->as_inline_klass();
2116 uint base_input = TypeFunc::Parms;
2117 ret = InlineTypeNode::make_from_multi(this, call, vk, base_input, false, false);
2118 // If we run out of registers to store the null marker, we need to reserve an extra
2119 // slot to store it on the stack. Unfortunately, we only know if stack slot is needed
2120 // when matching the call (see Matcher::return_values_mask), so we are conservative here.
2121 C->set_needs_nm_slot(true);
2122 } else {
2123 ret = _gvn.transform(new ProjNode(call, TypeFunc::Parms));
2124 ciType* t = call->method()->return_type();
2125 if (!t->is_loaded() && InlineTypeReturnedAsFields) {
2126 // The return type is unloaded but the callee might later be C2 compiled and then return
2127 // in scalarized form when the return type is loaded. Handle this similar to what we do in
2128 // PhaseMacroExpand::expand_mh_intrinsic_return by calling into the runtime to buffer.
2129 // It's a bit unfortunate because we will deopt anyway but the interpreter needs an oop.
2130 IdealKit ideal(this);
2131 IdealVariable res(ideal);
2132 ideal.declarations_done();
2133 // Change return type of call to scalarized return
2134 const TypeFunc* tf = call->_tf;
2135 const TypeTuple* domain = OptoRuntime::store_inline_type_fields_Type()->domain_cc();
2136 const TypeFunc* new_tf = TypeFunc::make(tf->domain_sig(), tf->domain_cc(), tf->range_sig(), domain, true);
2137 call->_tf = new_tf;
2138 _gvn.set_type(call, call->Value(&_gvn));
2139 _gvn.set_type(ret, ret->Value(&_gvn));
2140 // Don't add store to buffer call if we are strength reducing
2141 if (!C->strength_reduction()) {
2142 ideal.if_then(ret, BoolTest::eq, ideal.makecon(TypePtr::NULL_PTR)); {
2143 // Return value is null
2144 ideal.set(res, makecon(TypePtr::NULL_PTR));
2145 } ideal.else_(); {
2146 // Return value is non-null
2147 sync_kit(ideal);
2148
2149 Node* store_to_buf_call = make_runtime_call(RC_NO_LEAF | RC_NO_IO,
2150 OptoRuntime::store_inline_type_fields_Type(),
2151 SharedRuntime::store_inline_type_fields_to_buf_entry(),
2152 nullptr, TypePtr::BOTTOM, ret);
2153
2154 // We don't know how many values are returned. This assumes the
2155 // worst case, that all available registers are used.
2156 for (uint i = TypeFunc::Parms+1; i < domain->cnt(); i++) {
2157 if (domain->field_at(i) == Type::HALF) {
2158 store_to_buf_call->init_req(i, top());
2159 continue;
2160 }
2161 Node* proj =_gvn.transform(new ProjNode(call, i));
2162 store_to_buf_call->init_req(i, proj);
2163 }
2164 make_slow_call_ex(store_to_buf_call, env()->Throwable_klass(), false);
2165
2166 Node* buf = _gvn.transform(new ProjNode(store_to_buf_call, TypeFunc::Parms));
2167 const Type* buf_type = TypeOopPtr::make_from_klass(t->as_klass())->join_speculative(TypePtr::NOTNULL);
2168 buf = _gvn.transform(new CheckCastPPNode(control(), buf, buf_type));
2169
2170 ideal.set(res, buf);
2171 ideal.sync_kit(this);
2172 } ideal.end_if();
2173 } else {
2174 for (uint i = TypeFunc::Parms+1; i < domain->cnt(); i++) {
2175 // Will be rewired later in replace_call().
2176 _gvn.transform(new ProjNode(call, i));
2177 }
2178 ideal.set(res, ret);
2179 }
2180 sync_kit(ideal);
2181 ret = _gvn.transform(ideal.value(res));
2182 } else if (!call->method()->return_value_is_larval() && _gvn.type(ret)->is_inlinetypeptr()) {
2183 // In Parse::do_call we call make_from_oop on the final result of the call, but this could be the
2184 // result of merging several call paths. If one of them is made of an actual call node that
2185 // returns an oop, we need to call make_from_oop here as well because we want InlineType
2186 // nodes on every path to avoid merging an unallocated InlineType node path with an oop path.
2187 ret = InlineTypeNode::make_from_oop(this, ret, _gvn.type(ret)->inline_klass());
2188 }
2189 }
2190
2191 return ret;
2192 }
2193
2194 //--------------------set_predefined_input_for_runtime_call--------------------
2195 // Reading and setting the memory state is way conservative here.
2196 // The real problem is that I am not doing real Type analysis on memory,
2197 // so I cannot distinguish card mark stores from other stores. Across a GC
2198 // point the Store Barrier and the card mark memory has to agree. I cannot
2199 // have a card mark store and its barrier split across the GC point from
2200 // either above or below. Here I get that to happen by reading ALL of memory.
2201 // A better answer would be to separate out card marks from other memory.
2202 // For now, return the input memory state, so that it can be reused
2203 // after the call, if this call has restricted memory effects.
2204 Node* GraphKit::set_predefined_input_for_runtime_call(SafePointNode* call, Node* narrow_mem) {
2205 // Set fixed predefined input arguments
2206 call->init_req(TypeFunc::Control, control());
2207 call->init_req(TypeFunc::I_O, top()); // does no i/o
2208 call->init_req(TypeFunc::ReturnAdr, top());
2209 if (call->is_CallLeafPure()) {
2210 call->init_req(TypeFunc::Memory, top());
2211 call->init_req(TypeFunc::FramePtr, top());
2212 return nullptr;
2213 } else {
2214 Node* memory = reset_memory();
2215 Node* m = narrow_mem == nullptr ? memory : narrow_mem;
2216 call->init_req(TypeFunc::Memory, m); // may gc ptrs
2217 call->init_req(TypeFunc::FramePtr, frameptr());
2218 return memory;
2219 }
2220 }
2221
2222 //-------------------set_predefined_output_for_runtime_call--------------------
2223 // Set control and memory (not i_o) from the call.
2224 // If keep_mem is not null, use it for the output state,
2225 // except for the RawPtr output of the call, if hook_mem is TypeRawPtr::BOTTOM.
2226 // If hook_mem is null, this call produces no memory effects at all.
2227 // If hook_mem is a Java-visible memory slice (such as arraycopy operands),
2228 // then only that memory slice is taken from the call.
2229 // In the last case, we must put an appropriate memory barrier before
2230 // the call, so as to create the correct anti-dependencies on loads
2231 // preceding the call.
2232 void GraphKit::set_predefined_output_for_runtime_call(Node* call,
2233 Node* keep_mem,
2234 const TypePtr* hook_mem) {
2235 // no i/o
2236 set_control(_gvn.transform( new ProjNode(call,TypeFunc::Control) ));
2237 if (call->is_CallLeafPure()) {
2238 // Pure function have only control (for now) and data output, in particular
2239 // they don't touch the memory, so we don't want a memory proj that is set after.
2240 return;
2241 }
2242 if (keep_mem) {
2243 // First clone the existing memory state
2244 set_all_memory(keep_mem);
2245 if (hook_mem != nullptr) {
2246 // Make memory for the call
2247 Node* mem = _gvn.transform( new ProjNode(call, TypeFunc::Memory) );
2248 // Set the RawPtr memory state only. This covers all the heap top/GC stuff
2249 // We also use hook_mem to extract specific effects from arraycopy stubs.
2250 set_memory(mem, hook_mem);
2251 }
2252 // ...else the call has NO memory effects.
2253
2254 // Make sure the call advertises its memory effects precisely.
2255 // This lets us build accurate anti-dependences in gcm.cpp.
2256 assert(C->alias_type(call->adr_type()) == C->alias_type(hook_mem),
2257 "call node must be constructed correctly");
2258 } else {
2259 assert(hook_mem == nullptr, "");
2260 // This is not a "slow path" call; all memory comes from the call.
2261 set_all_memory_call(call);
2262 }
2263 }
2264
2265 // Keep track of MergeMems feeding into other MergeMems
2266 static void add_mergemem_users_to_worklist(Unique_Node_List& wl, Node* mem) {
2267 if (!mem->is_MergeMem()) {
2268 return;
2269 }
2270 for (SimpleDUIterator i(mem); i.has_next(); i.next()) {
2271 Node* use = i.get();
2272 if (use->is_MergeMem()) {
2273 wl.push(use);
2274 }
2275 }
2276 }
2277
2278 // Replace the call with the current state of the kit.
2279 void GraphKit::replace_call(CallNode* call, Node* result, bool do_replaced_nodes, bool do_asserts) {
2280 JVMState* ejvms = nullptr;
2281 if (has_exceptions()) {
2282 ejvms = transfer_exceptions_into_jvms();
2283 }
2284
2285 ReplacedNodes replaced_nodes = map()->replaced_nodes();
2286 ReplacedNodes replaced_nodes_exception;
2287 Node* ex_ctl = top();
2288
2289 SafePointNode* final_state = stop();
2290
2291 // Find all the needed outputs of this call
2292 CallProjections* callprojs = call->extract_projections(true, do_asserts);
2293
2294 Unique_Node_List wl;
2295 Node* final_mem = final_state->in(TypeFunc::Memory);
2296 Node* final_ctl = final_state->in(TypeFunc::Control);
2297 Node* final_io = final_state->in(TypeFunc::I_O);
2298
2299 // Replace all the old call edges with the edges from the inlining result
2300 if (callprojs->fallthrough_catchproj != nullptr) {
2301 C->gvn_replace_by(callprojs->fallthrough_catchproj, final_ctl);
2302 }
2303 if (callprojs->fallthrough_memproj != nullptr) {
2304 if (final_mem->is_MergeMem()) {
2305 // Parser's exits MergeMem was not transformed but may be optimized
2306 final_mem = _gvn.transform(final_mem);
2307 }
2308 C->gvn_replace_by(callprojs->fallthrough_memproj, final_mem);
2309 add_mergemem_users_to_worklist(wl, final_mem);
2310 }
2311 if (callprojs->fallthrough_ioproj != nullptr) {
2312 C->gvn_replace_by(callprojs->fallthrough_ioproj, final_io);
2313 }
2314
2315 // Replace the result with the new result if it exists and is used
2316 if (callprojs->resproj[0] != nullptr && result != nullptr) {
2317 // If the inlined code is dead, the result projections for an inline type returned as
2318 // fields have not been replaced. They will go away once the call is replaced by TOP below.
2319 assert(callprojs->nb_resproj == 1 || (call->tf()->returns_inline_type_as_fields() && stopped()) ||
2320 (C->strength_reduction() && InlineTypeReturnedAsFields && !call->as_CallJava()->method()->return_type()->is_loaded()),
2321 "unexpected number of results");
2322 // If we are doing strength reduction and the return type is not loaded we
2323 // need to rewire all projections since store_inline_type_fields_to_buf is already present
2324 if (C->strength_reduction() && InlineTypeReturnedAsFields && !call->as_CallJava()->method()->return_type()->is_loaded()) {
2325 CallNode* new_call = result->in(0)->as_Call();
2326 assert(new_call->proj_out_or_null(TypeFunc::Parms) == result, "the first data projection should be result");
2327 for (uint i = 0; i < callprojs->nb_resproj; i++) {
2328 if (callprojs->resproj[i] != nullptr) {
2329 Node* new_proj = new_call->proj_out_or_null(TypeFunc::Parms + i);
2330 assert(new_proj != nullptr, "projection should be available");
2331 const Type* result_type = _gvn.type(callprojs->resproj[i]);
2332 new_proj = _gvn.transform(new OpaqueParseNode(C, new_proj, result_type));
2333 C->gvn_replace_by(callprojs->resproj[i], new_proj);
2334 }
2335 }
2336 } else {
2337 C->gvn_replace_by(callprojs->resproj[0], result);
2338 }
2339 }
2340
2341 if (ejvms == nullptr) {
2342 // No exception edges to simply kill off those paths
2343 if (callprojs->catchall_catchproj != nullptr) {
2344 C->gvn_replace_by(callprojs->catchall_catchproj, C->top());
2345 }
2346 if (callprojs->catchall_memproj != nullptr) {
2347 C->gvn_replace_by(callprojs->catchall_memproj, C->top());
2348 }
2349 if (callprojs->catchall_ioproj != nullptr) {
2350 C->gvn_replace_by(callprojs->catchall_ioproj, C->top());
2351 }
2352 // Replace the old exception object with top
2353 if (callprojs->exobj != nullptr) {
2354 C->gvn_replace_by(callprojs->exobj, C->top());
2355 }
2356 } else {
2357 GraphKit ekit(ejvms);
2358
2359 // Load my combined exception state into the kit, with all phis transformed:
2360 SafePointNode* ex_map = ekit.combine_and_pop_all_exception_states();
2361 replaced_nodes_exception = ex_map->replaced_nodes();
2362
2363 Node* ex_oop = ekit.use_exception_state(ex_map);
2364
2365 if (callprojs->catchall_catchproj != nullptr) {
2366 C->gvn_replace_by(callprojs->catchall_catchproj, ekit.control());
2367 ex_ctl = ekit.control();
2368 }
2369 if (callprojs->catchall_memproj != nullptr) {
2370 Node* ex_mem = ekit.reset_memory();
2371 C->gvn_replace_by(callprojs->catchall_memproj, ex_mem);
2372 add_mergemem_users_to_worklist(wl, ex_mem);
2373 }
2374 if (callprojs->catchall_ioproj != nullptr) {
2375 C->gvn_replace_by(callprojs->catchall_ioproj, ekit.i_o());
2376 }
2377
2378 // Replace the old exception object with the newly created one
2379 if (callprojs->exobj != nullptr) {
2380 C->gvn_replace_by(callprojs->exobj, ex_oop);
2381 }
2382 }
2383
2384 // Disconnect the call from the graph
2385 call->disconnect_inputs(C);
2386 C->gvn_replace_by(call, C->top());
2387
2388 // Clean up any MergeMems that feed other MergeMems since the
2389 // optimizer doesn't like that.
2390 while (wl.size() > 0) {
2391 _gvn.transform(wl.pop());
2392 }
2393
2394 if (callprojs->fallthrough_catchproj != nullptr && !final_ctl->is_top() && do_replaced_nodes) {
2395 replaced_nodes.apply(C, final_ctl);
2396 }
2397 if (!ex_ctl->is_top() && do_replaced_nodes) {
2398 replaced_nodes_exception.apply(C, ex_ctl);
2399 }
2400 }
2401
2402
2403 //------------------------------increment_counter------------------------------
2404 // for statistics: increment a VM counter by 1
2405
2406 void GraphKit::increment_counter(address counter_addr) {
2407 Node* adr1 = makecon(TypeRawPtr::make(counter_addr));
2408 increment_counter(adr1);
2409 }
2410
2411 void GraphKit::increment_counter(Node* counter_addr) {
2412 Node* ctrl = control();
2413 Node* cnt = make_load(ctrl, counter_addr, TypeLong::LONG, T_LONG, MemNode::unordered);
2414 Node* incr = _gvn.transform(new AddLNode(cnt, _gvn.longcon(1)));
2415 store_to_memory(ctrl, counter_addr, incr, T_LONG, MemNode::unordered);
2416 }
2417
2418 void GraphKit::halt(Node* ctrl, Node* frameptr, const char* reason, bool generate_code_in_product) {
2419 Node* halt = new HaltNode(ctrl, frameptr, reason
2420 PRODUCT_ONLY(COMMA generate_code_in_product));
2421 halt = _gvn.transform(halt);
2422 root()->add_req(halt);
2423 if (_gvn.is_IterGVN() != nullptr) {
2424 record_for_igvn(root());
2425 }
2426 }
2427
2428 //------------------------------uncommon_trap----------------------------------
2429 // Bail out to the interpreter in mid-method. Implemented by calling the
2430 // uncommon_trap blob. This helper function inserts a runtime call with the
2431 // right debug info.
2432 Node* GraphKit::uncommon_trap(int trap_request,
2433 ciKlass* klass, const char* comment,
2434 bool must_throw,
2435 bool keep_exact_action) {
2436 if (failing_internal()) {
2437 stop();
2438 }
2439 if (stopped()) return nullptr; // trap reachable?
2440
2441 // Note: If ProfileTraps is true, and if a deopt. actually
2442 // occurs here, the runtime will make sure an MDO exists. There is
2443 // no need to call method()->ensure_method_data() at this point.
2444
2445 // Set the stack pointer to the right value for reexecution:
2446 set_sp(reexecute_sp());
2447
2448 #ifdef ASSERT
2449 if (!must_throw) {
2450 // Make sure the stack has at least enough depth to execute
2451 // the current bytecode.
2452 int inputs, ignored_depth;
2453 if (compute_stack_effects(inputs, ignored_depth)) {
2454 assert(sp() >= inputs, "must have enough JVMS stack to execute %s: sp=%d, inputs=%d",
2455 Bytecodes::name(java_bc()), sp(), inputs);
2456 }
2457 }
2458 #endif
2459
2460 Deoptimization::DeoptReason reason = Deoptimization::trap_request_reason(trap_request);
2461 Deoptimization::DeoptAction action = Deoptimization::trap_request_action(trap_request);
2462
2463 switch (action) {
2464 case Deoptimization::Action_maybe_recompile:
2465 case Deoptimization::Action_reinterpret:
2466 // Temporary fix for 6529811 to allow virtual calls to be sure they
2467 // get the chance to go from mono->bi->mega
2468 if (!keep_exact_action &&
2469 Deoptimization::trap_request_index(trap_request) < 0 &&
2470 too_many_recompiles(reason)) {
2471 // This BCI is causing too many recompilations.
2472 if (C->log() != nullptr) {
2473 C->log()->elem("observe that='trap_action_change' reason='%s' from='%s' to='none'",
2474 Deoptimization::trap_reason_name(reason),
2475 Deoptimization::trap_action_name(action));
2476 }
2477 action = Deoptimization::Action_none;
2478 trap_request = Deoptimization::make_trap_request(reason, action);
2479 } else {
2480 C->set_trap_can_recompile(true);
2481 }
2482 break;
2483 case Deoptimization::Action_make_not_entrant:
2484 C->set_trap_can_recompile(true);
2485 break;
2486 case Deoptimization::Action_none:
2487 case Deoptimization::Action_make_not_compilable:
2488 break;
2489 default:
2490 #ifdef ASSERT
2491 fatal("unknown action %d: %s", action, Deoptimization::trap_action_name(action));
2492 #endif
2493 break;
2494 }
2495
2496 if (TraceOptoParse) {
2497 char buf[100];
2498 tty->print_cr("Uncommon trap %s at bci:%d",
2499 Deoptimization::format_trap_request(buf, sizeof(buf),
2500 trap_request), bci());
2501 }
2502
2503 CompileLog* log = C->log();
2504 if (log != nullptr) {
2505 int kid = (klass == nullptr)? -1: log->identify(klass);
2506 log->begin_elem("uncommon_trap bci='%d'", bci());
2507 char buf[100];
2508 log->print(" %s", Deoptimization::format_trap_request(buf, sizeof(buf),
2509 trap_request));
2510 if (kid >= 0) log->print(" klass='%d'", kid);
2511 if (comment != nullptr) log->print(" comment='%s'", comment);
2512 log->end_elem();
2513 }
2514
2515 // Make sure any guarding test views this path as very unlikely
2516 Node *i0 = control()->in(0);
2517 if (i0 != nullptr && i0->is_If()) { // Found a guarding if test?
2518 IfNode *iff = i0->as_If();
2519 float f = iff->_prob; // Get prob
2520 if (control()->Opcode() == Op_IfTrue) {
2521 if (f > PROB_UNLIKELY_MAG(4))
2522 iff->_prob = PROB_MIN;
2523 } else {
2524 if (f < PROB_LIKELY_MAG(4))
2525 iff->_prob = PROB_MAX;
2526 }
2527 }
2528
2529 // Clear out dead values from the debug info.
2530 kill_dead_locals();
2531
2532 // Now insert the uncommon trap subroutine call
2533 address call_addr = OptoRuntime::uncommon_trap_blob()->entry_point();
2534 const TypePtr* no_memory_effects = nullptr;
2535 // Pass the index of the class to be loaded
2536 Node* call = make_runtime_call(RC_NO_LEAF | RC_UNCOMMON |
2537 (must_throw ? RC_MUST_THROW : 0),
2538 OptoRuntime::uncommon_trap_Type(),
2539 call_addr, "uncommon_trap", no_memory_effects,
2540 intcon(trap_request));
2541 assert(call->as_CallStaticJava()->uncommon_trap_request() == trap_request,
2542 "must extract request correctly from the graph");
2543 assert(trap_request != 0, "zero value reserved by uncommon_trap_request");
2544
2545 call->set_req(TypeFunc::ReturnAdr, returnadr());
2546 // The debug info is the only real input to this call.
2547
2548 // Halt-and-catch fire here. The above call should never return!
2549 // We only emit code for the HaltNode in debug, which is enough for
2550 // verifying correctness. In product, we don't want to emit it so
2551 // that we can save on code space. HaltNode often get folded because
2552 // the compiler can prove that the unreachable path is dead. But we
2553 // cannot generally expect that for uncommon traps, which are often
2554 // reachable and occasionally taken.
2555 halt(control(), frameptr(),
2556 "uncommon trap returned which should never happen",
2557 false /* don't emit code in product */);
2558 stop_and_kill_map();
2559 return call;
2560 }
2561
2562
2563 //--------------------------just_allocated_object------------------------------
2564 // Report the object that was just allocated.
2565 // It must be the case that there are no intervening safepoints.
2566 // We use this to determine if an object is so "fresh" that
2567 // it does not require card marks.
2568 Node* GraphKit::just_allocated_object(Node* current_control) {
2569 Node* ctrl = current_control;
2570 // Object::<init> is invoked after allocation, most of invoke nodes
2571 // will be reduced, but a region node is kept in parse time, we check
2572 // the pattern and skip the region node if it degraded to a copy.
2573 if (ctrl != nullptr && ctrl->is_Region() && ctrl->req() == 2 &&
2574 ctrl->as_Region()->is_copy()) {
2575 ctrl = ctrl->as_Region()->is_copy();
2576 }
2577 if (C->recent_alloc_ctl() == ctrl) {
2578 return C->recent_alloc_obj();
2579 }
2580 return nullptr;
2581 }
2582
2583
2584 /**
2585 * Record profiling data exact_kls for Node n with the type system so
2586 * that it can propagate it (speculation)
2587 *
2588 * @param n node that the type applies to
2589 * @param exact_kls type from profiling
2590 * @param maybe_null did profiling see null?
2591 *
2592 * @return node with improved type
2593 */
2594 Node* GraphKit::record_profile_for_speculation(Node* n, ciKlass* exact_kls, ProfilePtrKind ptr_kind) {
2595 const Type* current_type = _gvn.type(n);
2596 assert(UseTypeSpeculation, "type speculation must be on");
2597
2598 const TypePtr* speculative = current_type->speculative();
2599
2600 // Should the klass from the profile be recorded in the speculative type?
2601 if (current_type->would_improve_type(exact_kls, jvms()->depth())) {
2602 const TypeKlassPtr* tklass = TypeKlassPtr::make(exact_kls, Type::trust_interfaces);
2603 const TypeOopPtr* xtype = tklass->as_exact_instance_type();
2604 assert(xtype->klass_is_exact(), "Should be exact");
2605 // Any reason to believe n is not null (from this profiling or a previous one)?
2606 assert(ptr_kind != ProfileAlwaysNull, "impossible here");
2607 const TypePtr* ptr = (ptr_kind != ProfileNeverNull && current_type->speculative_maybe_null()) ? TypePtr::BOTTOM : TypePtr::NOTNULL;
2608 // record the new speculative type's depth
2609 speculative = xtype->cast_to_ptr_type(ptr->ptr())->is_ptr();
2610 speculative = speculative->with_inline_depth(jvms()->depth());
2611 } else if (current_type->would_improve_ptr(ptr_kind)) {
2612 // Profiling report that null was never seen so we can change the
2613 // speculative type to non null ptr.
2614 if (ptr_kind == ProfileAlwaysNull) {
2615 speculative = TypePtr::NULL_PTR;
2616 } else {
2617 assert(ptr_kind == ProfileNeverNull, "nothing else is an improvement");
2618 const TypePtr* ptr = TypePtr::NOTNULL;
2619 if (speculative != nullptr) {
2620 speculative = speculative->cast_to_ptr_type(ptr->ptr())->is_ptr();
2621 } else {
2622 speculative = ptr;
2623 }
2624 }
2625 }
2626
2627 if (speculative != current_type->speculative()) {
2628 // Build a type with a speculative type (what we think we know
2629 // about the type but will need a guard when we use it)
2630 const TypeOopPtr* spec_type = TypeOopPtr::make(TypePtr::BotPTR, Type::Offset::bottom, TypeOopPtr::InstanceBot, speculative);
2631 // We're changing the type, we need a new CheckCast node to carry
2632 // the new type. The new type depends on the control: what
2633 // profiling tells us is only valid from here as far as we can
2634 // tell.
2635 Node* cast = new CheckCastPPNode(control(), n, current_type->remove_speculative()->join_speculative(spec_type));
2636 cast = _gvn.transform(cast);
2637 replace_in_map(n, cast);
2638 n = cast;
2639 }
2640
2641 return n;
2642 }
2643
2644 /**
2645 * Record profiling data from receiver profiling at an invoke with the
2646 * type system so that it can propagate it (speculation)
2647 *
2648 * @param n receiver node
2649 *
2650 * @return node with improved type
2651 */
2652 Node* GraphKit::record_profiled_receiver_for_speculation(Node* n) {
2653 if (!UseTypeSpeculation) {
2654 return n;
2655 }
2656 ciKlass* exact_kls = profile_has_unique_klass();
2657 ProfilePtrKind ptr_kind = ProfileMaybeNull;
2658 if ((java_bc() == Bytecodes::_checkcast ||
2659 java_bc() == Bytecodes::_instanceof ||
2660 java_bc() == Bytecodes::_aastore) &&
2661 method()->method_data()->is_mature()) {
2662 ciProfileData* data = method()->method_data()->bci_to_data(bci());
2663 if (data != nullptr) {
2664 if (java_bc() == Bytecodes::_aastore) {
2665 ciKlass* array_type = nullptr;
2666 ciKlass* element_type = nullptr;
2667 ProfilePtrKind element_ptr = ProfileMaybeNull;
2668 bool flat_array = true;
2669 bool null_free_array = true;
2670 method()->array_access_profiled_type(bci(), array_type, element_type, element_ptr, flat_array, null_free_array);
2671 exact_kls = element_type;
2672 ptr_kind = element_ptr;
2673 } else {
2674 if (!data->as_BitData()->null_seen()) {
2675 ptr_kind = ProfileNeverNull;
2676 } else {
2677 if (TypeProfileCasts) {
2678 assert(data->is_ReceiverTypeData(), "bad profile data type");
2679 ciReceiverTypeData* call = (ciReceiverTypeData*)data->as_ReceiverTypeData();
2680 uint i = 0;
2681 for (; i < call->row_limit(); i++) {
2682 ciKlass* receiver = call->receiver(i);
2683 if (receiver != nullptr) {
2684 break;
2685 }
2686 }
2687 ptr_kind = (i == call->row_limit()) ? ProfileAlwaysNull : ProfileMaybeNull;
2688 }
2689 }
2690 }
2691 }
2692 }
2693 return record_profile_for_speculation(n, exact_kls, ptr_kind);
2694 }
2695
2696 /**
2697 * Record profiling data from argument profiling at an invoke with the
2698 * type system so that it can propagate it (speculation)
2699 *
2700 * @param dest_method target method for the call
2701 * @param bc what invoke bytecode is this?
2702 */
2703 void GraphKit::record_profiled_arguments_for_speculation(ciMethod* dest_method, Bytecodes::Code bc) {
2704 if (!UseTypeSpeculation) {
2705 return;
2706 }
2707 const TypeFunc* tf = TypeFunc::make(dest_method);
2708 int nargs = tf->domain_sig()->cnt() - TypeFunc::Parms;
2709 int skip = Bytecodes::has_receiver(bc) ? 1 : 0;
2710 for (int j = skip, i = 0; j < nargs && i < TypeProfileArgsLimit; j++) {
2711 const Type *targ = tf->domain_sig()->field_at(j + TypeFunc::Parms);
2712 if (is_reference_type(targ->basic_type())) {
2713 ProfilePtrKind ptr_kind = ProfileMaybeNull;
2714 ciKlass* better_type = nullptr;
2715 if (method()->argument_profiled_type(bci(), i, better_type, ptr_kind)) {
2716 record_profile_for_speculation(argument(j), better_type, ptr_kind);
2717 }
2718 i++;
2719 }
2720 }
2721 }
2722
2723 /**
2724 * Record profiling data from parameter profiling at an invoke with
2725 * the type system so that it can propagate it (speculation)
2726 */
2727 void GraphKit::record_profiled_parameters_for_speculation() {
2728 if (!UseTypeSpeculation) {
2729 return;
2730 }
2731 for (int i = 0, j = 0; i < method()->arg_size() ; i++) {
2732 if (_gvn.type(local(i))->isa_oopptr()) {
2733 ProfilePtrKind ptr_kind = ProfileMaybeNull;
2734 ciKlass* better_type = nullptr;
2735 if (method()->parameter_profiled_type(j, better_type, ptr_kind)) {
2736 record_profile_for_speculation(local(i), better_type, ptr_kind);
2737 }
2738 j++;
2739 }
2740 }
2741 }
2742
2743 /**
2744 * Record profiling data from return value profiling at an invoke with
2745 * the type system so that it can propagate it (speculation)
2746 */
2747 void GraphKit::record_profiled_return_for_speculation() {
2748 if (!UseTypeSpeculation) {
2749 return;
2750 }
2751 ProfilePtrKind ptr_kind = ProfileMaybeNull;
2752 ciKlass* better_type = nullptr;
2753 if (method()->return_profiled_type(bci(), better_type, ptr_kind)) {
2754 // If profiling reports a single type for the return value,
2755 // feed it to the type system so it can propagate it as a
2756 // speculative type
2757 record_profile_for_speculation(stack(sp()-1), better_type, ptr_kind);
2758 }
2759 }
2760
2761
2762 //=============================================================================
2763 // Generate a fast path/slow path idiom. Graph looks like:
2764 // [foo] indicates that 'foo' is a parameter
2765 //
2766 // [in] null
2767 // \ /
2768 // CmpP
2769 // Bool ne
2770 // If
2771 // / \
2772 // True False-<2>
2773 // / |
2774 // / cast_not_null
2775 // Load | | ^
2776 // [fast_test] | |
2777 // gvn to opt_test | |
2778 // / \ | <1>
2779 // True False |
2780 // | \\ |
2781 // [slow_call] \[fast_result]
2782 // Ctl Val \ \
2783 // | \ \
2784 // Catch <1> \ \
2785 // / \ ^ \ \
2786 // Ex No_Ex | \ \
2787 // | \ \ | \ <2> \
2788 // ... \ [slow_res] | | \ [null_result]
2789 // \ \--+--+--- | |
2790 // \ | / \ | /
2791 // --------Region Phi
2792 //
2793 //=============================================================================
2794 // Code is structured as a series of driver functions all called 'do_XXX' that
2795 // call a set of helper functions. Helper functions first, then drivers.
2796
2797 //------------------------------null_check_oop---------------------------------
2798 // Null check oop. Set null-path control into Region in slot 3.
2799 // Make a cast-not-nullness use the other not-null control. Return cast.
2800 Node* GraphKit::null_check_oop(Node* value, Node* *null_control,
2801 bool never_see_null,
2802 bool safe_for_replace,
2803 bool speculative) {
2804 // Initial null check taken path
2805 (*null_control) = top();
2806 Node* cast = null_check_common(value, T_OBJECT, false, null_control, speculative);
2807
2808 // Generate uncommon_trap:
2809 if (never_see_null && (*null_control) != top()) {
2810 // If we see an unexpected null at a check-cast we record it and force a
2811 // recompile; the offending check-cast will be compiled to handle nulls.
2812 // If we see more than one offending BCI, then all checkcasts in the
2813 // method will be compiled to handle nulls.
2814 PreserveJVMState pjvms(this);
2815 set_control(*null_control);
2816 replace_in_map(value, null());
2817 Deoptimization::DeoptReason reason = Deoptimization::reason_null_check(speculative);
2818 uncommon_trap(reason,
2819 Deoptimization::Action_make_not_entrant);
2820 (*null_control) = top(); // null path is dead
2821 }
2822 if ((*null_control) == top() && safe_for_replace) {
2823 replace_in_map(value, cast);
2824 }
2825
2826 // Cast away null-ness on the result
2827 return cast;
2828 }
2829
2830 //------------------------------opt_iff----------------------------------------
2831 // Optimize the fast-check IfNode. Set the fast-path region slot 2.
2832 // Return slow-path control.
2833 Node* GraphKit::opt_iff(Node* region, Node* iff) {
2834 IfNode *opt_iff = _gvn.transform(iff)->as_If();
2835
2836 // Fast path taken; set region slot 2
2837 Node *fast_taken = _gvn.transform( new IfFalseNode(opt_iff) );
2838 region->init_req(2,fast_taken); // Capture fast-control
2839
2840 // Fast path not-taken, i.e. slow path
2841 Node *slow_taken = _gvn.transform( new IfTrueNode(opt_iff) );
2842 return slow_taken;
2843 }
2844
2845 //-----------------------------make_runtime_call-------------------------------
2846 Node* GraphKit::make_runtime_call(int flags,
2847 const TypeFunc* call_type, address call_addr,
2848 const char* call_name,
2849 const TypePtr* adr_type,
2850 // The following parms are all optional.
2851 // The first null ends the list.
2852 Node* parm0, Node* parm1,
2853 Node* parm2, Node* parm3,
2854 Node* parm4, Node* parm5,
2855 Node* parm6, Node* parm7) {
2856 assert(call_addr != nullptr, "must not call null targets");
2857
2858 // Slow-path call
2859 bool is_leaf = !(flags & RC_NO_LEAF);
2860 bool has_io = (!is_leaf && !(flags & RC_NO_IO));
2861 if (call_name == nullptr) {
2862 assert(!is_leaf, "must supply name for leaf");
2863 call_name = OptoRuntime::stub_name(call_addr);
2864 }
2865 CallNode* call;
2866 if (!is_leaf) {
2867 call = new CallStaticJavaNode(call_type, call_addr, call_name, adr_type);
2868 } else if (flags & RC_NO_FP) {
2869 call = new CallLeafNoFPNode(call_type, call_addr, call_name, adr_type);
2870 } else if (flags & RC_VECTOR){
2871 uint num_bits = call_type->range_sig()->field_at(TypeFunc::Parms)->is_vect()->length_in_bytes() * BitsPerByte;
2872 call = new CallLeafVectorNode(call_type, call_addr, call_name, adr_type, num_bits);
2873 } else if (flags & RC_PURE) {
2874 assert(adr_type == nullptr, "pure call does not touch memory");
2875 call = new CallLeafPureNode(call_type, call_addr, call_name);
2876 } else {
2877 call = new CallLeafNode(call_type, call_addr, call_name, adr_type);
2878 }
2879
2880 // The following is similar to set_edges_for_java_call,
2881 // except that the memory effects of the call are restricted to AliasIdxRaw.
2882
2883 // Slow path call has no side-effects, uses few values
2884 bool wide_in = !(flags & RC_NARROW_MEM);
2885 bool wide_out = (C->get_alias_index(adr_type) == Compile::AliasIdxBot);
2886
2887 Node* prev_mem = nullptr;
2888 if (wide_in) {
2889 prev_mem = set_predefined_input_for_runtime_call(call);
2890 } else {
2891 assert(!wide_out, "narrow in => narrow out");
2892 Node* narrow_mem = memory(adr_type);
2893 prev_mem = set_predefined_input_for_runtime_call(call, narrow_mem);
2894 }
2895
2896 // Hook each parm in order. Stop looking at the first null.
2897 if (parm0 != nullptr) { call->init_req(TypeFunc::Parms+0, parm0);
2898 if (parm1 != nullptr) { call->init_req(TypeFunc::Parms+1, parm1);
2899 if (parm2 != nullptr) { call->init_req(TypeFunc::Parms+2, parm2);
2900 if (parm3 != nullptr) { call->init_req(TypeFunc::Parms+3, parm3);
2901 if (parm4 != nullptr) { call->init_req(TypeFunc::Parms+4, parm4);
2902 if (parm5 != nullptr) { call->init_req(TypeFunc::Parms+5, parm5);
2903 if (parm6 != nullptr) { call->init_req(TypeFunc::Parms+6, parm6);
2904 if (parm7 != nullptr) { call->init_req(TypeFunc::Parms+7, parm7);
2905 /* close each nested if ===> */ } } } } } } } }
2906 assert(call->in(call->req()-1) != nullptr || (call->req()-1) > (TypeFunc::Parms+7), "must initialize all parms");
2907
2908 if (!is_leaf) {
2909 // Non-leaves can block and take safepoints:
2910 add_safepoint_edges(call, ((flags & RC_MUST_THROW) != 0));
2911 }
2912 // Non-leaves can throw exceptions:
2913 if (has_io) {
2914 call->set_req(TypeFunc::I_O, i_o());
2915 }
2916
2917 if (flags & RC_UNCOMMON) {
2918 // Set the count to a tiny probability. Cf. Estimate_Block_Frequency.
2919 // (An "if" probability corresponds roughly to an unconditional count.
2920 // Sort of.)
2921 call->set_cnt(PROB_UNLIKELY_MAG(4));
2922 }
2923
2924 Node* c = _gvn.transform(call);
2925 assert(c == call, "cannot disappear");
2926
2927 if (wide_out) {
2928 // Slow path call has full side-effects.
2929 set_predefined_output_for_runtime_call(call);
2930 } else {
2931 // Slow path call has few side-effects, and/or sets few values.
2932 set_predefined_output_for_runtime_call(call, prev_mem, adr_type);
2933 }
2934
2935 if (has_io) {
2936 set_i_o(_gvn.transform(new ProjNode(call, TypeFunc::I_O)));
2937 }
2938 return call;
2939
2940 }
2941
2942 // i2b
2943 Node* GraphKit::sign_extend_byte(Node* in) {
2944 Node* tmp = _gvn.transform(new LShiftINode(in, _gvn.intcon(24)));
2945 return _gvn.transform(new RShiftINode(tmp, _gvn.intcon(24)));
2946 }
2947
2948 // i2s
2949 Node* GraphKit::sign_extend_short(Node* in) {
2950 Node* tmp = _gvn.transform(new LShiftINode(in, _gvn.intcon(16)));
2951 return _gvn.transform(new RShiftINode(tmp, _gvn.intcon(16)));
2952 }
2953
2954
2955 //------------------------------merge_memory-----------------------------------
2956 // Merge memory from one path into the current memory state.
2957 void GraphKit::merge_memory(Node* new_mem, Node* region, int new_path) {
2958 for (MergeMemStream mms(merged_memory(), new_mem->as_MergeMem()); mms.next_non_empty2(); ) {
2959 Node* old_slice = mms.force_memory();
2960 Node* new_slice = mms.memory2();
2961 if (old_slice != new_slice) {
2962 PhiNode* phi;
2963 if (old_slice->is_Phi() && old_slice->as_Phi()->region() == region) {
2964 if (mms.is_empty()) {
2965 // clone base memory Phi's inputs for this memory slice
2966 assert(old_slice == mms.base_memory(), "sanity");
2967 phi = PhiNode::make(region, nullptr, Type::MEMORY, mms.adr_type(C));
2968 _gvn.set_type(phi, Type::MEMORY);
2969 for (uint i = 1; i < phi->req(); i++) {
2970 phi->init_req(i, old_slice->in(i));
2971 }
2972 } else {
2973 phi = old_slice->as_Phi(); // Phi was generated already
2974 }
2975 } else {
2976 phi = PhiNode::make(region, old_slice, Type::MEMORY, mms.adr_type(C));
2977 _gvn.set_type(phi, Type::MEMORY);
2978 }
2979 phi->set_req(new_path, new_slice);
2980 mms.set_memory(phi);
2981 }
2982 }
2983 }
2984
2985 //------------------------------make_slow_call_ex------------------------------
2986 // Make the exception handler hookups for the slow call
2987 void GraphKit::make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj, bool deoptimize) {
2988 if (stopped()) return;
2989
2990 // Make a catch node with just two handlers: fall-through and catch-all
2991 Node* i_o = _gvn.transform( new ProjNode(call, TypeFunc::I_O, separate_io_proj) );
2992 Node* catc = _gvn.transform( new CatchNode(control(), i_o, 2) );
2993 Node* norm = new CatchProjNode(catc, CatchProjNode::fall_through_index, CatchProjNode::no_handler_bci);
2994 _gvn.set_type_bottom(norm);
2995 C->record_for_igvn(norm);
2996 Node* excp = _gvn.transform( new CatchProjNode(catc, CatchProjNode::catch_all_index, CatchProjNode::no_handler_bci) );
2997
2998 { PreserveJVMState pjvms(this);
2999 set_control(excp);
3000 set_i_o(i_o);
3001
3002 if (excp != top()) {
3003 if (deoptimize) {
3004 // Deoptimize if an exception is caught. Don't construct exception state in this case.
3005 uncommon_trap(Deoptimization::Reason_unhandled,
3006 Deoptimization::Action_none);
3007 } else {
3008 // Create an exception state also.
3009 // Use an exact type if the caller has a specific exception.
3010 const Type* ex_type = TypeOopPtr::make_from_klass_unique(ex_klass)->cast_to_ptr_type(TypePtr::NotNull);
3011 Node* ex_oop = new CreateExNode(ex_type, control(), i_o);
3012 add_exception_state(make_exception_state(_gvn.transform(ex_oop)));
3013 }
3014 }
3015 }
3016
3017 // Get the no-exception control from the CatchNode.
3018 set_control(norm);
3019 }
3020
3021 static IfNode* gen_subtype_check_compare(Node* ctrl, Node* in1, Node* in2, BoolTest::mask test, float p, PhaseGVN& gvn, BasicType bt) {
3022 Node* cmp = nullptr;
3023 switch(bt) {
3024 case T_INT: cmp = new CmpINode(in1, in2); break;
3025 case T_ADDRESS: cmp = new CmpPNode(in1, in2); break;
3026 default: fatal("unexpected comparison type %s", type2name(bt));
3027 }
3028 cmp = gvn.transform(cmp);
3029 Node* bol = gvn.transform(new BoolNode(cmp, test));
3030 IfNode* iff = new IfNode(ctrl, bol, p, COUNT_UNKNOWN);
3031 gvn.transform(iff);
3032 if (!bol->is_Con()) gvn.record_for_igvn(iff);
3033 return iff;
3034 }
3035
3036 //-------------------------------gen_subtype_check-----------------------------
3037 // Generate a subtyping check. Takes as input the subtype and supertype.
3038 // Returns 2 values: sets the default control() to the true path and returns
3039 // the false path. Only reads invariant memory; sets no (visible) memory.
3040 // The PartialSubtypeCheckNode sets the hidden 1-word cache in the encoding
3041 // but that's not exposed to the optimizer. This call also doesn't take in an
3042 // Object; if you wish to check an Object you need to load the Object's class
3043 // prior to coming here.
3044 Node* Phase::gen_subtype_check(Node* subklass, Node* superklass, Node** ctrl, Node* mem, PhaseGVN& gvn,
3045 ciMethod* method, int bci) {
3046 Compile* C = gvn.C;
3047 if ((*ctrl)->is_top()) {
3048 return C->top();
3049 }
3050
3051 const TypeKlassPtr* klass_ptr_type = gvn.type(superklass)->is_klassptr();
3052 // For a direct pointer comparison, we need the refined array klass pointer
3053 Node* vm_superklass = superklass;
3054 if (klass_ptr_type->isa_aryklassptr() && klass_ptr_type->klass_is_exact()) {
3055 assert(!klass_ptr_type->is_aryklassptr()->is_refined_type(), "Unexpected refined array klass pointer");
3056 vm_superklass = gvn.makecon(klass_ptr_type->is_aryklassptr()->cast_to_refined_array_klass_ptr());
3057 }
3058
3059 // Fast check for identical types, perhaps identical constants.
3060 // The types can even be identical non-constants, in cases
3061 // involving Array.newInstance, Object.clone, etc.
3062 if (subklass == superklass)
3063 return C->top(); // false path is dead; no test needed.
3064
3065 if (gvn.type(superklass)->singleton()) {
3066 const TypeKlassPtr* superk = gvn.type(superklass)->is_klassptr();
3067 const TypeKlassPtr* subk = gvn.type(subklass)->is_klassptr();
3068
3069 // In the common case of an exact superklass, try to fold up the
3070 // test before generating code. You may ask, why not just generate
3071 // the code and then let it fold up? The answer is that the generated
3072 // code will necessarily include null checks, which do not always
3073 // completely fold away. If they are also needless, then they turn
3074 // into a performance loss. Example:
3075 // Foo[] fa = blah(); Foo x = fa[0]; fa[1] = x;
3076 // Here, the type of 'fa' is often exact, so the store check
3077 // of fa[1]=x will fold up, without testing the nullness of x.
3078 //
3079 // At macro expansion, we would have already folded the SubTypeCheckNode
3080 // being expanded here because we always perform the static sub type
3081 // check in SubTypeCheckNode::sub() regardless of whether
3082 // StressReflectiveCode is set or not. We can therefore skip this
3083 // static check when StressReflectiveCode is on.
3084 switch (C->static_subtype_check(superk, subk)) {
3085 case Compile::SSC_always_false:
3086 {
3087 Node* always_fail = *ctrl;
3088 *ctrl = gvn.C->top();
3089 return always_fail;
3090 }
3091 case Compile::SSC_always_true:
3092 return C->top();
3093 case Compile::SSC_easy_test:
3094 {
3095 // Just do a direct pointer compare and be done.
3096 IfNode* iff = gen_subtype_check_compare(*ctrl, subklass, vm_superklass, BoolTest::eq, PROB_STATIC_FREQUENT, gvn, T_ADDRESS);
3097 *ctrl = gvn.transform(new IfTrueNode(iff));
3098 return gvn.transform(new IfFalseNode(iff));
3099 }
3100 case Compile::SSC_full_test:
3101 break;
3102 default:
3103 ShouldNotReachHere();
3104 }
3105 }
3106
3107 // %%% Possible further optimization: Even if the superklass is not exact,
3108 // if the subklass is the unique subtype of the superklass, the check
3109 // will always succeed. We could leave a dependency behind to ensure this.
3110
3111 // First load the super-klass's check-offset
3112 Node* p1 = gvn.transform(AddPNode::make_off_heap(superklass, gvn.MakeConX(in_bytes(Klass::super_check_offset_offset()))));
3113 Node* m = C->immutable_memory();
3114 Node* chk_off = gvn.transform(new LoadINode(nullptr, m, p1, gvn.type(p1)->is_ptr(), TypeInt::INT, MemNode::unordered));
3115 int cacheoff_con = in_bytes(Klass::secondary_super_cache_offset());
3116 const TypeInt* chk_off_t = chk_off->Value(&gvn)->isa_int();
3117 int chk_off_con = (chk_off_t != nullptr && chk_off_t->is_con()) ? chk_off_t->get_con() : cacheoff_con;
3118 bool might_be_cache = (chk_off_con == cacheoff_con);
3119
3120 // Load from the sub-klass's super-class display list, or a 1-word cache of
3121 // the secondary superclass list, or a failing value with a sentinel offset
3122 // if the super-klass is an interface or exceptionally deep in the Java
3123 // hierarchy and we have to scan the secondary superclass list the hard way.
3124 // Worst-case type is a little odd: null is allowed as a result (usually
3125 // klass loads can never produce a null).
3126 Node *chk_off_X = chk_off;
3127 #ifdef _LP64
3128 chk_off_X = gvn.transform(new ConvI2LNode(chk_off_X));
3129 #endif
3130 Node* p2 = gvn.transform(AddPNode::make_off_heap(subklass, chk_off_X));
3131 // For some types like interfaces the following loadKlass is from a 1-word
3132 // cache which is mutable so can't use immutable memory. Other
3133 // types load from the super-class display table which is immutable.
3134 Node* kmem = C->immutable_memory();
3135 // secondary_super_cache is not immutable but can be treated as such because:
3136 // - no ideal node writes to it in a way that could cause an
3137 // incorrect/missed optimization of the following Load.
3138 // - it's a cache so, worse case, not reading the latest value
3139 // wouldn't cause incorrect execution
3140 if (might_be_cache && mem != nullptr) {
3141 kmem = mem->is_MergeMem() ? mem->as_MergeMem()->memory_at(C->get_alias_index(gvn.type(p2)->is_ptr())) : mem;
3142 }
3143 Node* nkls = gvn.transform(LoadKlassNode::make(gvn, kmem, p2, gvn.type(p2)->is_ptr(), TypeInstKlassPtr::OBJECT_OR_NULL));
3144
3145 // Compile speed common case: ARE a subtype and we canNOT fail
3146 if (superklass == nkls) {
3147 return C->top(); // false path is dead; no test needed.
3148 }
3149
3150 // Gather the various success & failures here
3151 RegionNode* r_not_subtype = new RegionNode(3);
3152 gvn.record_for_igvn(r_not_subtype);
3153 RegionNode* r_ok_subtype = new RegionNode(4);
3154 gvn.record_for_igvn(r_ok_subtype);
3155
3156 // If we might perform an expensive check, first try to take advantage of profile data that was attached to the
3157 // SubTypeCheck node
3158 if (might_be_cache && method != nullptr && VM_Version::profile_all_receivers_at_type_check()) {
3159 ciCallProfile profile = method->call_profile_at_bci(bci);
3160 float total_prob = 0;
3161 for (int i = 0; profile.has_receiver(i); ++i) {
3162 float prob = profile.receiver_prob(i);
3163 total_prob += prob;
3164 }
3165 if (total_prob * 100. >= TypeProfileSubTypeCheckCommonThreshold) {
3166 const TypeKlassPtr* superk = gvn.type(superklass)->is_klassptr();
3167 for (int i = 0; profile.has_receiver(i); ++i) {
3168 ciKlass* klass = profile.receiver(i);
3169 const TypeKlassPtr* klass_t = TypeKlassPtr::make(klass);
3170 Compile::SubTypeCheckResult result = C->static_subtype_check(superk, klass_t);
3171 if (result != Compile::SSC_always_true && result != Compile::SSC_always_false) {
3172 continue;
3173 }
3174 if (klass_t->isa_aryklassptr()) {
3175 // For a direct pointer comparison, we need the refined array klass pointer
3176 klass_t = klass_t->is_aryklassptr()->cast_to_refined_array_klass_ptr();
3177 }
3178 float prob = profile.receiver_prob(i);
3179 ConNode* klass_node = gvn.makecon(klass_t);
3180 IfNode* iff = gen_subtype_check_compare(*ctrl, subklass, klass_node, BoolTest::eq, prob, gvn, T_ADDRESS);
3181 Node* iftrue = gvn.transform(new IfTrueNode(iff));
3182
3183 if (result == Compile::SSC_always_true) {
3184 r_ok_subtype->add_req(iftrue);
3185 } else {
3186 assert(result == Compile::SSC_always_false, "");
3187 r_not_subtype->add_req(iftrue);
3188 }
3189 *ctrl = gvn.transform(new IfFalseNode(iff));
3190 }
3191 }
3192 }
3193
3194 // See if we get an immediate positive hit. Happens roughly 83% of the
3195 // time. Test to see if the value loaded just previously from the subklass
3196 // is exactly the superklass.
3197 IfNode *iff1 = gen_subtype_check_compare(*ctrl, superklass, nkls, BoolTest::eq, PROB_LIKELY(0.83f), gvn, T_ADDRESS);
3198 Node *iftrue1 = gvn.transform( new IfTrueNode (iff1));
3199 *ctrl = gvn.transform(new IfFalseNode(iff1));
3200
3201 // Compile speed common case: Check for being deterministic right now. If
3202 // chk_off is a constant and not equal to cacheoff then we are NOT a
3203 // subklass. In this case we need exactly the 1 test above and we can
3204 // return those results immediately.
3205 if (!might_be_cache) {
3206 Node* not_subtype_ctrl = *ctrl;
3207 *ctrl = iftrue1; // We need exactly the 1 test above
3208 PhaseIterGVN* igvn = gvn.is_IterGVN();
3209 if (igvn != nullptr) {
3210 igvn->remove_globally_dead_node(r_ok_subtype, PhaseIterGVN::NodeOrigin::Speculative);
3211 igvn->remove_globally_dead_node(r_not_subtype, PhaseIterGVN::NodeOrigin::Speculative);
3212 }
3213 return not_subtype_ctrl;
3214 }
3215
3216 r_ok_subtype->init_req(1, iftrue1);
3217
3218 // Check for immediate negative hit. Happens roughly 11% of the time (which
3219 // is roughly 63% of the remaining cases). Test to see if the loaded
3220 // check-offset points into the subklass display list or the 1-element
3221 // cache. If it points to the display (and NOT the cache) and the display
3222 // missed then it's not a subtype.
3223 Node *cacheoff = gvn.intcon(cacheoff_con);
3224 IfNode *iff2 = gen_subtype_check_compare(*ctrl, chk_off, cacheoff, BoolTest::ne, PROB_LIKELY(0.63f), gvn, T_INT);
3225 r_not_subtype->init_req(1, gvn.transform(new IfTrueNode (iff2)));
3226 *ctrl = gvn.transform(new IfFalseNode(iff2));
3227
3228 // Check for self. Very rare to get here, but it is taken 1/3 the time.
3229 // No performance impact (too rare) but allows sharing of secondary arrays
3230 // which has some footprint reduction.
3231 IfNode *iff3 = gen_subtype_check_compare(*ctrl, subklass, vm_superklass, BoolTest::eq, PROB_LIKELY(0.36f), gvn, T_ADDRESS);
3232 r_ok_subtype->init_req(2, gvn.transform(new IfTrueNode(iff3)));
3233 *ctrl = gvn.transform(new IfFalseNode(iff3));
3234
3235 // -- Roads not taken here: --
3236 // We could also have chosen to perform the self-check at the beginning
3237 // of this code sequence, as the assembler does. This would not pay off
3238 // the same way, since the optimizer, unlike the assembler, can perform
3239 // static type analysis to fold away many successful self-checks.
3240 // Non-foldable self checks work better here in second position, because
3241 // the initial primary superclass check subsumes a self-check for most
3242 // types. An exception would be a secondary type like array-of-interface,
3243 // which does not appear in its own primary supertype display.
3244 // Finally, we could have chosen to move the self-check into the
3245 // PartialSubtypeCheckNode, and from there out-of-line in a platform
3246 // dependent manner. But it is worthwhile to have the check here,
3247 // where it can be perhaps be optimized. The cost in code space is
3248 // small (register compare, branch).
3249
3250 // Now do a linear scan of the secondary super-klass array. Again, no real
3251 // performance impact (too rare) but it's gotta be done.
3252 // Since the code is rarely used, there is no penalty for moving it
3253 // out of line, and it can only improve I-cache density.
3254 // The decision to inline or out-of-line this final check is platform
3255 // dependent, and is found in the AD file definition of PartialSubtypeCheck.
3256 Node* psc = gvn.transform(
3257 new PartialSubtypeCheckNode(*ctrl, subklass, superklass));
3258
3259 IfNode *iff4 = gen_subtype_check_compare(*ctrl, psc, gvn.zerocon(T_OBJECT), BoolTest::ne, PROB_FAIR, gvn, T_ADDRESS);
3260 r_not_subtype->init_req(2, gvn.transform(new IfTrueNode (iff4)));
3261 r_ok_subtype ->init_req(3, gvn.transform(new IfFalseNode(iff4)));
3262
3263 // Return false path; set default control to true path.
3264 *ctrl = gvn.transform(r_ok_subtype);
3265 return gvn.transform(r_not_subtype);
3266 }
3267
3268 Node* GraphKit::gen_subtype_check(Node* obj_or_subklass, Node* superklass) {
3269 const Type* sub_t = _gvn.type(obj_or_subklass);
3270 if (sub_t->make_oopptr() != nullptr && sub_t->make_oopptr()->is_inlinetypeptr()) {
3271 sub_t = TypeKlassPtr::make(sub_t->inline_klass());
3272 obj_or_subklass = makecon(sub_t);
3273 }
3274 bool expand_subtype_check = C->post_loop_opts_phase(); // macro node expansion is over
3275 if (expand_subtype_check) {
3276 MergeMemNode* mem = merged_memory();
3277 Node* ctrl = control();
3278 Node* subklass = obj_or_subklass;
3279 if (!sub_t->isa_klassptr()) {
3280 subklass = load_object_klass(obj_or_subklass);
3281 }
3282
3283 Node* n = Phase::gen_subtype_check(subklass, superklass, &ctrl, mem, _gvn, method(), bci());
3284 set_control(ctrl);
3285 return n;
3286 }
3287
3288 Node* check = _gvn.transform(new SubTypeCheckNode(C, obj_or_subklass, superklass, method(), bci()));
3289 Node* bol = _gvn.transform(new BoolNode(check, BoolTest::eq));
3290 IfNode* iff = create_and_xform_if(control(), bol, PROB_STATIC_FREQUENT, COUNT_UNKNOWN);
3291 set_control(_gvn.transform(new IfTrueNode(iff)));
3292 return _gvn.transform(new IfFalseNode(iff));
3293 }
3294
3295 // Profile-driven exact type check:
3296 Node* GraphKit::type_check_receiver(Node* receiver, ciKlass* klass,
3297 float prob, Node* *casted_receiver) {
3298 assert(!klass->is_interface(), "no exact type check on interfaces");
3299 Node* fail = top();
3300 const Type* rec_t = _gvn.type(receiver);
3301 if (rec_t->is_inlinetypeptr()) {
3302 if (klass->equals(rec_t->inline_klass())) {
3303 (*casted_receiver) = receiver; // Always passes
3304 } else {
3305 (*casted_receiver) = top(); // Always fails
3306 fail = control();
3307 set_control(top());
3308 }
3309 return fail;
3310 }
3311 const TypeKlassPtr* tklass = TypeKlassPtr::make(klass, Type::trust_interfaces);
3312 if (tklass->isa_aryklassptr()) {
3313 // For a direct pointer comparison, we need the refined array klass pointer
3314 tklass = tklass->is_aryklassptr()->cast_to_refined_array_klass_ptr();
3315 }
3316 Node* recv_klass = load_object_klass(receiver);
3317 fail = type_check(recv_klass, tklass, prob);
3318
3319 if (!stopped()) {
3320 const TypeOopPtr* receiver_type = _gvn.type(receiver)->isa_oopptr();
3321 const TypeOopPtr* recv_xtype = tklass->as_exact_instance_type();
3322 assert(recv_xtype->klass_is_exact(), "");
3323
3324 if (!receiver_type->higher_equal(recv_xtype)) { // ignore redundant casts
3325 // Subsume downstream occurrences of receiver with a cast to
3326 // recv_xtype, since now we know what the type will be.
3327 Node* cast = new CheckCastPPNode(control(), receiver, recv_xtype);
3328 Node* res = _gvn.transform(cast);
3329 if (recv_xtype->is_inlinetypeptr()) {
3330 assert(!gvn().type(res)->maybe_null(), "receiver should never be null");
3331 res = InlineTypeNode::make_from_oop(this, res, recv_xtype->inline_klass());
3332 }
3333 (*casted_receiver) = res;
3334 assert(!(*casted_receiver)->is_top(), "that path should be unreachable");
3335 // (User must make the replace_in_map call.)
3336 }
3337 }
3338
3339 return fail;
3340 }
3341
3342 Node* GraphKit::type_check(Node* recv_klass, const TypeKlassPtr* tklass,
3343 float prob) {
3344 Node* want_klass = makecon(tklass);
3345 Node* cmp = _gvn.transform(new CmpPNode(recv_klass, want_klass));
3346 Node* bol = _gvn.transform(new BoolNode(cmp, BoolTest::eq));
3347 IfNode* iff = create_and_xform_if(control(), bol, prob, COUNT_UNKNOWN);
3348 set_control(_gvn.transform(new IfTrueNode (iff)));
3349 Node* fail = _gvn.transform(new IfFalseNode(iff));
3350 return fail;
3351 }
3352
3353 //------------------------------subtype_check_receiver-------------------------
3354 Node* GraphKit::subtype_check_receiver(Node* receiver, ciKlass* klass,
3355 Node** casted_receiver) {
3356 const TypeKlassPtr* tklass = TypeKlassPtr::make(klass, Type::trust_interfaces)->try_improve();
3357 Node* want_klass = makecon(tklass);
3358
3359 Node* slow_ctl = gen_subtype_check(receiver, want_klass);
3360
3361 // Ignore interface type information until interface types are properly tracked.
3362 if (!stopped() && !klass->is_interface()) {
3363 const TypeOopPtr* receiver_type = _gvn.type(receiver)->isa_oopptr();
3364 const TypeOopPtr* recv_type = tklass->as_subtype_instance_type();
3365 if (receiver_type != nullptr && !receiver_type->higher_equal(recv_type)) { // ignore redundant casts
3366 Node* cast = _gvn.transform(new CheckCastPPNode(control(), receiver, recv_type));
3367 if (recv_type->is_inlinetypeptr()) {
3368 cast = InlineTypeNode::make_from_oop(this, cast, recv_type->inline_klass());
3369 }
3370 (*casted_receiver) = cast;
3371 }
3372 }
3373
3374 return slow_ctl;
3375 }
3376
3377 //------------------------------seems_never_null-------------------------------
3378 // Use null_seen information if it is available from the profile.
3379 // If we see an unexpected null at a type check we record it and force a
3380 // recompile; the offending check will be recompiled to handle nulls.
3381 // If we see several offending BCIs, then all checks in the
3382 // method will be recompiled.
3383 bool GraphKit::seems_never_null(Node* obj, ciProfileData* data, bool& speculating) {
3384 speculating = !_gvn.type(obj)->speculative_maybe_null();
3385 Deoptimization::DeoptReason reason = Deoptimization::reason_null_check(speculating);
3386 if (UncommonNullCast // Cutout for this technique
3387 && obj != null() // And not the -Xcomp stupid case?
3388 && !too_many_traps(reason)
3389 ) {
3390 if (speculating) {
3391 return true;
3392 }
3393 if (data == nullptr)
3394 // Edge case: no mature data. Be optimistic here.
3395 return true;
3396 // If the profile has not seen a null, assume it won't happen.
3397 assert(java_bc() == Bytecodes::_checkcast ||
3398 java_bc() == Bytecodes::_instanceof ||
3399 java_bc() == Bytecodes::_aastore, "MDO must collect null_seen bit here");
3400 return !data->as_BitData()->null_seen();
3401 }
3402 speculating = false;
3403 return false;
3404 }
3405
3406 void GraphKit::guard_klass_being_initialized(Node* klass) {
3407 int init_state_off = in_bytes(InstanceKlass::init_state_offset());
3408 Node* adr = off_heap_plus_addr(klass, init_state_off);
3409 Node* init_state = LoadNode::make(_gvn, nullptr, immutable_memory(), adr,
3410 adr->bottom_type()->is_ptr(), TypeInt::BYTE,
3411 T_BYTE, MemNode::acquire);
3412 init_state = _gvn.transform(init_state);
3413
3414 Node* being_initialized_state = makecon(TypeInt::make(InstanceKlass::being_initialized));
3415
3416 Node* chk = _gvn.transform(new CmpINode(being_initialized_state, init_state));
3417 Node* tst = _gvn.transform(new BoolNode(chk, BoolTest::eq));
3418
3419 { BuildCutout unless(this, tst, PROB_MAX);
3420 uncommon_trap(Deoptimization::Reason_initialized, Deoptimization::Action_reinterpret);
3421 }
3422 }
3423
3424 void GraphKit::guard_init_thread(Node* klass) {
3425 int init_thread_off = in_bytes(InstanceKlass::init_thread_offset());
3426 Node* adr = off_heap_plus_addr(klass, init_thread_off);
3427
3428 Node* init_thread = LoadNode::make(_gvn, nullptr, immutable_memory(), adr,
3429 adr->bottom_type()->is_ptr(), TypePtr::NOTNULL,
3430 T_ADDRESS, MemNode::unordered);
3431 init_thread = _gvn.transform(init_thread);
3432
3433 Node* cur_thread = _gvn.transform(new ThreadLocalNode());
3434
3435 Node* chk = _gvn.transform(new CmpPNode(cur_thread, init_thread));
3436 Node* tst = _gvn.transform(new BoolNode(chk, BoolTest::eq));
3437
3438 { BuildCutout unless(this, tst, PROB_MAX);
3439 uncommon_trap(Deoptimization::Reason_uninitialized, Deoptimization::Action_none);
3440 }
3441 }
3442
3443 void GraphKit::clinit_barrier(ciInstanceKlass* ik, ciMethod* context) {
3444 if (ik->is_being_initialized()) {
3445 if (C->needs_clinit_barrier(ik, context)) {
3446 Node* klass = makecon(TypeKlassPtr::make(ik));
3447 guard_klass_being_initialized(klass);
3448 guard_init_thread(klass);
3449 insert_mem_bar(Op_MemBarCPUOrder);
3450 }
3451 } else if (ik->is_initialized()) {
3452 return; // no barrier needed
3453 } else {
3454 uncommon_trap(Deoptimization::Reason_uninitialized,
3455 Deoptimization::Action_reinterpret,
3456 nullptr);
3457 }
3458 }
3459
3460 //------------------------maybe_cast_profiled_receiver-------------------------
3461 // If the profile has seen exactly one type, narrow to exactly that type.
3462 // Subsequent type checks will always fold up.
3463 Node* GraphKit::maybe_cast_profiled_receiver(Node* not_null_obj,
3464 const TypeKlassPtr* require_klass,
3465 ciKlass* spec_klass,
3466 bool safe_for_replace) {
3467 if (!UseTypeProfile || !TypeProfileCasts) return nullptr;
3468
3469 Deoptimization::DeoptReason reason = Deoptimization::reason_class_check(spec_klass != nullptr);
3470
3471 // Make sure we haven't already deoptimized from this tactic.
3472 if (too_many_traps_or_recompiles(reason))
3473 return nullptr;
3474
3475 // (No, this isn't a call, but it's enough like a virtual call
3476 // to use the same ciMethod accessor to get the profile info...)
3477 // If we have a speculative type use it instead of profiling (which
3478 // may not help us)
3479 ciKlass* exact_kls = spec_klass;
3480 if (exact_kls == nullptr) {
3481 if (java_bc() == Bytecodes::_aastore) {
3482 ciKlass* array_type = nullptr;
3483 ciKlass* element_type = nullptr;
3484 ProfilePtrKind element_ptr = ProfileMaybeNull;
3485 bool flat_array = true;
3486 bool null_free_array = true;
3487 method()->array_access_profiled_type(bci(), array_type, element_type, element_ptr, flat_array, null_free_array);
3488 exact_kls = element_type;
3489 } else {
3490 exact_kls = profile_has_unique_klass();
3491 }
3492 }
3493 if (exact_kls != nullptr) {// no cast failures here
3494 if (require_klass == nullptr ||
3495 C->static_subtype_check(require_klass, TypeKlassPtr::make(exact_kls, Type::trust_interfaces)) == Compile::SSC_always_true) {
3496 // If we narrow the type to match what the type profile sees or
3497 // the speculative type, we can then remove the rest of the
3498 // cast.
3499 // This is a win, even if the exact_kls is very specific,
3500 // because downstream operations, such as method calls,
3501 // will often benefit from the sharper type.
3502 Node* exact_obj = not_null_obj; // will get updated in place...
3503 Node* slow_ctl = type_check_receiver(exact_obj, exact_kls, 1.0,
3504 &exact_obj);
3505 { PreserveJVMState pjvms(this);
3506 set_control(slow_ctl);
3507 uncommon_trap_exact(reason, Deoptimization::Action_maybe_recompile);
3508 }
3509 if (safe_for_replace) {
3510 replace_in_map(not_null_obj, exact_obj);
3511 }
3512 return exact_obj;
3513 }
3514 // assert(ssc == Compile::SSC_always_true)... except maybe the profile lied to us.
3515 }
3516
3517 return nullptr;
3518 }
3519
3520 /**
3521 * Cast obj to type and emit guard unless we had too many traps here
3522 * already
3523 *
3524 * @param obj node being casted
3525 * @param type type to cast the node to
3526 * @param not_null true if we know node cannot be null
3527 */
3528 Node* GraphKit::maybe_cast_profiled_obj(Node* obj,
3529 ciKlass* type,
3530 bool not_null) {
3531 if (stopped()) {
3532 return obj;
3533 }
3534
3535 // type is null if profiling tells us this object is always null
3536 if (type != nullptr) {
3537 Deoptimization::DeoptReason class_reason = Deoptimization::Reason_speculate_class_check;
3538 Deoptimization::DeoptReason null_reason = Deoptimization::Reason_speculate_null_check;
3539
3540 if (!too_many_traps_or_recompiles(null_reason) &&
3541 !too_many_traps_or_recompiles(class_reason)) {
3542 Node* not_null_obj = nullptr;
3543 // not_null is true if we know the object is not null and
3544 // there's no need for a null check
3545 if (!not_null) {
3546 Node* null_ctl = top();
3547 not_null_obj = null_check_oop(obj, &null_ctl, true, true, true);
3548 assert(null_ctl->is_top(), "no null control here");
3549 } else {
3550 not_null_obj = obj;
3551 }
3552
3553 Node* exact_obj = not_null_obj;
3554 ciKlass* exact_kls = type;
3555 Node* slow_ctl = type_check_receiver(exact_obj, exact_kls, 1.0,
3556 &exact_obj);
3557 {
3558 PreserveJVMState pjvms(this);
3559 set_control(slow_ctl);
3560 uncommon_trap_exact(class_reason, Deoptimization::Action_maybe_recompile);
3561 }
3562 replace_in_map(not_null_obj, exact_obj);
3563 obj = exact_obj;
3564 }
3565 } else {
3566 if (!too_many_traps_or_recompiles(Deoptimization::Reason_null_assert)) {
3567 Node* exact_obj = null_assert(obj);
3568 replace_in_map(obj, exact_obj);
3569 obj = exact_obj;
3570 }
3571 }
3572 return obj;
3573 }
3574
3575 //-------------------------------gen_instanceof--------------------------------
3576 // Generate an instance-of idiom. Used by both the instance-of bytecode
3577 // and the reflective instance-of call.
3578 Node* GraphKit::gen_instanceof(Node* obj, Node* superklass, bool safe_for_replace) {
3579 kill_dead_locals(); // Benefit all the uncommon traps
3580 assert( !stopped(), "dead parse path should be checked in callers" );
3581 const TypeKlassPtr* klass_ptr_type = _gvn.type(superklass)->isa_klassptr();
3582 assert(klass_ptr_type != nullptr && !TypePtr::NULL_PTR->higher_equal(klass_ptr_type),
3583 "must check for not-null not-dead klass in callers");
3584 const TypeKlassPtr* improved_klass_ptr_type = klass_ptr_type->try_improve();
3585 // Make the merge point
3586 enum { _obj_path = 1, _fail_path, _null_path, PATH_LIMIT };
3587 RegionNode* region = new RegionNode(PATH_LIMIT);
3588 Node* phi = new PhiNode(region, TypeInt::BOOL);
3589 C->set_has_split_ifs(true); // Has chance for split-if optimization
3590
3591 ciProfileData* data = nullptr;
3592 if (java_bc() == Bytecodes::_instanceof) { // Only for the bytecode
3593 data = method()->method_data()->bci_to_data(bci());
3594 }
3595 bool speculative_not_null = false;
3596 bool never_see_null = (ProfileDynamicTypes // aggressive use of profile
3597 && seems_never_null(obj, data, speculative_not_null));
3598
3599 // Null check; get casted pointer; set region slot 3
3600 Node* null_ctl = top();
3601 Node* not_null_obj = null_check_oop(obj, &null_ctl, never_see_null, safe_for_replace, speculative_not_null);
3602
3603 // If not_null_obj is dead, only null-path is taken
3604 if (stopped()) { // Doing instance-of on a null?
3605 set_control(null_ctl);
3606 return intcon(0);
3607 }
3608 region->init_req(_null_path, null_ctl);
3609 phi ->init_req(_null_path, intcon(0)); // Set null path value
3610 if (null_ctl == top()) {
3611 // Do this eagerly, so that pattern matches like is_diamond_phi
3612 // will work even during parsing.
3613 assert(_null_path == PATH_LIMIT-1, "delete last");
3614 region->del_req(_null_path);
3615 phi ->del_req(_null_path);
3616 }
3617
3618 // Do we know the type check always succeed?
3619 bool known_statically = false;
3620 if (improved_klass_ptr_type->singleton()) {
3621 const TypeKlassPtr* subk = _gvn.type(obj)->is_oopptr()->as_klass_type();
3622 if (subk != nullptr && subk->is_loaded()) {
3623 int static_res = C->static_subtype_check(improved_klass_ptr_type, subk);
3624 known_statically = (static_res == Compile::SSC_always_true || static_res == Compile::SSC_always_false);
3625 }
3626 }
3627
3628 if (!known_statically) {
3629 const TypeOopPtr* obj_type = _gvn.type(obj)->is_oopptr();
3630 // We may not have profiling here or it may not help us. If we
3631 // have a speculative type use it to perform an exact cast.
3632 ciKlass* spec_obj_type = obj_type->speculative_type();
3633 if (spec_obj_type != nullptr || (ProfileDynamicTypes && data != nullptr)) {
3634 Node* cast_obj = maybe_cast_profiled_receiver(not_null_obj, nullptr, spec_obj_type, safe_for_replace);
3635 if (stopped()) { // Profile disagrees with this path.
3636 set_control(null_ctl); // Null is the only remaining possibility.
3637 return intcon(0);
3638 }
3639 if (cast_obj != nullptr) {
3640 not_null_obj = cast_obj;
3641 }
3642 }
3643 }
3644
3645 // Generate the subtype check
3646 Node* improved_superklass = superklass;
3647 if (improved_klass_ptr_type != klass_ptr_type && improved_klass_ptr_type->singleton()) {
3648 improved_superklass = makecon(improved_klass_ptr_type);
3649 }
3650 Node* not_subtype_ctrl = gen_subtype_check(not_null_obj, improved_superklass);
3651
3652 // Plug in the success path to the general merge in slot 1.
3653 region->init_req(_obj_path, control());
3654 phi ->init_req(_obj_path, intcon(1));
3655
3656 // Plug in the failing path to the general merge in slot 2.
3657 region->init_req(_fail_path, not_subtype_ctrl);
3658 phi ->init_req(_fail_path, intcon(0));
3659
3660 // Return final merged results
3661 set_control( _gvn.transform(region) );
3662 record_for_igvn(region);
3663
3664 // If we know the type check always succeeds then we don't use the
3665 // profiling data at this bytecode. Don't lose it, feed it to the
3666 // type system as a speculative type.
3667 if (safe_for_replace) {
3668 Node* casted_obj = record_profiled_receiver_for_speculation(obj);
3669 replace_in_map(obj, casted_obj);
3670 }
3671
3672 return _gvn.transform(phi);
3673 }
3674
3675 //-------------------------------gen_checkcast---------------------------------
3676 // Generate a checkcast idiom. Used by both the checkcast bytecode and the
3677 // array store bytecode. Stack must be as-if BEFORE doing the bytecode so the
3678 // uncommon-trap paths work. Adjust stack after this call.
3679 // If failure_control is supplied and not null, it is filled in with
3680 // the control edge for the cast failure. Otherwise, an appropriate
3681 // uncommon trap or exception is thrown.
3682 // If 'new_cast_failure_map' is supplied and is not null, it is set to a newly cloned map
3683 // when the current map for the success path is updated with information only present
3684 // on the success path and not the cast failure path. The newly cloned map should then be
3685 // used to emit the uncommon trap in the caller.
3686 Node* GraphKit::gen_checkcast(Node* obj, Node* superklass, Node** failure_control, SafePointNode** new_cast_failure_map, bool null_free, bool maybe_larval) {
3687 assert(new_cast_failure_map == nullptr || failure_control != nullptr,
3688 "failure_control must be set when new_failure_map is used");
3689 kill_dead_locals(); // Benefit all the uncommon traps
3690 const TypeKlassPtr* klass_ptr_type = _gvn.type(superklass)->is_klassptr();
3691 const Type* obj_type = _gvn.type(obj);
3692
3693 const TypeKlassPtr* improved_klass_ptr_type = klass_ptr_type->try_improve();
3694 const TypeOopPtr* toop = improved_klass_ptr_type->as_subtype_instance_type();
3695 bool safe_for_replace = (failure_control == nullptr);
3696 assert(!null_free || toop->can_be_inline_type(), "must be an inline type pointer");
3697
3698 // Fast cutout: Check the case that the cast is vacuously true.
3699 // This detects the common cases where the test will short-circuit
3700 // away completely. We do this before we perform the null check,
3701 // because if the test is going to turn into zero code, we don't
3702 // want a residual null check left around. (Causes a slowdown,
3703 // for example, in some objArray manipulations, such as a[i]=a[j].)
3704 if (improved_klass_ptr_type->singleton()) {
3705 const TypeKlassPtr* kptr = nullptr;
3706 if (obj_type->isa_oop_ptr()) {
3707 kptr = obj_type->is_oopptr()->as_klass_type();
3708 } else if (obj->is_InlineType()) {
3709 ciInlineKlass* vk = obj_type->inline_klass();
3710 kptr = TypeInstKlassPtr::make(TypePtr::NotNull, vk, Type::Offset(0));
3711 }
3712
3713 if (kptr != nullptr) {
3714 switch (C->static_subtype_check(improved_klass_ptr_type, kptr)) {
3715 case Compile::SSC_always_true:
3716 // If we know the type check always succeed then we don't use
3717 // the profiling data at this bytecode. Don't lose it, feed it
3718 // to the type system as a speculative type.
3719 obj = record_profiled_receiver_for_speculation(obj);
3720 if (null_free) {
3721 assert(safe_for_replace, "must be");
3722 obj = null_check(obj);
3723 }
3724 return obj;
3725 case Compile::SSC_always_false:
3726 if (null_free) {
3727 assert(safe_for_replace, "must be");
3728 obj = null_check(obj);
3729 }
3730 // It needs a null check because a null will *pass* the cast check.
3731 if (obj_type->isa_oopptr() != nullptr && !obj_type->is_oopptr()->maybe_null()) {
3732 bool is_aastore = (java_bc() == Bytecodes::_aastore);
3733 Deoptimization::DeoptReason reason = is_aastore ?
3734 Deoptimization::Reason_array_check : Deoptimization::Reason_class_check;
3735 builtin_throw(reason);
3736 return top();
3737 } else if (!too_many_traps_or_recompiles(Deoptimization::Reason_null_assert)) {
3738 return null_assert(obj);
3739 }
3740 break; // Fall through to full check
3741 default:
3742 break;
3743 }
3744 }
3745 }
3746
3747 ciProfileData* data = nullptr;
3748 if (failure_control == nullptr) { // use MDO in regular case only
3749 assert(java_bc() == Bytecodes::_aastore ||
3750 java_bc() == Bytecodes::_checkcast,
3751 "interpreter profiles type checks only for these BCs");
3752 if (method()->method_data()->is_mature()) {
3753 data = method()->method_data()->bci_to_data(bci());
3754 }
3755 }
3756
3757 // Make the merge point
3758 enum { _obj_path = 1, _null_path, PATH_LIMIT };
3759 RegionNode* region = new RegionNode(PATH_LIMIT);
3760 Node* phi = new PhiNode(region, toop);
3761 _gvn.set_type(region, Type::CONTROL);
3762 _gvn.set_type(phi, toop);
3763
3764 C->set_has_split_ifs(true); // Has chance for split-if optimization
3765
3766 // Use null-cast information if it is available
3767 bool speculative_not_null = false;
3768 bool never_see_null = ((failure_control == nullptr) // regular case only
3769 && seems_never_null(obj, data, speculative_not_null));
3770
3771 // Null check; get casted pointer; set region slot 3
3772 Node* null_ctl = top();
3773 Node* not_null_obj = nullptr;
3774 if (null_free) {
3775 assert(safe_for_replace, "must be");
3776 not_null_obj = null_check(obj);
3777 } else {
3778 not_null_obj = null_check_oop(obj, &null_ctl, never_see_null, false /*safe_for_replace*/, speculative_not_null);
3779 }
3780
3781 // If not_null_obj is dead, only null-path is taken
3782 if (stopped()) { // Doing instance-of on a null?
3783 set_control(null_ctl);
3784 if (toop->is_inlinetypeptr()) {
3785 return InlineTypeNode::make_null(_gvn, toop->inline_klass());
3786 }
3787 return null();
3788 }
3789 region->init_req(_null_path, null_ctl);
3790 phi ->init_req(_null_path, null()); // Set null path value
3791 if (null_ctl == top()) {
3792 // Do this eagerly, so that pattern matches like is_diamond_phi
3793 // will work even during parsing.
3794 assert(_null_path == PATH_LIMIT-1, "delete last");
3795 region->del_req(_null_path);
3796 phi ->del_req(_null_path);
3797 }
3798
3799 Node* cast_obj = nullptr;
3800 if (improved_klass_ptr_type->klass_is_exact()) {
3801 // The following optimization tries to statically cast the speculative type of the object
3802 // (for example obtained during profiling) to the type of the superklass and then do a
3803 // dynamic check that the type of the object is what we expect. To work correctly
3804 // for checkcast and aastore the type of superklass should be exact.
3805 const TypeOopPtr* obj_type = _gvn.type(obj)->is_oopptr();
3806 // We may not have profiling here or it may not help us. If we have
3807 // a speculative type use it to perform an exact cast.
3808 ciKlass* spec_obj_type = obj_type->speculative_type();
3809 if (spec_obj_type != nullptr || data != nullptr) {
3810 cast_obj = maybe_cast_profiled_receiver(not_null_obj, improved_klass_ptr_type, spec_obj_type, false /*safe_for_replace*/);
3811 if (cast_obj != nullptr) {
3812 if (failure_control != nullptr) // failure is now impossible
3813 (*failure_control) = top();
3814 // adjust the type of the phi to the exact klass:
3815 phi->raise_bottom_type(_gvn.type(cast_obj)->meet_speculative(TypePtr::NULL_PTR));
3816 }
3817 }
3818 }
3819
3820 if (cast_obj == nullptr) {
3821 // Generate the subtype check
3822 Node* improved_superklass = superklass;
3823 if (improved_klass_ptr_type != klass_ptr_type && improved_klass_ptr_type->singleton()) {
3824 // Only improve the super class for constants which allows subsequent sub type checks to possibly be commoned up.
3825 // The other non-constant cases cannot be improved with a cast node here since they could be folded to top.
3826 // Additionally, the benefit would only be minor in non-constant cases.
3827 improved_superklass = makecon(improved_klass_ptr_type);
3828 }
3829 Node* not_subtype_ctrl = gen_subtype_check(not_null_obj, improved_superklass);
3830 // Plug in success path into the merge
3831 cast_obj = _gvn.transform(new CheckCastPPNode(control(), not_null_obj, toop));
3832 // Failure path ends in uncommon trap (or may be dead - failure impossible)
3833 if (failure_control == nullptr) {
3834 if (not_subtype_ctrl != top()) { // If failure is possible
3835 PreserveJVMState pjvms(this);
3836 set_control(not_subtype_ctrl);
3837 bool is_aastore = (java_bc() == Bytecodes::_aastore);
3838 Deoptimization::DeoptReason reason = is_aastore ?
3839 Deoptimization::Reason_array_check : Deoptimization::Reason_class_check;
3840 builtin_throw(reason);
3841 }
3842 } else {
3843 (*failure_control) = not_subtype_ctrl;
3844 }
3845 }
3846
3847 region->init_req(_obj_path, control());
3848 phi ->init_req(_obj_path, cast_obj);
3849
3850 // Return final merged results
3851 set_control( _gvn.transform(region) );
3852 record_for_igvn(region);
3853
3854 bool not_inline = !toop->can_be_inline_type();
3855 bool not_flat_in_array = !UseArrayFlattening || not_inline || (toop->is_inlinetypeptr() && !toop->inline_klass()->maybe_flat_in_array());
3856 if (Arguments::is_valhalla_enabled() && (not_inline || not_flat_in_array)) {
3857 // Check if obj has been loaded from an array. Keep obj unchanged for final
3858 // map replacement below.
3859 Node* array_obj = obj->isa_DecodeN() ? obj->in(1) : obj;
3860 Node* array = nullptr;
3861 if (array_obj->isa_Load()) {
3862 Node* address = array_obj->in(MemNode::Address);
3863 if (address->isa_AddP()) {
3864 array = address->as_AddP()->in(AddPNode::Base);
3865 }
3866 } else if (array_obj->is_Phi()) {
3867 Node* region = array_obj->in(0);
3868 // TODO make this more robust (see JDK-8231346)
3869 if (region->req() == 3 && region->in(2) != nullptr && region->in(2)->in(0) != nullptr) {
3870 IfNode* iff = region->in(2)->in(0)->isa_If();
3871 if (iff != nullptr) {
3872 iff->is_flat_array_check(&_gvn, &array);
3873 }
3874 }
3875 }
3876 if (array != nullptr) {
3877 const TypeAryPtr* ary_t = _gvn.type(array)->isa_aryptr();
3878 if (ary_t != nullptr) {
3879 if (!ary_t->is_not_null_free() && !ary_t->is_null_free() && not_inline) {
3880 // Casting array element to a non-inline-type, mark array as not null-free.
3881 Node* cast = _gvn.transform(new CheckCastPPNode(control(), array, ary_t->cast_to_not_null_free()));
3882 if (new_cast_failure_map != nullptr) {
3883 // We want to propagate the improved cast node in the current map. Clone it such that we can still properly
3884 // create the cast failure path in the caller without wrongly making the cast node live there.
3885 *new_cast_failure_map = clone_map();
3886 }
3887 replace_in_map(array, cast);
3888 array = cast;
3889 }
3890 if (!ary_t->is_not_flat() && !ary_t->is_flat() && not_flat_in_array) {
3891 // Casting array element to a non-flat-in-array type, mark array as not flat.
3892 Node* cast = _gvn.transform(new CheckCastPPNode(control(), array, ary_t->cast_to_not_flat()));
3893 if (new_cast_failure_map != nullptr && *new_cast_failure_map == nullptr) {
3894 // Same as above.
3895 *new_cast_failure_map = clone_map();
3896 }
3897 replace_in_map(array, cast);
3898 array = cast;
3899 }
3900 }
3901 }
3902 }
3903
3904 // A merge of null or Casted-NotNull obj
3905 Node* res = _gvn.transform(phi);
3906 if (!stopped() && !res->is_InlineType()) {
3907 res = record_profiled_receiver_for_speculation(res);
3908 if (toop->is_inlinetypeptr() && !maybe_larval) {
3909 Node* vt = InlineTypeNode::make_from_oop(this, res, toop->inline_klass());
3910 res = vt;
3911 if (safe_for_replace) {
3912 replace_in_map(obj, vt);
3913 replace_in_map(not_null_obj, vt);
3914 replace_in_map(res, vt);
3915 }
3916 } else if (safe_for_replace) {
3917 replace_in_map(obj, res);
3918 }
3919 }
3920 return res;
3921 }
3922
3923 Node* GraphKit::mark_word_test(Node* obj, uintptr_t mask_val, bool eq, bool check_lock) {
3924 // Load markword
3925 Node* mark_adr = basic_plus_adr(obj, oopDesc::mark_offset_in_bytes());
3926 Node* mark = make_load(nullptr, mark_adr, TypeX_X, TypeX_X->basic_type(), MemNode::unordered);
3927 if (check_lock && !UseCompactObjectHeaders) {
3928 // COH: Locking does not override the markword with a tagged pointer. We can directly read from the markword.
3929 // Check if obj is locked
3930 Node* locked_bit = MakeConX(markWord::unlocked_value);
3931 locked_bit = _gvn.transform(new AndXNode(locked_bit, mark));
3932 Node* cmp = _gvn.transform(new CmpXNode(locked_bit, MakeConX(0)));
3933 Node* is_unlocked = _gvn.transform(new BoolNode(cmp, BoolTest::ne));
3934 IfNode* iff = new IfNode(control(), is_unlocked, PROB_MAX, COUNT_UNKNOWN);
3935 _gvn.transform(iff);
3936 Node* locked_region = new RegionNode(3);
3937 Node* mark_phi = new PhiNode(locked_region, TypeX_X);
3938
3939 // Unlocked: Use bits from mark word
3940 locked_region->init_req(1, _gvn.transform(new IfTrueNode(iff)));
3941 mark_phi->init_req(1, mark);
3942
3943 // Locked: Load prototype header from klass
3944 set_control(_gvn.transform(new IfFalseNode(iff)));
3945 // Make loads control dependent to make sure they are only executed if array is locked
3946 Node* klass_adr = basic_plus_adr(obj, oopDesc::klass_offset_in_bytes());
3947 Node* klass = _gvn.transform(LoadKlassNode::make(_gvn, C->immutable_memory(), klass_adr, TypeInstPtr::KLASS, TypeInstKlassPtr::OBJECT));
3948 Node* proto_adr = basic_plus_adr(top(), klass, in_bytes(Klass::prototype_header_offset()));
3949 Node* proto = _gvn.transform(LoadNode::make(_gvn, control(), C->immutable_memory(), proto_adr, proto_adr->bottom_type()->is_ptr(), TypeX_X, TypeX_X->basic_type(), MemNode::unordered));
3950
3951 locked_region->init_req(2, control());
3952 mark_phi->init_req(2, proto);
3953 set_control(_gvn.transform(locked_region));
3954 record_for_igvn(locked_region);
3955
3956 mark = mark_phi;
3957 }
3958
3959 // Now check if mark word bits are set
3960 Node* mask = MakeConX(mask_val);
3961 Node* masked = _gvn.transform(new AndXNode(_gvn.transform(mark), mask));
3962 record_for_igvn(masked); // Give it a chance to be optimized out by IGVN
3963 Node* cmp = _gvn.transform(new CmpXNode(masked, mask));
3964 return _gvn.transform(new BoolNode(cmp, eq ? BoolTest::eq : BoolTest::ne));
3965 }
3966
3967 Node* GraphKit::inline_type_test(Node* obj, bool is_inline) {
3968 return mark_word_test(obj, markWord::inline_type_pattern, is_inline, /* check_lock = */ false);
3969 }
3970
3971 Node* GraphKit::flat_array_test(Node* array_or_klass, bool flat) {
3972 // We can't use immutable memory here because the mark word is mutable.
3973 // PhaseIdealLoop::move_flat_array_check_out_of_loop will make sure the
3974 // check is moved out of loops (mainly to enable loop unswitching).
3975 Node* cmp = _gvn.transform(new FlatArrayCheckNode(C, memory(Compile::AliasIdxRaw), array_or_klass));
3976 record_for_igvn(cmp); // Give it a chance to be optimized out by IGVN
3977 return _gvn.transform(new BoolNode(cmp, flat ? BoolTest::eq : BoolTest::ne));
3978 }
3979
3980 Node* GraphKit::null_free_array_test(Node* array, bool null_free) {
3981 return mark_word_test(array, markWord::null_free_array_bit_in_place, null_free);
3982 }
3983
3984 Node* GraphKit::null_free_atomic_array_test(Node* array, ciInlineKlass* vk) {
3985 assert(vk->has_null_free_atomic_layout() || vk->has_null_free_non_atomic_layout(), "Can't be null-free and flat");
3986
3987 // TODO 8350865 Add a stress flag to always access atomic if layout exists?
3988 if (!vk->has_null_free_non_atomic_layout()) {
3989 return intcon(1); // Always atomic
3990 } else if (!vk->has_null_free_atomic_layout()) {
3991 return intcon(0); // Never atomic
3992 }
3993
3994 Node* array_klass = load_object_klass(array);
3995 int layout_kind_offset = in_bytes(FlatArrayKlass::layout_kind_offset());
3996 Node* layout_kind_addr = basic_plus_adr(top(), array_klass, layout_kind_offset);
3997 Node* layout_kind = make_load(nullptr, layout_kind_addr, TypeInt::INT, T_INT, MemNode::unordered);
3998 Node* cmp = _gvn.transform(new CmpINode(layout_kind, intcon((int)LayoutKind::NULL_FREE_ATOMIC_FLAT)));
3999 return _gvn.transform(new BoolNode(cmp, BoolTest::eq));
4000 }
4001
4002 Node* GraphKit::atomic_layout_array_test_and_get_layout_kind(Node* array, RegionNode* atomic_region) {
4003 Node* array_klass = load_object_klass(array);
4004 int layout_kind_offset = in_bytes(FlatArrayKlass::layout_kind_offset());
4005 Node* layout_kind_addr = basic_plus_adr(top(), array_klass, layout_kind_offset);
4006 Node* layout_kind = make_load(nullptr, layout_kind_addr, TypeInt::INT, T_INT, MemNode::unordered);
4007 Node* cmp_null_free = _gvn.transform(new CmpINode(layout_kind, intcon(static_cast<jint>(LayoutKind::NULL_FREE_ATOMIC_FLAT))));
4008 Node* bol_null_free = _gvn.transform(new BoolNode(cmp_null_free, BoolTest::eq));
4009 Node* cmp_nullable = _gvn.transform(new CmpINode(layout_kind, intcon(static_cast<jint>(LayoutKind::NULLABLE_ATOMIC_FLAT))));
4010 Node* bol_nullable = _gvn.transform(new BoolNode(cmp_nullable, BoolTest::eq));
4011
4012 IfNode* iff_null_free = create_and_xform_if(control(), bol_null_free, PROB_FAIR, COUNT_UNKNOWN);
4013 atomic_region->add_req(_gvn.transform(new IfTrueNode(iff_null_free)));
4014 set_control(_gvn.transform(new IfFalseNode(iff_null_free)));
4015
4016 IfNode* iff_nullable = create_and_xform_if(control(), bol_nullable, PROB_FAIR, COUNT_UNKNOWN);
4017 atomic_region->add_req(_gvn.transform(new IfTrueNode(iff_nullable)));
4018 set_control(_gvn.transform(new IfFalseNode(iff_nullable)));
4019
4020 return layout_kind;
4021 }
4022
4023 // Deoptimize if 'ary' is a null-free inline type array and 'val' is null
4024 Node* GraphKit::inline_array_null_guard(Node* ary, Node* val, int nargs, bool safe_for_replace) {
4025 RegionNode* region = new RegionNode(3);
4026 Node* null_ctl = top();
4027 null_check_oop(val, &null_ctl);
4028 if (null_ctl != top()) {
4029 PreserveJVMState pjvms(this);
4030 set_control(null_ctl);
4031 {
4032 // Deoptimize if null-free array
4033 BuildCutout unless(this, null_free_array_test(ary, /* null_free = */ false), PROB_MAX);
4034 inc_sp(nargs);
4035 uncommon_trap(Deoptimization::Reason_null_check,
4036 Deoptimization::Action_none);
4037 }
4038 region->init_req(1, control());
4039 }
4040 region->init_req(2, control());
4041 set_control(_gvn.transform(region));
4042 record_for_igvn(region);
4043 if (_gvn.type(val) == TypePtr::NULL_PTR) {
4044 // Since we were just successfully storing null, the array can't be null free.
4045 const TypeAryPtr* ary_t = _gvn.type(ary)->is_aryptr();
4046 ary_t = ary_t->cast_to_not_null_free();
4047 Node* cast = _gvn.transform(new CheckCastPPNode(control(), ary, ary_t));
4048 if (safe_for_replace) {
4049 replace_in_map(ary, cast);
4050 }
4051 ary = cast;
4052 }
4053 return ary;
4054 }
4055
4056 //------------------------------next_monitor-----------------------------------
4057 // What number should be given to the next monitor?
4058 int GraphKit::next_monitor() {
4059 int current = jvms()->monitor_depth()* C->sync_stack_slots();
4060 int next = current + C->sync_stack_slots();
4061 // Keep the toplevel high water mark current:
4062 if (C->fixed_slots() < next) C->set_fixed_slots(next);
4063 return current;
4064 }
4065
4066 //------------------------------insert_mem_bar---------------------------------
4067 // Memory barrier to avoid floating things around
4068 // The membar serves as a pinch point between both control and all memory slices.
4069 Node* GraphKit::insert_mem_bar(int opcode, Node* precedent) {
4070 MemBarNode* mb = MemBarNode::make(C, opcode, Compile::AliasIdxBot, precedent);
4071 mb->init_req(TypeFunc::Control, control());
4072 mb->init_req(TypeFunc::Memory, reset_memory());
4073 Node* membar = _gvn.transform(mb);
4074 record_for_igvn(membar);
4075 set_control(_gvn.transform(new ProjNode(membar, TypeFunc::Control)));
4076 set_all_memory_call(membar);
4077 return membar;
4078 }
4079
4080 //-------------------------insert_mem_bar_volatile----------------------------
4081 // Memory barrier to avoid floating things around
4082 // The membar serves as a pinch point between both control and memory(alias_idx).
4083 // If you want to make a pinch point on all memory slices, do not use this
4084 // function (even with AliasIdxBot); use insert_mem_bar() instead.
4085 Node* GraphKit::insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent) {
4086 // When Parse::do_put_xxx updates a volatile field, it appends a series
4087 // of MemBarVolatile nodes, one for *each* volatile field alias category.
4088 // The first membar is on the same memory slice as the field store opcode.
4089 // This forces the membar to follow the store. (Bug 6500685 broke this.)
4090 // All the other membars (for other volatile slices, including AliasIdxBot,
4091 // which stands for all unknown volatile slices) are control-dependent
4092 // on the first membar. This prevents later volatile loads or stores
4093 // from sliding up past the just-emitted store.
4094
4095 MemBarNode* mb = MemBarNode::make(C, opcode, alias_idx, precedent);
4096 mb->set_req(TypeFunc::Control,control());
4097 if (alias_idx == Compile::AliasIdxBot) {
4098 mb->set_req(TypeFunc::Memory, merged_memory()->base_memory());
4099 } else {
4100 assert(!(opcode == Op_Initialize && alias_idx != Compile::AliasIdxRaw), "fix caller");
4101 mb->set_req(TypeFunc::Memory, memory(alias_idx));
4102 }
4103 Node* membar = _gvn.transform(mb);
4104 record_for_igvn(membar);
4105 set_control(_gvn.transform(new ProjNode(membar, TypeFunc::Control)));
4106 if (alias_idx == Compile::AliasIdxBot) {
4107 merged_memory()->set_base_memory(_gvn.transform(new ProjNode(membar, TypeFunc::Memory)));
4108 } else {
4109 set_memory(_gvn.transform(new ProjNode(membar, TypeFunc::Memory)),alias_idx);
4110 }
4111 return membar;
4112 }
4113
4114 //------------------------------insert_reachability_fence----------------------
4115 Node* GraphKit::insert_reachability_fence(Node* referent) {
4116 assert(!referent->is_top(), "");
4117 Node* rf = _gvn.transform(new ReachabilityFenceNode(C, control(), referent));
4118 set_control(rf);
4119 C->record_for_igvn(rf);
4120 return rf;
4121 }
4122
4123 //------------------------------shared_lock------------------------------------
4124 // Emit locking code.
4125 FastLockNode* GraphKit::shared_lock(Node* obj) {
4126 // bci is either a monitorenter bc or InvocationEntryBci
4127 // %%% SynchronizationEntryBCI is redundant; use InvocationEntryBci in interfaces
4128 assert(SynchronizationEntryBCI == InvocationEntryBci, "");
4129
4130 if (stopped()) // Dead monitor?
4131 return nullptr;
4132
4133 assert(dead_locals_are_killed(), "should kill locals before sync. point");
4134
4135 // Box the stack location
4136 Node* box = new BoxLockNode(next_monitor());
4137 // Check for bailout after new BoxLockNode
4138 if (failing()) { return nullptr; }
4139 box = _gvn.transform(box);
4140 Node* mem = reset_memory();
4141
4142 FastLockNode * flock = _gvn.transform(new FastLockNode(nullptr, obj, box) )->as_FastLock();
4143
4144 // Add monitor to debug info for the slow path. If we block inside the
4145 // slow path and de-opt, we need the monitor hanging around
4146 map()->push_monitor( flock );
4147
4148 const TypeFunc *tf = LockNode::lock_type();
4149 LockNode *lock = new LockNode(C, tf);
4150
4151 lock->init_req( TypeFunc::Control, control() );
4152 lock->init_req( TypeFunc::Memory , mem );
4153 lock->init_req( TypeFunc::I_O , top() ) ; // does no i/o
4154 lock->init_req( TypeFunc::FramePtr, frameptr() );
4155 lock->init_req( TypeFunc::ReturnAdr, top() );
4156
4157 lock->init_req(TypeFunc::Parms + 0, obj);
4158 lock->init_req(TypeFunc::Parms + 1, box);
4159 lock->init_req(TypeFunc::Parms + 2, flock);
4160 add_safepoint_edges(lock);
4161
4162 lock = _gvn.transform( lock )->as_Lock();
4163
4164 // lock has no side-effects, sets few values
4165 set_predefined_output_for_runtime_call(lock, mem, TypeRawPtr::BOTTOM);
4166
4167 insert_mem_bar(Op_MemBarAcquireLock);
4168
4169 // Add this to the worklist so that the lock can be eliminated
4170 record_for_igvn(lock);
4171
4172 #ifndef PRODUCT
4173 if (PrintLockStatistics) {
4174 // Update the counter for this lock. Don't bother using an atomic
4175 // operation since we don't require absolute accuracy.
4176 lock->create_lock_counter(map()->jvms());
4177 increment_counter(lock->counter()->addr());
4178 }
4179 #endif
4180
4181 return flock;
4182 }
4183
4184
4185 //------------------------------shared_unlock----------------------------------
4186 // Emit unlocking code.
4187 void GraphKit::shared_unlock(Node* box, Node* obj) {
4188 // bci is either a monitorenter bc or InvocationEntryBci
4189 // %%% SynchronizationEntryBCI is redundant; use InvocationEntryBci in interfaces
4190 assert(SynchronizationEntryBCI == InvocationEntryBci, "");
4191
4192 if (stopped()) { // Dead monitor?
4193 map()->pop_monitor(); // Kill monitor from debug info
4194 return;
4195 }
4196 assert(!obj->is_InlineType(), "should not unlock on inline type");
4197
4198 // Memory barrier to avoid floating things down past the locked region
4199 insert_mem_bar(Op_MemBarReleaseLock);
4200
4201 const TypeFunc *tf = OptoRuntime::complete_monitor_exit_Type();
4202 UnlockNode *unlock = new UnlockNode(C, tf);
4203 #ifdef ASSERT
4204 unlock->set_dbg_jvms(sync_jvms());
4205 #endif
4206 uint raw_idx = Compile::AliasIdxRaw;
4207 unlock->init_req( TypeFunc::Control, control() );
4208 unlock->init_req( TypeFunc::Memory , memory(raw_idx) );
4209 unlock->init_req( TypeFunc::I_O , top() ) ; // does no i/o
4210 unlock->init_req( TypeFunc::FramePtr, frameptr() );
4211 unlock->init_req( TypeFunc::ReturnAdr, top() );
4212
4213 unlock->init_req(TypeFunc::Parms + 0, obj);
4214 unlock->init_req(TypeFunc::Parms + 1, box);
4215 unlock = _gvn.transform(unlock)->as_Unlock();
4216
4217 Node* mem = reset_memory();
4218
4219 // unlock has no side-effects, sets few values
4220 set_predefined_output_for_runtime_call(unlock, mem, TypeRawPtr::BOTTOM);
4221
4222 // Kill monitor from debug info
4223 map()->pop_monitor( );
4224 }
4225
4226 //-------------------------------get_layout_helper-----------------------------
4227 // If the given klass is a constant or known to be an array,
4228 // fetch the constant layout helper value into constant_value
4229 // and return null. Otherwise, load the non-constant
4230 // layout helper value, and return the node which represents it.
4231 // This two-faced routine is useful because allocation sites
4232 // almost always feature constant types.
4233 Node* GraphKit::get_layout_helper(Node* klass_node, jint& constant_value) {
4234 const TypeKlassPtr* klass_t = _gvn.type(klass_node)->isa_klassptr();
4235 if (!StressReflectiveCode && klass_t != nullptr) {
4236 bool xklass = klass_t->klass_is_exact();
4237 bool can_be_flat = false;
4238 const TypeAryPtr* ary_type = klass_t->as_exact_instance_type()->isa_aryptr();
4239 if (UseArrayFlattening && !xklass && ary_type != nullptr) {
4240 // Don't constant fold if the runtime type might be a flat array but the static type is not.
4241 const TypeOopPtr* elem = ary_type->elem()->make_oopptr();
4242 can_be_flat = ary_type->can_be_inline_array() && (!elem->is_inlinetypeptr() || elem->inline_klass()->maybe_flat_in_array());
4243 }
4244 if (!can_be_flat && (xklass || (klass_t->isa_aryklassptr() && klass_t->is_aryklassptr()->elem() != Type::BOTTOM))) {
4245 jint lhelper;
4246 if (klass_t->is_flat()) {
4247 lhelper = ary_type->flat_layout_helper();
4248 } else if (klass_t->isa_aryklassptr()) {
4249 BasicType elem = ary_type->elem()->array_element_basic_type();
4250 if (is_reference_type(elem, true)) {
4251 elem = T_OBJECT;
4252 }
4253 lhelper = Klass::array_layout_helper(elem);
4254 } else {
4255 lhelper = klass_t->is_instklassptr()->exact_klass()->layout_helper();
4256 }
4257 if (lhelper != Klass::_lh_neutral_value) {
4258 constant_value = lhelper;
4259 return (Node*) nullptr;
4260 }
4261 }
4262 }
4263 constant_value = Klass::_lh_neutral_value; // put in a known value
4264 Node* lhp = off_heap_plus_addr(klass_node, in_bytes(Klass::layout_helper_offset()));
4265 return make_load(nullptr, lhp, TypeInt::INT, T_INT, MemNode::unordered);
4266 }
4267
4268 // We just put in an allocate/initialize with a big raw-memory effect.
4269 // Hook selected additional alias categories on the initialization.
4270 static void hook_memory_on_init(GraphKit& kit, int alias_idx,
4271 MergeMemNode* init_in_merge,
4272 Node* init_out_raw) {
4273 DEBUG_ONLY(Node* init_in_raw = init_in_merge->base_memory());
4274 assert(init_in_merge->memory_at(alias_idx) == init_in_raw, "");
4275
4276 Node* prevmem = kit.memory(alias_idx);
4277 init_in_merge->set_memory_at(alias_idx, prevmem);
4278 if (init_out_raw != nullptr) {
4279 kit.set_memory(init_out_raw, alias_idx);
4280 }
4281 }
4282
4283 //---------------------------set_output_for_allocation-------------------------
4284 Node* GraphKit::set_output_for_allocation(AllocateNode* alloc,
4285 const TypeOopPtr* oop_type,
4286 bool deoptimize_on_exception) {
4287 int rawidx = Compile::AliasIdxRaw;
4288 alloc->set_req( TypeFunc::FramePtr, frameptr() );
4289 add_safepoint_edges(alloc);
4290 Node* allocx = _gvn.transform(alloc);
4291 set_control( _gvn.transform(new ProjNode(allocx, TypeFunc::Control) ) );
4292 // create memory projection for i_o
4293 set_memory ( _gvn.transform( new ProjNode(allocx, TypeFunc::Memory, true) ), rawidx );
4294 make_slow_call_ex(allocx, env()->Throwable_klass(), true, deoptimize_on_exception);
4295
4296 // create a memory projection as for the normal control path
4297 Node* malloc = _gvn.transform(new ProjNode(allocx, TypeFunc::Memory));
4298 set_memory(malloc, rawidx);
4299
4300 // a normal slow-call doesn't change i_o, but an allocation does
4301 // we create a separate i_o projection for the normal control path
4302 set_i_o(_gvn.transform( new ProjNode(allocx, TypeFunc::I_O, false) ) );
4303 Node* rawoop = _gvn.transform( new ProjNode(allocx, TypeFunc::Parms) );
4304
4305 // put in an initialization barrier
4306 InitializeNode* init = insert_mem_bar_volatile(Op_Initialize, rawidx,
4307 rawoop)->as_Initialize();
4308 assert(alloc->initialization() == init, "2-way macro link must work");
4309 assert(init ->allocation() == alloc, "2-way macro link must work");
4310 {
4311 // Extract memory strands which may participate in the new object's
4312 // initialization, and source them from the new InitializeNode.
4313 // This will allow us to observe initializations when they occur,
4314 // and link them properly (as a group) to the InitializeNode.
4315 assert(init->in(InitializeNode::Memory) == malloc, "");
4316 MergeMemNode* minit_in = MergeMemNode::make(malloc);
4317 init->set_req(InitializeNode::Memory, minit_in);
4318 record_for_igvn(minit_in); // fold it up later, if possible
4319 _gvn.set_type(minit_in, Type::MEMORY);
4320 Node* minit_out = memory(rawidx);
4321 assert(minit_out->is_Proj() && minit_out->in(0) == init, "");
4322 int mark_idx = C->get_alias_index(oop_type->add_offset(oopDesc::mark_offset_in_bytes()));
4323 // Add an edge in the MergeMem for the header fields so an access to one of those has correct memory state.
4324 // Use one NarrowMemProjNode per slice to properly record the adr type of each slice. The Initialize node will have
4325 // multiple projections as a result.
4326 set_memory(_gvn.transform(new NarrowMemProjNode(init, C->get_adr_type(mark_idx))), mark_idx);
4327 int klass_idx = C->get_alias_index(oop_type->add_offset(oopDesc::klass_offset_in_bytes()));
4328 set_memory(_gvn.transform(new NarrowMemProjNode(init, C->get_adr_type(klass_idx))), klass_idx);
4329 if (oop_type->isa_aryptr()) {
4330 // Initially all flat array accesses share a single slice
4331 // but that changes after parsing. Prepare the memory graph so
4332 // it can optimize flat array accesses properly once they
4333 // don't share a single slice.
4334 assert(C->flat_accesses_share_alias(), "should be set at parse time");
4335 const TypePtr* telemref = oop_type->add_offset(Type::OffsetBot);
4336 int elemidx = C->get_alias_index(telemref);
4337 const TypePtr* alias_adr_type = C->get_adr_type(elemidx);
4338 if (alias_adr_type->is_flat()) {
4339 C->set_flat_accesses();
4340 }
4341 hook_memory_on_init(*this, elemidx, minit_in, _gvn.transform(new NarrowMemProjNode(init, alias_adr_type)));
4342 } else if (oop_type->isa_instptr()) {
4343 ciInstanceKlass* ik = oop_type->is_instptr()->instance_klass();
4344 for (int i = 0, len = ik->nof_nonstatic_fields(); i < len; i++) {
4345 ciField* field = ik->nonstatic_field_at(i);
4346 if (field->offset_in_bytes() >= TrackedInitializationLimit * HeapWordSize)
4347 continue; // do not bother to track really large numbers of fields
4348 // Find (or create) the alias category for this field:
4349 int fieldidx = C->alias_type(field)->index();
4350 hook_memory_on_init(*this, fieldidx, minit_in, _gvn.transform(new NarrowMemProjNode(init, C->get_adr_type(fieldidx))));
4351 }
4352 }
4353 }
4354
4355 // Cast raw oop to the real thing...
4356 Node* javaoop = new CheckCastPPNode(control(), rawoop, oop_type);
4357 javaoop = _gvn.transform(javaoop);
4358 C->set_recent_alloc(control(), javaoop);
4359 assert(just_allocated_object(control()) == javaoop, "just allocated");
4360
4361 #ifdef ASSERT
4362 { // Verify that the AllocateNode::Ideal_allocation recognizers work:
4363 assert(AllocateNode::Ideal_allocation(rawoop) == alloc,
4364 "Ideal_allocation works");
4365 assert(AllocateNode::Ideal_allocation(javaoop) == alloc,
4366 "Ideal_allocation works");
4367 if (alloc->is_AllocateArray()) {
4368 assert(AllocateArrayNode::Ideal_array_allocation(rawoop) == alloc->as_AllocateArray(),
4369 "Ideal_allocation works");
4370 assert(AllocateArrayNode::Ideal_array_allocation(javaoop) == alloc->as_AllocateArray(),
4371 "Ideal_allocation works");
4372 } else {
4373 assert(alloc->in(AllocateNode::ALength)->is_top(), "no length, please");
4374 }
4375 }
4376 #endif //ASSERT
4377
4378 return javaoop;
4379 }
4380
4381 //---------------------------new_instance--------------------------------------
4382 // This routine takes a klass_node which may be constant (for a static type)
4383 // or may be non-constant (for reflective code). It will work equally well
4384 // for either, and the graph will fold nicely if the optimizer later reduces
4385 // the type to a constant.
4386 // The optional arguments are for specialized use by intrinsics:
4387 // - If 'extra_slow_test' if not null is an extra condition for the slow-path.
4388 // - If 'return_size_val', report the total object size to the caller.
4389 // - deoptimize_on_exception controls how Java exceptions are handled (rethrow vs deoptimize)
4390 Node* GraphKit::new_instance(Node* klass_node,
4391 Node* extra_slow_test,
4392 Node* *return_size_val,
4393 bool deoptimize_on_exception,
4394 InlineTypeNode* inline_type_node) {
4395 // Compute size in doublewords
4396 // The size is always an integral number of doublewords, represented
4397 // as a positive bytewise size stored in the klass's layout_helper.
4398 // The layout_helper also encodes (in a low bit) the need for a slow path.
4399 jint layout_con = Klass::_lh_neutral_value;
4400 Node* layout_val = get_layout_helper(klass_node, layout_con);
4401 bool layout_is_con = (layout_val == nullptr);
4402
4403 if (extra_slow_test == nullptr) extra_slow_test = intcon(0);
4404 // Generate the initial go-slow test. It's either ALWAYS (return a
4405 // Node for 1) or NEVER (return a null) or perhaps (in the reflective
4406 // case) a computed value derived from the layout_helper.
4407 Node* initial_slow_test = nullptr;
4408 if (layout_is_con) {
4409 assert(!StressReflectiveCode, "stress mode does not use these paths");
4410 bool must_go_slow = Klass::layout_helper_needs_slow_path(layout_con);
4411 initial_slow_test = must_go_slow ? intcon(1) : extra_slow_test;
4412 } else { // reflective case
4413 // This reflective path is used by Unsafe.allocateInstance.
4414 // (It may be stress-tested by specifying StressReflectiveCode.)
4415 // Basically, we want to get into the VM is there's an illegal argument.
4416 Node* bit = intcon(Klass::_lh_instance_slow_path_bit);
4417 initial_slow_test = _gvn.transform( new AndINode(layout_val, bit) );
4418 if (extra_slow_test != intcon(0)) {
4419 initial_slow_test = _gvn.transform( new OrINode(initial_slow_test, extra_slow_test) );
4420 }
4421 // (Macro-expander will further convert this to a Bool, if necessary.)
4422 }
4423
4424 // Find the size in bytes. This is easy; it's the layout_helper.
4425 // The size value must be valid even if the slow path is taken.
4426 Node* size = nullptr;
4427 if (layout_is_con) {
4428 size = MakeConX(Klass::layout_helper_size_in_bytes(layout_con));
4429 } else { // reflective case
4430 // This reflective path is used by clone and Unsafe.allocateInstance.
4431 size = ConvI2X(layout_val);
4432
4433 // Clear the low bits to extract layout_helper_size_in_bytes:
4434 assert((int)Klass::_lh_instance_slow_path_bit < BytesPerLong, "clear bit");
4435 Node* mask = MakeConX(~ (intptr_t)right_n_bits(LogBytesPerLong));
4436 size = _gvn.transform( new AndXNode(size, mask) );
4437 }
4438 if (return_size_val != nullptr) {
4439 (*return_size_val) = size;
4440 }
4441
4442 // This is a precise notnull oop of the klass.
4443 // (Actually, it need not be precise if this is a reflective allocation.)
4444 // It's what we cast the result to.
4445 const TypeKlassPtr* tklass = _gvn.type(klass_node)->isa_klassptr();
4446 if (!tklass) tklass = TypeInstKlassPtr::OBJECT;
4447 const TypeOopPtr* oop_type = tklass->as_exact_instance_type();
4448
4449 // Now generate allocation code
4450
4451 // The entire memory state is needed for slow path of the allocation
4452 // since GC and deoptimization can happen.
4453 Node *mem = reset_memory();
4454 set_all_memory(mem); // Create new memory state
4455
4456 AllocateNode* alloc = new AllocateNode(C, AllocateNode::alloc_type(Type::TOP),
4457 control(), mem, i_o(),
4458 size, klass_node,
4459 initial_slow_test, inline_type_node);
4460
4461 return set_output_for_allocation(alloc, oop_type, deoptimize_on_exception);
4462 }
4463
4464 //-------------------------------new_array-------------------------------------
4465 // helper for newarray and anewarray
4466 // The 'length' parameter is (obviously) the length of the array.
4467 // The optional arguments are for specialized use by intrinsics:
4468 // - If 'return_size_val', report the non-padded array size (sum of header size
4469 // and array body) to the caller.
4470 // - deoptimize_on_exception controls how Java exceptions are handled (rethrow vs deoptimize)
4471 Node* GraphKit::new_array(Node* klass_node, // array klass (maybe variable)
4472 Node* length, // number of array elements
4473 int nargs, // number of arguments to push back for uncommon trap
4474 Node* *return_size_val,
4475 bool deoptimize_on_exception,
4476 Node* init_val) {
4477 jint layout_con = Klass::_lh_neutral_value;
4478 Node* layout_val = get_layout_helper(klass_node, layout_con);
4479 bool layout_is_con = (layout_val == nullptr);
4480
4481 if (!layout_is_con && !StressReflectiveCode &&
4482 !too_many_traps(Deoptimization::Reason_class_check)) {
4483 // This is a reflective array creation site.
4484 // Optimistically assume that it is a subtype of Object[],
4485 // so that we can fold up all the address arithmetic.
4486 layout_con = Klass::array_layout_helper(T_OBJECT);
4487 Node* cmp_lh = _gvn.transform( new CmpINode(layout_val, intcon(layout_con)) );
4488 Node* bol_lh = _gvn.transform( new BoolNode(cmp_lh, BoolTest::eq) );
4489 { BuildCutout unless(this, bol_lh, PROB_MAX);
4490 inc_sp(nargs);
4491 uncommon_trap(Deoptimization::Reason_class_check,
4492 Deoptimization::Action_maybe_recompile);
4493 }
4494 layout_val = nullptr;
4495 layout_is_con = true;
4496 }
4497
4498 // Generate the initial go-slow test. Make sure we do not overflow
4499 // if length is huge (near 2Gig) or negative! We do not need
4500 // exact double-words here, just a close approximation of needed
4501 // double-words. We can't add any offset or rounding bits, lest we
4502 // take a size -1 of bytes and make it positive. Use an unsigned
4503 // compare, so negative sizes look hugely positive.
4504 int fast_size_limit = FastAllocateSizeLimit;
4505 if (layout_is_con) {
4506 assert(!StressReflectiveCode, "stress mode does not use these paths");
4507 // Increase the size limit if we have exact knowledge of array type.
4508 int log2_esize = Klass::layout_helper_log2_element_size(layout_con);
4509 fast_size_limit <<= MAX2(LogBytesPerLong - log2_esize, 0);
4510 }
4511
4512 Node* initial_slow_cmp = _gvn.transform( new CmpUNode( length, intcon( fast_size_limit ) ) );
4513 Node* initial_slow_test = _gvn.transform( new BoolNode( initial_slow_cmp, BoolTest::gt ) );
4514
4515 // --- Size Computation ---
4516 // array_size = round_to_heap(array_header + (length << elem_shift));
4517 // where round_to_heap(x) == align_to(x, MinObjAlignmentInBytes)
4518 // and align_to(x, y) == ((x + y-1) & ~(y-1))
4519 // The rounding mask is strength-reduced, if possible.
4520 int round_mask = MinObjAlignmentInBytes - 1;
4521 Node* header_size = nullptr;
4522 // (T_BYTE has the weakest alignment and size restrictions...)
4523 if (layout_is_con) {
4524 int hsize = Klass::layout_helper_header_size(layout_con);
4525 int eshift = Klass::layout_helper_log2_element_size(layout_con);
4526 bool is_flat_array = Klass::layout_helper_is_flatArray(layout_con);
4527 if ((round_mask & ~right_n_bits(eshift)) == 0)
4528 round_mask = 0; // strength-reduce it if it goes away completely
4529 assert(is_flat_array || (hsize & right_n_bits(eshift)) == 0, "hsize is pre-rounded");
4530 int header_size_min = arrayOopDesc::base_offset_in_bytes(T_BYTE);
4531 assert(header_size_min <= hsize, "generic minimum is smallest");
4532 header_size = intcon(hsize);
4533 } else {
4534 Node* hss = intcon(Klass::_lh_header_size_shift);
4535 Node* hsm = intcon(Klass::_lh_header_size_mask);
4536 header_size = _gvn.transform(new URShiftINode(layout_val, hss));
4537 header_size = _gvn.transform(new AndINode(header_size, hsm));
4538 }
4539
4540 Node* elem_shift = nullptr;
4541 if (layout_is_con) {
4542 int eshift = Klass::layout_helper_log2_element_size(layout_con);
4543 if (eshift != 0)
4544 elem_shift = intcon(eshift);
4545 } else {
4546 // There is no need to mask or shift this value.
4547 // The semantics of LShiftINode include an implicit mask to 0x1F.
4548 assert(Klass::_lh_log2_element_size_shift == 0, "use shift in place");
4549 elem_shift = layout_val;
4550 }
4551
4552 // Transition to native address size for all offset calculations:
4553 Node* lengthx = ConvI2X(length);
4554 Node* headerx = ConvI2X(header_size);
4555 #ifdef _LP64
4556 { const TypeInt* tilen = _gvn.find_int_type(length);
4557 if (tilen != nullptr && tilen->_lo < 0) {
4558 // Add a manual constraint to a positive range. Cf. array_element_address.
4559 jint size_max = fast_size_limit;
4560 if (size_max > tilen->_hi && tilen->_hi >= 0) {
4561 size_max = tilen->_hi;
4562 }
4563 const TypeInt* tlcon = TypeInt::make(0, size_max, Type::WidenMin);
4564
4565 // Only do a narrow I2L conversion if the range check passed.
4566 IfNode* iff = new IfNode(control(), initial_slow_test, PROB_MIN, COUNT_UNKNOWN);
4567 _gvn.transform(iff);
4568 RegionNode* region = new RegionNode(3);
4569 _gvn.set_type(region, Type::CONTROL);
4570 lengthx = new PhiNode(region, TypeLong::LONG);
4571 _gvn.set_type(lengthx, TypeLong::LONG);
4572
4573 // Range check passed. Use ConvI2L node with narrow type.
4574 Node* passed = IfFalse(iff);
4575 region->init_req(1, passed);
4576 // Make I2L conversion control dependent to prevent it from
4577 // floating above the range check during loop optimizations.
4578 lengthx->init_req(1, C->constrained_convI2L(&_gvn, length, tlcon, passed));
4579
4580 // Range check failed. Use ConvI2L with wide type because length may be invalid.
4581 region->init_req(2, IfTrue(iff));
4582 lengthx->init_req(2, ConvI2X(length));
4583
4584 set_control(region);
4585 record_for_igvn(region);
4586 record_for_igvn(lengthx);
4587 }
4588 }
4589 #endif
4590
4591 // Combine header size and body size for the array copy part, then align (if
4592 // necessary) for the allocation part. This computation cannot overflow,
4593 // because it is used only in two places, one where the length is sharply
4594 // limited, and the other after a successful allocation.
4595 Node* abody = lengthx;
4596 if (elem_shift != nullptr) {
4597 abody = _gvn.transform(new LShiftXNode(lengthx, elem_shift));
4598 }
4599 Node* non_rounded_size = _gvn.transform(new AddXNode(headerx, abody));
4600
4601 if (return_size_val != nullptr) {
4602 // This is the size
4603 (*return_size_val) = non_rounded_size;
4604 }
4605
4606 Node* size = non_rounded_size;
4607 if (round_mask != 0) {
4608 Node* mask1 = MakeConX(round_mask);
4609 size = _gvn.transform(new AddXNode(size, mask1));
4610 Node* mask2 = MakeConX(~round_mask);
4611 size = _gvn.transform(new AndXNode(size, mask2));
4612 }
4613 // else if round_mask == 0, the size computation is self-rounding
4614
4615 // Now generate allocation code
4616
4617 // The entire memory state is needed for slow path of the allocation
4618 // since GC and deoptimization can happen.
4619 Node *mem = reset_memory();
4620 set_all_memory(mem); // Create new memory state
4621
4622 if (initial_slow_test->is_Bool()) {
4623 // Hide it behind a CMoveI, or else PhaseIdealLoop::split_up will get sick.
4624 initial_slow_test = initial_slow_test->as_Bool()->as_int_value(&_gvn);
4625 }
4626
4627 const TypeKlassPtr* ary_klass = _gvn.type(klass_node)->isa_klassptr();
4628 const TypeOopPtr* ary_type = ary_klass->as_exact_instance_type();
4629
4630 Node* raw_init_value = nullptr;
4631 if (init_val != nullptr) {
4632 // TODO 8350865 Fast non-zero init not implemented yet for flat, null-free arrays
4633 if (ary_type->is_flat()) {
4634 initial_slow_test = intcon(1);
4635 }
4636
4637 if (UseCompressedOops) {
4638 // With compressed oops, the 64-bit init value is built from two 32-bit compressed oops
4639 init_val = _gvn.transform(new EncodePNode(init_val, init_val->bottom_type()->make_narrowoop()));
4640 Node* lower = _gvn.transform(new CastP2XNode(control(), init_val));
4641 Node* upper = _gvn.transform(new LShiftLNode(lower, intcon(32)));
4642 raw_init_value = _gvn.transform(new OrLNode(lower, upper));
4643 } else {
4644 raw_init_value = _gvn.transform(new CastP2XNode(control(), init_val));
4645 }
4646 }
4647
4648 Node* valid_length_test = _gvn.intcon(1);
4649 if (ary_type->isa_aryptr()) {
4650 BasicType bt = ary_type->isa_aryptr()->elem()->array_element_basic_type();
4651 jint max = TypeAryPtr::max_array_length(bt);
4652 Node* valid_length_cmp = _gvn.transform(new CmpUNode(length, intcon(max)));
4653 valid_length_test = _gvn.transform(new BoolNode(valid_length_cmp, BoolTest::le));
4654 }
4655
4656 // Create the AllocateArrayNode and its result projections
4657 AllocateArrayNode* alloc
4658 = new AllocateArrayNode(C, AllocateArrayNode::alloc_type(TypeInt::INT),
4659 control(), mem, i_o(),
4660 size, klass_node,
4661 initial_slow_test,
4662 length, valid_length_test,
4663 init_val, raw_init_value);
4664 // Cast to correct type. Note that the klass_node may be constant or not,
4665 // and in the latter case the actual array type will be inexact also.
4666 // (This happens via a non-constant argument to inline_native_newArray.)
4667 // In any case, the value of klass_node provides the desired array type.
4668 const TypeInt* length_type = _gvn.find_int_type(length);
4669 if (ary_type->isa_aryptr() && length_type != nullptr) {
4670 // Try to get a better type than POS for the size
4671 ary_type = ary_type->is_aryptr()->cast_to_size(length_type);
4672 }
4673
4674 Node* javaoop = set_output_for_allocation(alloc, ary_type, deoptimize_on_exception);
4675
4676 array_ideal_length(alloc, ary_type, true);
4677 return javaoop;
4678 }
4679
4680 // The following "Ideal_foo" functions are placed here because they recognize
4681 // the graph shapes created by the functions immediately above.
4682
4683 //---------------------------Ideal_allocation----------------------------------
4684 // Given an oop pointer or raw pointer, see if it feeds from an AllocateNode.
4685 AllocateNode* AllocateNode::Ideal_allocation(Node* ptr) {
4686 if (ptr == nullptr) { // reduce dumb test in callers
4687 return nullptr;
4688 }
4689
4690 BarrierSetC2* bs = BarrierSet::barrier_set()->barrier_set_c2();
4691 ptr = bs->step_over_gc_barrier(ptr);
4692
4693 if (ptr->is_CheckCastPP()) { // strip only one raw-to-oop cast
4694 ptr = ptr->in(1);
4695 if (ptr == nullptr) return nullptr;
4696 }
4697 // Return null for allocations with several casts:
4698 // j.l.reflect.Array.newInstance(jobject, jint)
4699 // Object.clone()
4700 // to keep more precise type from last cast.
4701 if (ptr->is_Proj()) {
4702 Node* allo = ptr->in(0);
4703 if (allo != nullptr && allo->is_Allocate()) {
4704 return allo->as_Allocate();
4705 }
4706 }
4707 // Report failure to match.
4708 return nullptr;
4709 }
4710
4711 // Fancy version which also strips off an offset (and reports it to caller).
4712 AllocateNode* AllocateNode::Ideal_allocation(Node* ptr, PhaseValues* phase,
4713 intptr_t& offset) {
4714 Node* base = AddPNode::Ideal_base_and_offset(ptr, phase, offset);
4715 if (base == nullptr) return nullptr;
4716 return Ideal_allocation(base);
4717 }
4718
4719 // Trace Initialize <- Proj[Parm] <- Allocate
4720 AllocateNode* InitializeNode::allocation() {
4721 Node* rawoop = in(InitializeNode::RawAddress);
4722 if (rawoop->is_Proj()) {
4723 Node* alloc = rawoop->in(0);
4724 if (alloc->is_Allocate()) {
4725 return alloc->as_Allocate();
4726 }
4727 }
4728 return nullptr;
4729 }
4730
4731 // Trace Allocate -> Proj[Parm] -> Initialize
4732 InitializeNode* AllocateNode::initialization() {
4733 ProjNode* rawoop = proj_out_or_null(AllocateNode::RawAddress);
4734 if (rawoop == nullptr) return nullptr;
4735 for (DUIterator_Fast imax, i = rawoop->fast_outs(imax); i < imax; i++) {
4736 Node* init = rawoop->fast_out(i);
4737 if (init->is_Initialize()) {
4738 assert(init->as_Initialize()->allocation() == this, "2-way link");
4739 return init->as_Initialize();
4740 }
4741 }
4742 return nullptr;
4743 }
4744
4745 // Add a Parse Predicate with an uncommon trap on the failing/false path. Normal control will continue on the true path.
4746 void GraphKit::add_parse_predicate(Deoptimization::DeoptReason reason, const int nargs) {
4747 // Too many traps seen?
4748 if (too_many_traps(reason)) {
4749 #ifdef ASSERT
4750 if (TraceLoopPredicate) {
4751 int tc = C->trap_count(reason);
4752 tty->print("too many traps=%s tcount=%d in ",
4753 Deoptimization::trap_reason_name(reason), tc);
4754 method()->print(); // which method has too many predicate traps
4755 tty->cr();
4756 }
4757 #endif
4758 // We cannot afford to take more traps here,
4759 // do not generate Parse Predicate.
4760 return;
4761 }
4762
4763 ParsePredicateNode* parse_predicate = new ParsePredicateNode(control(), reason, &_gvn);
4764 _gvn.set_type(parse_predicate, parse_predicate->Value(&_gvn));
4765 Node* if_false = _gvn.transform(new IfFalseNode(parse_predicate));
4766 {
4767 PreserveJVMState pjvms(this);
4768 set_control(if_false);
4769 inc_sp(nargs);
4770 uncommon_trap(reason, Deoptimization::Action_maybe_recompile);
4771 }
4772 Node* if_true = _gvn.transform(new IfTrueNode(parse_predicate));
4773 set_control(if_true);
4774 }
4775
4776 // Add Parse Predicates which serve as placeholders to create new Runtime Predicates above them. All
4777 // Runtime Predicates inside a Runtime Predicate block share the same uncommon trap as the Parse Predicate.
4778 void GraphKit::add_parse_predicates(int nargs) {
4779 if (ShortRunningLongLoop) {
4780 // Will narrow the limit down with a cast node. Predicates added later may depend on the cast so should be last when
4781 // walking up from the loop.
4782 add_parse_predicate(Deoptimization::Reason_short_running_long_loop, nargs);
4783 }
4784 if (UseLoopPredicate) {
4785 add_parse_predicate(Deoptimization::Reason_predicate, nargs);
4786 if (UseProfiledLoopPredicate) {
4787 add_parse_predicate(Deoptimization::Reason_profile_predicate, nargs);
4788 }
4789 }
4790 if (UseAutoVectorizationPredicate) {
4791 add_parse_predicate(Deoptimization::Reason_auto_vectorization_check, nargs);
4792 }
4793 // Loop Limit Check Predicate should be near the loop.
4794 add_parse_predicate(Deoptimization::Reason_loop_limit_check, nargs);
4795 }
4796
4797 void GraphKit::sync_kit(IdealKit& ideal) {
4798 reset_memory();
4799 set_all_memory(ideal.merged_memory());
4800 set_i_o(ideal.i_o());
4801 set_control(ideal.ctrl());
4802 }
4803
4804 void GraphKit::final_sync(IdealKit& ideal) {
4805 // Final sync IdealKit and graphKit.
4806 sync_kit(ideal);
4807 }
4808
4809 Node* GraphKit::load_String_length(Node* str, bool set_ctrl) {
4810 Node* len = load_array_length(load_String_value(str, set_ctrl));
4811 Node* coder = load_String_coder(str, set_ctrl);
4812 // Divide length by 2 if coder is UTF16
4813 return _gvn.transform(new RShiftINode(len, coder));
4814 }
4815
4816 Node* GraphKit::load_String_value(Node* str, bool set_ctrl) {
4817 int value_offset = java_lang_String::value_offset();
4818 const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4819 false, nullptr, Type::Offset(0));
4820 const TypePtr* value_field_type = string_type->add_offset(value_offset);
4821 const TypeAryPtr* value_type = TypeAryPtr::make(TypePtr::BotPTR,
4822 TypeAry::make(TypeInt::BYTE, TypeInt::POS, false, false, true, true, true),
4823 ciTypeArrayKlass::make(T_BYTE), true, Type::Offset(0));
4824 Node* p = basic_plus_adr(str, str, value_offset);
4825 Node* load = access_load_at(str, p, value_field_type, value_type, T_OBJECT,
4826 IN_HEAP | (set_ctrl ? C2_CONTROL_DEPENDENT_LOAD : 0) | MO_UNORDERED);
4827 return must_be_not_null(load, true);
4828 }
4829
4830 Node* GraphKit::load_String_coder(Node* str, bool set_ctrl) {
4831 if (!CompactStrings) {
4832 return intcon(java_lang_String::CODER_UTF16);
4833 }
4834 int coder_offset = java_lang_String::coder_offset();
4835 const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4836 false, nullptr, Type::Offset(0));
4837 const TypePtr* coder_field_type = string_type->add_offset(coder_offset);
4838
4839 Node* p = basic_plus_adr(str, str, coder_offset);
4840 Node* load = access_load_at(str, p, coder_field_type, TypeInt::BYTE, T_BYTE,
4841 IN_HEAP | (set_ctrl ? C2_CONTROL_DEPENDENT_LOAD : 0) | MO_UNORDERED);
4842 return load;
4843 }
4844
4845 void GraphKit::store_String_value(Node* str, Node* value) {
4846 int value_offset = java_lang_String::value_offset();
4847 const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4848 false, nullptr, Type::Offset(0));
4849 const TypePtr* value_field_type = string_type->add_offset(value_offset);
4850
4851 access_store_at(str, basic_plus_adr(str, value_offset), value_field_type,
4852 value, TypeAryPtr::BYTES, T_OBJECT, IN_HEAP | MO_UNORDERED);
4853 }
4854
4855 void GraphKit::store_String_coder(Node* str, Node* value) {
4856 int coder_offset = java_lang_String::coder_offset();
4857 const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4858 false, nullptr, Type::Offset(0));
4859 const TypePtr* coder_field_type = string_type->add_offset(coder_offset);
4860
4861 access_store_at(str, basic_plus_adr(str, coder_offset), coder_field_type,
4862 value, TypeInt::BYTE, T_BYTE, IN_HEAP | MO_UNORDERED);
4863 }
4864
4865 // If input and output memory types differ, capture the whole memory to preserve
4866 // the dependency between preceding and subsequent loads/stores.
4867 // For example, the following program:
4868 // StoreB
4869 // compress_string
4870 // LoadB
4871 // has this memory graph (use->def):
4872 // LoadB -> compress_string -> CharMem
4873 // ... -> StoreB -> ByteMem
4874 // The intrinsic hides the dependency between LoadB and StoreB, causing
4875 // the load to read from memory not containing the result of the StoreB.
4876 // The correct memory graph should look like this:
4877 // LoadB -> compress_string -> MergeMem -> StoreB
4878 Node* GraphKit::capture_memory(const TypePtr*& combined_type, const TypePtr* src_type, const TypePtr* dst_type) {
4879 if (src_type == dst_type) {
4880 // Types are equal, we don't need a MergeMemNode
4881 combined_type = src_type;
4882 return memory(src_type);
4883 }
4884 Node* mem = reset_memory();
4885 set_all_memory(mem);
4886 combined_type = TypePtr::BOTTOM;
4887 return mem;
4888 }
4889
4890 // If dst_type and src_type are different, str may have an anti-dependency with another node
4891 // consuming src_type.
4892 // For example:
4893 // compress_string
4894 // StoreC
4895 // has this memory graph (use->def):
4896 // compress_string -> MergeMem -> CharMem
4897 // StoreC
4898 // The scheduler needs to ensure that compress_string is not executed after StoreC, or it will read
4899 // the wrong memory. For normal loads, the scheduler computes its anti-dependencies to ensure the
4900 // memory it reads from is not killed. Since we do not compute anti-dependencies for
4901 // StrCompressedCopyNode, manually insert a MemBar so the anti-dependency becomes use-def
4902 // dependency:
4903 // StoreC -> MemBar -> MergeMem -> compress_string -> MergeMem -> CharMem
4904 // -------------------------------->
4905 void GraphKit::memory_effect(Node* res_mem, const TypePtr* src_type, const TypePtr* dst_type) {
4906 set_memory(res_mem, dst_type);
4907 if (src_type != dst_type) {
4908 Node* all_mem = reset_memory();
4909 set_all_memory(all_mem);
4910 Node* membar = new MemBarCPUOrderNode(C, C->get_alias_index(src_type), nullptr);
4911 membar->init_req(TypeFunc::Control, control());
4912 membar->init_req(TypeFunc::Memory, all_mem);
4913 membar = _gvn.transform(membar);
4914 set_control(_gvn.transform(new ProjNode(membar, TypeFunc::Control)));
4915 set_memory(_gvn.transform(new ProjNode(membar, TypeFunc::Memory)), src_type);
4916 }
4917 }
4918
4919 Node* GraphKit::compress_string(Node* src, const TypeAryPtr* src_type, Node* dst, Node* count) {
4920 assert(Matcher::match_rule_supported(Op_StrCompressedCopy), "Intrinsic not supported");
4921 assert(src_type == TypeAryPtr::BYTES || src_type == TypeAryPtr::CHARS, "invalid source type");
4922 const TypePtr* dst_type = TypeAryPtr::BYTES;
4923 const TypePtr* adr_type;
4924 Node* mem = capture_memory(adr_type, src_type, dst_type);
4925 StrCompressedCopyNode* str = new StrCompressedCopyNode(control(), mem, adr_type, src, dst, count);
4926 Node* res_mem = _gvn.transform(new SCMemProjNode(_gvn.transform(str)));
4927 memory_effect(res_mem, src_type, dst_type);
4928 return str;
4929 }
4930
4931 void GraphKit::inflate_string(Node* src, Node* dst, const TypeAryPtr* dst_type, Node* count) {
4932 assert(Matcher::match_rule_supported(Op_StrInflatedCopy), "Intrinsic not supported");
4933 assert(dst_type == TypeAryPtr::BYTES || dst_type == TypeAryPtr::CHARS, "invalid dest type");
4934 const TypePtr* src_type = TypeAryPtr::BYTES;
4935 const TypePtr* adr_type;
4936 Node* mem = capture_memory(adr_type, src_type, dst_type);
4937 StrInflatedCopyNode* str = new StrInflatedCopyNode(control(), mem, adr_type, src, dst, count);
4938 Node* res_mem = _gvn.transform(str);
4939 memory_effect(res_mem, src_type, dst_type);
4940 }
4941
4942 void GraphKit::inflate_string_slow(Node* src, Node* dst, Node* start, Node* count) {
4943 /**
4944 * int i_char = start;
4945 * for (int i_byte = 0; i_byte < count; i_byte++) {
4946 * dst[i_char++] = (char)(src[i_byte] & 0xff);
4947 * }
4948 */
4949 add_parse_predicates();
4950 C->set_has_loops(true);
4951
4952 RegionNode* head = new RegionNode(3);
4953 head->init_req(1, control());
4954 gvn().set_type(head, Type::CONTROL);
4955 record_for_igvn(head);
4956
4957 Node* i_byte = new PhiNode(head, TypeInt::INT);
4958 i_byte->init_req(1, intcon(0));
4959 gvn().set_type(i_byte, TypeInt::INT);
4960 record_for_igvn(i_byte);
4961
4962 Node* i_char = new PhiNode(head, TypeInt::INT);
4963 i_char->init_req(1, start);
4964 gvn().set_type(i_char, TypeInt::INT);
4965 record_for_igvn(i_char);
4966
4967 Node* mem = PhiNode::make(head, memory(TypeAryPtr::BYTES), Type::MEMORY, TypeAryPtr::BYTES);
4968 gvn().set_type(mem, Type::MEMORY);
4969 record_for_igvn(mem);
4970 set_control(head);
4971 set_memory(mem, TypeAryPtr::BYTES);
4972 Node* ch = load_array_element(src, i_byte, TypeAryPtr::BYTES, /* set_ctrl */ true);
4973 Node* st = store_to_memory(control(), array_element_address(dst, i_char, T_BYTE),
4974 AndI(ch, intcon(0xff)), T_CHAR, MemNode::unordered, false,
4975 false, true /* mismatched */);
4976
4977 IfNode* iff = create_and_map_if(head, Bool(CmpI(i_byte, count), BoolTest::lt), PROB_FAIR, COUNT_UNKNOWN);
4978 head->init_req(2, IfTrue(iff));
4979 mem->init_req(2, st);
4980 i_byte->init_req(2, AddI(i_byte, intcon(1)));
4981 i_char->init_req(2, AddI(i_char, intcon(2)));
4982
4983 set_control(IfFalse(iff));
4984 set_memory(st, TypeAryPtr::BYTES);
4985 }
4986
4987 Node* GraphKit::make_constant_from_field(ciField* field, Node* obj) {
4988 if (!field->is_constant()) {
4989 return nullptr; // Field not marked as constant.
4990 }
4991 ciInstance* holder = nullptr;
4992 if (!field->is_static()) {
4993 ciObject* const_oop = obj->bottom_type()->is_oopptr()->const_oop();
4994 if (const_oop != nullptr && const_oop->is_instance()) {
4995 holder = const_oop->as_instance();
4996 }
4997 }
4998 const Type* con_type = Type::make_constant_from_field(field, holder, field->layout_type(),
4999 /*is_unsigned_load=*/false);
5000 if (con_type != nullptr) {
5001 Node* con = makecon(con_type);
5002 if (field->type()->is_inlinetype()) {
5003 con = InlineTypeNode::make_from_oop(this, con, field->type()->as_inline_klass());
5004 } else if (con_type->is_inlinetypeptr()) {
5005 con = InlineTypeNode::make_from_oop(this, con, con_type->inline_klass());
5006 }
5007 return con;
5008 }
5009 return nullptr;
5010 }
5011
5012 Node* GraphKit::maybe_narrow_object_type(Node* obj, ciKlass* type, bool maybe_larval) {
5013 const Type* obj_type = obj->bottom_type();
5014 const TypeOopPtr* sig_type = TypeOopPtr::make_from_klass(type);
5015 if (obj_type->isa_oopptr() && sig_type->is_loaded() && !obj_type->higher_equal(sig_type)) {
5016 const Type* narrow_obj_type = obj_type->filter_speculative(sig_type); // keep speculative part
5017 Node* casted_obj = gvn().transform(new CheckCastPPNode(control(), obj, narrow_obj_type));
5018 obj = casted_obj;
5019 }
5020 if (!maybe_larval && sig_type->is_inlinetypeptr()) {
5021 obj = InlineTypeNode::make_from_oop(this, obj, sig_type->inline_klass());
5022 }
5023 return obj;
5024 }