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