1 /*
  2  * Copyright (c) 2001, 2023, 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 #ifndef SHARE_OPTO_GRAPHKIT_HPP
 26 #define SHARE_OPTO_GRAPHKIT_HPP
 27 
 28 #include "ci/ciEnv.hpp"
 29 #include "ci/ciMethodData.hpp"
 30 #include "gc/shared/c2/barrierSetC2.hpp"
 31 #include "opto/addnode.hpp"
 32 #include "opto/callnode.hpp"
 33 #include "opto/cfgnode.hpp"
 34 #include "opto/compile.hpp"
 35 #include "opto/divnode.hpp"
 36 #include "opto/inlinetypenode.hpp"
 37 #include "opto/mulnode.hpp"
 38 #include "opto/phaseX.hpp"
 39 #include "opto/subnode.hpp"
 40 #include "opto/type.hpp"
 41 #include "runtime/deoptimization.hpp"
 42 
 43 class BarrierSetC2;
 44 class FastLockNode;
 45 class FastUnlockNode;
 46 class IdealKit;
 47 class LibraryCallKit;
 48 class Parse;
 49 class RootNode;
 50 
 51 //-----------------------------------------------------------------------------
 52 //----------------------------GraphKit-----------------------------------------
 53 // Toolkit for building the common sorts of subgraphs.
 54 // Does not know about bytecode parsing or type-flow results.
 55 // It is able to create graphs implementing the semantics of most
 56 // or all bytecodes, so that it can expand intrinsics and calls.
 57 // It may depend on JVMState structure, but it must not depend
 58 // on specific bytecode streams.
 59 class GraphKit : public Phase {
 60   friend class PreserveJVMState;
 61 
 62  protected:
 63   ciEnv*            _env;       // Compilation environment
 64   PhaseGVN         &_gvn;       // Some optimizations while parsing
 65   SafePointNode*    _map;       // Parser map from JVM to Nodes
 66   SafePointNode*    _exceptions;// Parser map(s) for exception state(s)
 67   int               _bci;       // JVM Bytecode Pointer
 68   ciMethod*         _method;    // JVM Current Method
 69   BarrierSetC2*     _barrier_set;
 70 #ifdef ASSERT
 71   uint              _worklist_size;
 72 #endif
 73 
 74  private:
 75   int               _sp;        // JVM Expression Stack Pointer; don't modify directly!
 76 
 77  private:
 78   SafePointNode*     map_not_null() const {
 79     assert(_map != nullptr, "must call stopped() to test for reset compiler map");
 80     return _map;
 81   }
 82 
 83  public:
 84   GraphKit();                   // empty constructor
 85   GraphKit(JVMState* jvms, PhaseGVN* gvn = nullptr);     // the JVM state on which to operate
 86 
 87 #ifdef ASSERT
 88   ~GraphKit() {
 89     assert(!has_exceptions(), "user must call transfer_exceptions_into_jvms");
 90 #if 0
 91     // During incremental inlining, the Node_Array of the C->for_igvn() worklist and the IGVN
 92     // worklist are shared but the _in_worklist VectorSet is not. To avoid inconsistencies,
 93     // we should not add nodes to the _for_igvn worklist when using IGVN for the GraphKit.
 94     assert((_gvn.is_IterGVN() == nullptr) || (_gvn.C->for_igvn()->size() == _worklist_size),
 95            "GraphKit should not modify _for_igvn worklist after parsing");
 96 #endif
 97   }
 98 #endif
 99 
100   virtual Parse*          is_Parse()          const { return nullptr; }
101   virtual LibraryCallKit* is_LibraryCallKit() const { return nullptr; }
102 
103   ciEnv*        env()               const { return _env; }
104   PhaseGVN&     gvn()               const { return _gvn; }
105   void*         barrier_set_state() const { return C->barrier_set_state(); }
106 
107   void record_for_igvn(Node* n) const { _gvn.record_for_igvn(n); }
108   void remove_for_igvn(Node* n) const { C->remove_for_igvn(n); }
109 
110   // Handy well-known nodes:
111   Node*         null()          const { return zerocon(T_OBJECT); }
112   Node*         top()           const { return C->top(); }
113   RootNode*     root()          const { return C->root(); }
114 
115   // Create or find a constant node
116   Node* intcon(jint con)        const { return _gvn.intcon(con); }
117   Node* longcon(jlong con)      const { return _gvn.longcon(con); }
118   Node* integercon(jlong con, BasicType bt)   const {
119     if (bt == T_INT) {
120       return intcon(checked_cast<jint>(con));
121     }
122     assert(bt == T_LONG, "basic type not an int or long");
123     return longcon(con);
124   }
125   Node* makecon(const Type *t)  const { return _gvn.makecon(t); }
126   Node* zerocon(BasicType bt)   const { return _gvn.zerocon(bt); }
127   // (See also macro MakeConX in type.hpp, which uses intcon or longcon.)
128 
129   jint  find_int_con(Node* n, jint value_if_unknown) {
130     return _gvn.find_int_con(n, value_if_unknown);
131   }
132   jlong find_long_con(Node* n, jlong value_if_unknown) {
133     return _gvn.find_long_con(n, value_if_unknown);
134   }
135   // (See also macro find_intptr_t_con in type.hpp, which uses one of these.)
136 
137   // JVM State accessors:
138   // Parser mapping from JVM indices into Nodes.
139   // Low slots are accessed by the StartNode::enum.
140   // Then come the locals at StartNode::Parms to StartNode::Parms+max_locals();
141   // Then come JVM stack slots.
142   // Finally come the monitors, if any.
143   // See layout accessors in class JVMState.
144 
145   SafePointNode*     map()      const { return _map; }
146   bool               has_exceptions() const { return _exceptions != nullptr; }
147   JVMState*          jvms()     const { return map_not_null()->_jvms; }
148   int                sp()       const { return _sp; }
149   int                bci()      const { return _bci; }
150   Bytecodes::Code    java_bc()  const;
151   ciMethod*          method()   const { return _method; }
152 
153   void set_jvms(JVMState* jvms)       { set_map(jvms->map());
154                                         assert(jvms == this->jvms(), "sanity");
155                                         _sp = jvms->sp();
156                                         _bci = jvms->bci();
157                                         _method = jvms->has_method() ? jvms->method() : nullptr; }
158   void set_map(SafePointNode* m)      { _map = m; debug_only(verify_map()); }
159   void set_sp(int sp)                 { assert(sp >= 0, "sp must be non-negative: %d", sp); _sp = sp; }
160   void clean_stack(int from_sp); // clear garbage beyond from_sp to top
161 
162   void inc_sp(int i)                  { set_sp(sp() + i); }
163   void dec_sp(int i)                  { set_sp(sp() - i); }
164   void set_bci(int bci)               { _bci = bci; }
165 
166   // Make sure jvms has current bci & sp.
167   JVMState* sync_jvms() const;
168   JVMState* sync_jvms_for_reexecute();
169 
170 #ifdef ASSERT
171   // Make sure JVMS has an updated copy of bci and sp.
172   // Also sanity-check method, depth, and monitor depth.
173   bool jvms_in_sync() const;
174 
175   // Make sure the map looks OK.
176   void verify_map() const;
177 
178   // Make sure a proposed exception state looks OK.
179   static void verify_exception_state(SafePointNode* ex_map);
180 #endif
181 
182   // Clone the existing map state.  (Implements PreserveJVMState.)
183   SafePointNode* clone_map();
184 
185   // Reverses the work done by clone_map(). Should only be used when the node returned by
186   // clone_map() is ultimately not used. Calling Node::destruct directly in the previously
187   // mentioned circumstance instead of this method may result in use-after-free.
188   void destruct_map_clone(SafePointNode* sfp);
189 
190   // Set the map to a clone of the given one.
191   void set_map_clone(SafePointNode* m);
192 
193   // Tell if the compilation is failing.
194   bool failing() const { return C->failing(); }
195 
196   // Set _map to null, signalling a stop to further bytecode execution.
197   // Preserve the map intact for future use, and return it back to the caller.
198   SafePointNode* stop() { SafePointNode* m = map(); set_map(nullptr); return m; }
199 
200   // Stop, but first smash the map's inputs to null, to mark it dead.
201   void stop_and_kill_map();
202 
203   // Tell if _map is null, or control is top.
204   bool stopped();
205 
206   // Tell if this method or any caller method has exception handlers.
207   bool has_ex_handler();
208 
209   // Save an exception without blowing stack contents or other JVM state.
210   // (The extra pointer is stuck with add_req on the map, beyond the JVMS.)
211   static void set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop);
212 
213   // Recover a saved exception from its map.
214   static Node* saved_ex_oop(SafePointNode* ex_map);
215 
216   // Recover a saved exception from its map, and remove it from the map.
217   static Node* clear_saved_ex_oop(SafePointNode* ex_map);
218 
219 #ifdef ASSERT
220   // Recover a saved exception from its map, and remove it from the map.
221   static bool has_saved_ex_oop(SafePointNode* ex_map);
222 #endif
223 
224   // Push an exception in the canonical position for handlers (stack(0)).
225   void push_ex_oop(Node* ex_oop) {
226     ensure_stack(1);  // ensure room to push the exception
227     set_stack(0, ex_oop);
228     set_sp(1);
229     clean_stack(1);
230   }
231 
232   // Detach and return an exception state.
233   SafePointNode* pop_exception_state() {
234     SafePointNode* ex_map = _exceptions;
235     if (ex_map != nullptr) {
236       _exceptions = ex_map->next_exception();
237       ex_map->set_next_exception(nullptr);
238       debug_only(verify_exception_state(ex_map));
239     }
240     return ex_map;
241   }
242 
243   // Add an exception, using the given JVM state, without commoning.
244   void push_exception_state(SafePointNode* ex_map) {
245     debug_only(verify_exception_state(ex_map));
246     ex_map->set_next_exception(_exceptions);
247     _exceptions = ex_map;
248   }
249 
250   // Turn the current JVM state into an exception state, appending the ex_oop.
251   SafePointNode* make_exception_state(Node* ex_oop);
252 
253   // Add an exception, using the given JVM state.
254   // Combine all exceptions with a common exception type into a single state.
255   // (This is done via combine_exception_states.)
256   void add_exception_state(SafePointNode* ex_map);
257 
258   // Combine all exceptions of any sort whatever into a single master state.
259   SafePointNode* combine_and_pop_all_exception_states() {
260     if (_exceptions == nullptr)  return nullptr;
261     SafePointNode* phi_map = pop_exception_state();
262     SafePointNode* ex_map;
263     while ((ex_map = pop_exception_state()) != nullptr) {
264       combine_exception_states(ex_map, phi_map);
265     }
266     return phi_map;
267   }
268 
269   // Combine the two exception states, building phis as necessary.
270   // The second argument is updated to include contributions from the first.
271   void combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map);
272 
273   // Reset the map to the given state.  If there are any half-finished phis
274   // in it (created by combine_exception_states), transform them now.
275   // Returns the exception oop.  (Caller must call push_ex_oop if required.)
276   Node* use_exception_state(SafePointNode* ex_map);
277 
278   // Collect exceptions from a given JVM state into my exception list.
279   void add_exception_states_from(JVMState* jvms);
280 
281   // Collect all raised exceptions into the current JVM state.
282   // Clear the current exception list and map, returns the combined states.
283   JVMState* transfer_exceptions_into_jvms();
284 
285   // Helper to throw a built-in exception.
286   // The JVMS must allow the bytecode to be re-executed via an uncommon trap.
287   void builtin_throw(Deoptimization::DeoptReason reason);
288 
289   // Helper to check the JavaThread::_should_post_on_exceptions flag
290   // and branch to an uncommon_trap if it is true (with the specified reason and must_throw)
291   void uncommon_trap_if_should_post_on_exceptions(Deoptimization::DeoptReason reason,
292                                                   bool must_throw) ;
293 
294   // Helper Functions for adding debug information
295   void kill_dead_locals();
296 #ifdef ASSERT
297   bool dead_locals_are_killed();
298 #endif
299   // The call may deoptimize.  Supply required JVM state as debug info.
300   // If must_throw is true, the call is guaranteed not to return normally.
301   void add_safepoint_edges(SafePointNode* call,
302                            bool must_throw = false);
303 
304   // How many stack inputs does the current BC consume?
305   // And, how does the stack change after the bytecode?
306   // Returns false if unknown.
307   bool compute_stack_effects(int& inputs, int& depth);
308 
309   // Add a fixed offset to a pointer
310   Node* basic_plus_adr(Node* base, Node* ptr, intptr_t offset) {
311     return basic_plus_adr(base, ptr, MakeConX(offset));
312   }
313   Node* basic_plus_adr(Node* base, intptr_t offset) {
314     return basic_plus_adr(base, base, MakeConX(offset));
315   }
316   // Add a variable offset to a pointer
317   Node* basic_plus_adr(Node* base, Node* offset) {
318     return basic_plus_adr(base, base, offset);
319   }
320   Node* basic_plus_adr(Node* base, Node* ptr, Node* offset);
321 
322 
323   // Some convenient shortcuts for common nodes
324   Node* IfTrue(IfNode* iff)                   { return _gvn.transform(new IfTrueNode(iff));      }
325   Node* IfFalse(IfNode* iff)                  { return _gvn.transform(new IfFalseNode(iff));     }
326 
327   Node* AddI(Node* l, Node* r)                { return _gvn.transform(new AddINode(l, r));       }
328   Node* SubI(Node* l, Node* r)                { return _gvn.transform(new SubINode(l, r));       }
329   Node* MulI(Node* l, Node* r)                { return _gvn.transform(new MulINode(l, r));       }
330   Node* DivI(Node* ctl, Node* l, Node* r)     { return _gvn.transform(new DivINode(ctl, l, r));  }
331 
332   Node* AndI(Node* l, Node* r)                { return _gvn.transform(new AndINode(l, r));       }
333   Node* OrI(Node* l, Node* r)                 { return _gvn.transform(new OrINode(l, r));        }
334   Node* XorI(Node* l, Node* r)                { return _gvn.transform(new XorINode(l, r));       }
335 
336   Node* MaxI(Node* l, Node* r)                { return _gvn.transform(new MaxINode(l, r));       }
337   Node* MinI(Node* l, Node* r)                { return _gvn.transform(new MinINode(l, r));       }
338 
339   Node* LShiftI(Node* l, Node* r)             { return _gvn.transform(new LShiftINode(l, r));    }
340   Node* RShiftI(Node* l, Node* r)             { return _gvn.transform(new RShiftINode(l, r));    }
341   Node* URShiftI(Node* l, Node* r)            { return _gvn.transform(new URShiftINode(l, r));   }
342 
343   Node* CmpI(Node* l, Node* r)                { return _gvn.transform(new CmpINode(l, r));       }
344   Node* CmpL(Node* l, Node* r)                { return _gvn.transform(new CmpLNode(l, r));       }
345   Node* CmpP(Node* l, Node* r)                { return _gvn.transform(new CmpPNode(l, r));       }
346   Node* Bool(Node* cmp, BoolTest::mask relop) { return _gvn.transform(new BoolNode(cmp, relop)); }
347 
348   Node* AddP(Node* b, Node* a, Node* o)       { return _gvn.transform(new AddPNode(b, a, o));    }
349 
350   // Convert between int and long, and size_t.
351   // (See macros ConvI2X, etc., in type.hpp for ConvI2X, etc.)
352   Node* ConvI2L(Node* offset);
353   Node* ConvI2UL(Node* offset);
354   Node* ConvL2I(Node* offset);
355   // Find out the klass of an object.
356   Node* load_object_klass(Node* object);
357   // Find out the length of an array.
358   Node* load_array_length(Node* array);
359   // Cast array allocation's length as narrow as possible.
360   // If replace_length_in_map is true, replace length with CastIINode in map.
361   // This method is invoked after creating/moving ArrayAllocationNode or in load_array_length
362   Node* array_ideal_length(AllocateArrayNode* alloc,
363                            const TypeOopPtr* oop_type,
364                            bool replace_length_in_map);
365 
366 
367   // Helper function to do a null pointer check or ZERO check based on type.
368   // Throw an exception if a given value is null.
369   // Return the value cast to not-null.
370   // Be clever about equivalent dominating null checks.
371   Node* null_check_common(Node* value, BasicType type,
372                           bool assert_null = false,
373                           Node* *null_control = nullptr,
374                           bool speculative = false,
375                           bool is_init_check = false);
376   Node* null_check(Node* value, BasicType type = T_OBJECT) {
377     return null_check_common(value, type, false, nullptr, !_gvn.type(value)->speculative_maybe_null());
378   }
379   Node* null_check_receiver() {
380     return null_check(argument(0));
381   }
382   Node* zero_check_int(Node* value) {
383     assert(value->bottom_type()->basic_type() == T_INT,
384            "wrong type: %s", type2name(value->bottom_type()->basic_type()));
385     return null_check_common(value, T_INT);
386   }
387   Node* zero_check_long(Node* value) {
388     assert(value->bottom_type()->basic_type() == T_LONG,
389            "wrong type: %s", type2name(value->bottom_type()->basic_type()));
390     return null_check_common(value, T_LONG);
391   }
392   // Throw an uncommon trap if a given value is __not__ null.
393   // Return the value cast to null, and be clever about dominating checks.
394   Node* null_assert(Node* value, BasicType type = T_OBJECT) {
395     return null_check_common(value, type, true, nullptr, _gvn.type(value)->speculative_always_null());
396   }
397 
398   // Check if value is null and abort if it is
399   Node* must_be_not_null(Node* value, bool do_replace_in_map);
400 
401   // Null check oop.  Return null-path control into (*null_control).
402   // Return a cast-not-null node which depends on the not-null control.
403   // If never_see_null, use an uncommon trap (*null_control sees a top).
404   // The cast is not valid along the null path; keep a copy of the original.
405   // If safe_for_replace, then we can replace the value with the cast
406   // in the parsing map (the cast is guaranteed to dominate the map)
407   Node* null_check_oop(Node* value, Node* *null_control,
408                        bool never_see_null = false,
409                        bool safe_for_replace = false,
410                        bool speculative = false);
411 
412   // Check the null_seen bit.
413   bool seems_never_null(Node* obj, ciProfileData* data, bool& speculating);
414 
415   void guard_klass_being_initialized(Node* klass);
416   void guard_init_thread(Node* klass);
417 
418   void clinit_barrier(ciInstanceKlass* ik, ciMethod* context);
419 
420   // Check for unique class for receiver at call
421   ciKlass* profile_has_unique_klass() {
422     ciCallProfile profile = method()->call_profile_at_bci(bci());
423     if (profile.count() >= 0 &&         // no cast failures here
424         profile.has_receiver(0) &&
425         profile.morphism() == 1) {
426       return profile.receiver(0);
427     }
428     return nullptr;
429   }
430 
431   // record type from profiling with the type system
432   Node* record_profile_for_speculation(Node* n, ciKlass* exact_kls, ProfilePtrKind ptr_kind);
433   void record_profiled_arguments_for_speculation(ciMethod* dest_method, Bytecodes::Code bc);
434   void record_profiled_parameters_for_speculation();
435   void record_profiled_return_for_speculation();
436   Node* record_profiled_receiver_for_speculation(Node* n);
437 
438   // Use the type profile to narrow an object type.
439   Node* maybe_cast_profiled_receiver(Node* not_null_obj,
440                                      const TypeKlassPtr* require_klass,
441                                      ciKlass* spec,
442                                      bool safe_for_replace);
443 
444   // Cast obj to type and emit guard unless we had too many traps here already
445   Node* maybe_cast_profiled_obj(Node* obj,
446                                 ciKlass* type,
447                                 bool not_null = false);
448 
449   // Cast obj to not-null on this path
450   Node* cast_not_null(Node* obj, bool do_replace_in_map = true);
451   // Replace all occurrences of one node by another.
452   void replace_in_map(Node* old, Node* neww);
453 
454   void  push(Node* n)     { map_not_null();        _map->set_stack(_map->_jvms,   _sp++        , n); }
455   Node* pop()             { map_not_null(); return _map->stack(    _map->_jvms, --_sp             ); }
456   Node* peek(int off = 0) { map_not_null(); return _map->stack(    _map->_jvms,   _sp - off - 1   ); }
457 
458   void push_pair(Node* ldval) {
459     push(ldval);
460     push(top());  // the halfword is merely a placeholder
461   }
462   void push_pair_local(int i) {
463     // longs are stored in locals in "push" order
464     push(  local(i+0) );  // the real value
465     assert(local(i+1) == top(), "");
466     push(top());  // halfword placeholder
467   }
468   Node* pop_pair() {
469     // the second half is pushed last & popped first; it contains exactly nothing
470     Node* halfword = pop();
471     assert(halfword == top(), "");
472     // the long bits are pushed first & popped last:
473     return pop();
474   }
475   void set_pair_local(int i, Node* lval) {
476     // longs are stored in locals as a value/half pair (like doubles)
477     set_local(i+0, lval);
478     set_local(i+1, top());
479   }
480 
481   // Push the node, which may be zero, one, or two words.
482   void push_node(BasicType n_type, Node* n) {
483     int n_size = type2size[n_type];
484     if      (n_size == 1)  push(      n );  // T_INT, ...
485     else if (n_size == 2)  push_pair( n );  // T_DOUBLE, T_LONG
486     else                   { assert(n_size == 0, "must be T_VOID"); }
487   }
488 
489   Node* pop_node(BasicType n_type) {
490     int n_size = type2size[n_type];
491     if      (n_size == 1)  return pop();
492     else if (n_size == 2)  return pop_pair();
493     else                   return nullptr;
494   }
495 
496   Node* control()               const { return map_not_null()->control(); }
497   Node* i_o()                   const { return map_not_null()->i_o(); }
498   Node* returnadr()             const { return map_not_null()->returnadr(); }
499   Node* frameptr()              const { return map_not_null()->frameptr(); }
500   Node* local(uint idx)         const { map_not_null(); return _map->local(      _map->_jvms, idx); }
501   Node* stack(uint idx)         const { map_not_null(); return _map->stack(      _map->_jvms, idx); }
502   Node* argument(uint idx)      const { map_not_null(); return _map->argument(   _map->_jvms, idx); }
503   Node* monitor_box(uint idx)   const { map_not_null(); return _map->monitor_box(_map->_jvms, idx); }
504   Node* monitor_obj(uint idx)   const { map_not_null(); return _map->monitor_obj(_map->_jvms, idx); }
505 
506   void set_control  (Node* c)         { map_not_null()->set_control(c); }
507   void set_i_o      (Node* c)         { map_not_null()->set_i_o(c); }
508   void set_local(uint idx, Node* c)   { map_not_null(); _map->set_local(   _map->_jvms, idx, c); }
509   void set_stack(uint idx, Node* c)   { map_not_null(); _map->set_stack(   _map->_jvms, idx, c); }
510   void set_argument(uint idx, Node* c){ map_not_null(); _map->set_argument(_map->_jvms, idx, c); }
511   void ensure_stack(uint stk_size)    { map_not_null(); _map->ensure_stack(_map->_jvms, stk_size); }
512 
513   // Access unaliased memory
514   Node* memory(uint alias_idx);
515   Node* memory(const TypePtr *tp) { return memory(C->get_alias_index(tp)); }
516   Node* memory(Node* adr) { return memory(_gvn.type(adr)->is_ptr()); }
517 
518   // Access immutable memory
519   Node* immutable_memory() { return C->immutable_memory(); }
520 
521   // Set unaliased memory
522   void set_memory(Node* c, uint alias_idx) { merged_memory()->set_memory_at(alias_idx, c); }
523   void set_memory(Node* c, const TypePtr *tp) { set_memory(c,C->get_alias_index(tp)); }
524   void set_memory(Node* c, Node* adr) { set_memory(c,_gvn.type(adr)->is_ptr()); }
525 
526   // Get the entire memory state (probably a MergeMemNode), and reset it
527   // (The resetting prevents somebody from using the dangling Node pointer.)
528   Node* reset_memory();
529 
530   // Get the entire memory state, asserted to be a MergeMemNode.
531   MergeMemNode* merged_memory() {
532     Node* mem = map_not_null()->memory();
533     assert(mem->is_MergeMem(), "parse memory is always pre-split");
534     return mem->as_MergeMem();
535   }
536 
537   // Set the entire memory state; produce a new MergeMemNode.
538   void set_all_memory(Node* newmem);
539 
540   // Create a memory projection from the call, then set_all_memory.
541   void set_all_memory_call(Node* call, bool separate_io_proj = false);
542 
543   // Create a LoadNode, reading from the parser's memory state.
544   // (Note:  require_atomic_access is useful only with T_LONG.)
545   //
546   // We choose the unordered semantics by default because we have
547   // adapted the `do_put_xxx' and `do_get_xxx' procedures for the case
548   // of volatile fields.
549   Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt,
550                   MemNode::MemOrd mo, LoadNode::ControlDependency control_dependency = LoadNode::DependsOnlyOnTest,
551                   bool require_atomic_access = false, bool unaligned = false,
552                   bool mismatched = false, bool unsafe = false, uint8_t barrier_data = 0) {
553     // This version computes alias_index from bottom_type
554     return make_load(ctl, adr, t, bt, adr->bottom_type()->is_ptr(),
555                      mo, control_dependency, require_atomic_access,
556                      unaligned, mismatched, unsafe, barrier_data);
557   }
558   Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, const TypePtr* adr_type,
559                   MemNode::MemOrd mo, LoadNode::ControlDependency control_dependency = LoadNode::DependsOnlyOnTest,
560                   bool require_atomic_access = false, bool unaligned = false,
561                   bool mismatched = false, bool unsafe = false, uint8_t barrier_data = 0) {
562     // This version computes alias_index from an address type
563     assert(adr_type != nullptr, "use other make_load factory");
564     return make_load(ctl, adr, t, bt, C->get_alias_index(adr_type),
565                      mo, control_dependency, require_atomic_access,
566                      unaligned, mismatched, unsafe, barrier_data);
567   }
568   // This is the base version which is given an alias index.
569   Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, int adr_idx,
570                   MemNode::MemOrd mo, LoadNode::ControlDependency control_dependency = LoadNode::DependsOnlyOnTest,
571                   bool require_atomic_access = false, bool unaligned = false,
572                   bool mismatched = false, bool unsafe = false, uint8_t barrier_data = 0);
573 
574   // Create & transform a StoreNode and store the effect into the
575   // parser's memory state.
576   //
577   // We must ensure that stores of object references will be visible
578   // only after the object's initialization. So the clients of this
579   // procedure must indicate that the store requires `release'
580   // semantics, if the stored value is an object reference that might
581   // point to a new object and may become externally visible.
582   Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
583                         const TypePtr* adr_type,
584                         MemNode::MemOrd mo,
585                         bool require_atomic_access = false,
586                         bool unaligned = false,
587                         bool mismatched = false,
588                         bool unsafe = false,
589                         int barrier_data = 0) {
590     // This version computes alias_index from an address type
591     assert(adr_type != nullptr, "use other store_to_memory factory");
592     return store_to_memory(ctl, adr, val, bt,
593                            C->get_alias_index(adr_type),
594                            mo, require_atomic_access,
595                            unaligned, mismatched, unsafe,
596                            barrier_data);
597   }
598   // This is the base version which is given alias index
599   // Return the new StoreXNode
600   Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
601                         int adr_idx,
602                         MemNode::MemOrd,
603                         bool require_atomic_access = false,
604                         bool unaligned = false,
605                         bool mismatched = false,
606                         bool unsafe = false,
607                         int barrier_data = 0);
608 
609   // Perform decorated accesses
610 
611   Node* access_store_at(Node* obj,   // containing obj
612                         Node* adr,   // actual address to store val at
613                         const TypePtr* adr_type,
614                         Node* val,
615                         const Type* val_type,
616                         BasicType bt,
617                         DecoratorSet decorators,
618                         bool safe_for_replace = true);
619 
620   Node* access_load_at(Node* obj,   // containing obj
621                        Node* adr,   // actual address to load val at
622                        const TypePtr* adr_type,
623                        const Type* val_type,
624                        BasicType bt,
625                        DecoratorSet decorators,
626                        Node* ctl = nullptr);
627 
628   Node* access_load(Node* adr,   // actual address to load val at
629                     const Type* val_type,
630                     BasicType bt,
631                     DecoratorSet decorators);
632 
633   Node* access_atomic_cmpxchg_val_at(Node* obj,
634                                      Node* adr,
635                                      const TypePtr* adr_type,
636                                      int alias_idx,
637                                      Node* expected_val,
638                                      Node* new_val,
639                                      const Type* value_type,
640                                      BasicType bt,
641                                      DecoratorSet decorators);
642 
643   Node* access_atomic_cmpxchg_bool_at(Node* obj,
644                                       Node* adr,
645                                       const TypePtr* adr_type,
646                                       int alias_idx,
647                                       Node* expected_val,
648                                       Node* new_val,
649                                       const Type* value_type,
650                                       BasicType bt,
651                                       DecoratorSet decorators);
652 
653   Node* access_atomic_xchg_at(Node* obj,
654                               Node* adr,
655                               const TypePtr* adr_type,
656                               int alias_idx,
657                               Node* new_val,
658                               const Type* value_type,
659                               BasicType bt,
660                               DecoratorSet decorators);
661 
662   Node* access_atomic_add_at(Node* obj,
663                              Node* adr,
664                              const TypePtr* adr_type,
665                              int alias_idx,
666                              Node* new_val,
667                              const Type* value_type,
668                              BasicType bt,
669                              DecoratorSet decorators);
670 
671   void access_clone(Node* src, Node* dst, Node* size, bool is_array);
672 
673   // Return addressing for an array element.
674   Node* array_element_address(Node* ary, Node* idx, BasicType elembt,
675                               // Optional constraint on the array size:
676                               const TypeInt* sizetype = nullptr,
677                               // Optional control dependency (for example, on range check)
678                               Node* ctrl = nullptr);
679 
680   // Return a load of array element at idx.
681   Node* load_array_element(Node* ary, Node* idx, const TypeAryPtr* arytype, bool set_ctrl);
682 
683   //---------------- Dtrace support --------------------
684   void make_dtrace_method_entry_exit(ciMethod* method, bool is_entry);
685   void make_dtrace_method_entry(ciMethod* method) {
686     make_dtrace_method_entry_exit(method, true);
687   }
688   void make_dtrace_method_exit(ciMethod* method) {
689     make_dtrace_method_entry_exit(method, false);
690   }
691 
692   //--------------- stub generation -------------------
693  public:
694   void gen_stub(address C_function,
695                 const char *name,
696                 int is_fancy_jump,
697                 bool pass_tls,
698                 bool return_pc);
699 
700   //---------- help for generating calls --------------
701 
702   // Do a null check on the receiver as it would happen before the call to
703   // callee (with all arguments still on the stack).
704   Node* null_check_receiver_before_call(ciMethod* callee, bool replace_value = true) {
705     assert(!callee->is_static(), "must be a virtual method");
706     // Callsite signature can be different from actual method being called (i.e _linkTo* sites).
707     // Use callsite signature always.
708     ciMethod* declared_method = method()->get_method_at_bci(bci());
709     const int nargs = declared_method->arg_size();
710     inc_sp(nargs);
711     Node* n = null_check_receiver();
712     dec_sp(nargs);
713     return n;
714   }
715 
716   // Fill in argument edges for the call from argument(0), argument(1), ...
717   // (The next step is to call set_edges_for_java_call.)
718   void  set_arguments_for_java_call(CallJavaNode* call, bool is_late_inline = false);
719 
720   // Fill in non-argument edges for the call.
721   // Transform the call, and update the basics: control, i_o, memory.
722   // (The next step is usually to call set_results_for_java_call.)
723   void set_edges_for_java_call(CallJavaNode* call,
724                                bool must_throw = false, bool separate_io_proj = false);
725 
726   // Finish up a java call that was started by set_edges_for_java_call.
727   // Call add_exception on any throw arising from the call.
728   // Return the call result (transformed).
729   Node* set_results_for_java_call(CallJavaNode* call, bool separate_io_proj = false, bool deoptimize = false);
730 
731   // Similar to set_edges_for_java_call, but simplified for runtime calls.
732   void  set_predefined_output_for_runtime_call(Node* call) {
733     set_predefined_output_for_runtime_call(call, nullptr, nullptr);
734   }
735   void  set_predefined_output_for_runtime_call(Node* call,
736                                                Node* keep_mem,
737                                                const TypePtr* hook_mem);
738   Node* set_predefined_input_for_runtime_call(SafePointNode* call, Node* narrow_mem = nullptr);
739 
740   // Replace the call with the current state of the kit.  Requires
741   // that the call was generated with separate io_projs so that
742   // exceptional control flow can be handled properly.
743   void replace_call(CallNode* call, Node* result, bool do_replaced_nodes = false);
744 
745   // helper functions for statistics
746   void increment_counter(address counter_addr);   // increment a debug counter
747   void increment_counter(Node*   counter_addr);   // increment a debug counter
748 
749   // Bail out to the interpreter right now
750   // The optional klass is the one causing the trap.
751   // The optional reason is debug information written to the compile log.
752   // Optional must_throw is the same as with add_safepoint_edges.
753   Node* uncommon_trap(int trap_request,
754                      ciKlass* klass = nullptr, const char* reason_string = nullptr,
755                      bool must_throw = false, bool keep_exact_action = false);
756 
757   // Shorthand, to avoid saying "Deoptimization::" so many times.
758   Node* uncommon_trap(Deoptimization::DeoptReason reason,
759                      Deoptimization::DeoptAction action,
760                      ciKlass* klass = nullptr, const char* reason_string = nullptr,
761                      bool must_throw = false, bool keep_exact_action = false) {
762     return uncommon_trap(Deoptimization::make_trap_request(reason, action),
763                   klass, reason_string, must_throw, keep_exact_action);
764   }
765 
766   // Bail out to the interpreter and keep exact action (avoid switching to Action_none).
767   Node* uncommon_trap_exact(Deoptimization::DeoptReason reason,
768                            Deoptimization::DeoptAction action,
769                            ciKlass* klass = nullptr, const char* reason_string = nullptr,
770                            bool must_throw = false) {
771     return uncommon_trap(Deoptimization::make_trap_request(reason, action),
772                   klass, reason_string, must_throw, /*keep_exact_action=*/true);
773   }
774 
775   // SP when bytecode needs to be reexecuted.
776   virtual int reexecute_sp() { return sp(); }
777 
778   // Report if there were too many traps at the current method and bci.
779   // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
780   // If there is no MDO at all, report no trap unless told to assume it.
781   bool too_many_traps(Deoptimization::DeoptReason reason) {
782     return C->too_many_traps(method(), bci(), reason);
783   }
784 
785   // Report if there were too many recompiles at the current method and bci.
786   bool too_many_recompiles(Deoptimization::DeoptReason reason) {
787     return C->too_many_recompiles(method(), bci(), reason);
788   }
789 
790   bool too_many_traps_or_recompiles(Deoptimization::DeoptReason reason) {
791       return C->too_many_traps_or_recompiles(method(), bci(), reason);
792   }
793 
794   // Returns the object (if any) which was created the moment before.
795   Node* just_allocated_object(Node* current_control);
796 
797   // Sync Ideal and Graph kits.
798   void sync_kit(IdealKit& ideal);
799   void final_sync(IdealKit& ideal);
800 
801   public:
802   // Helper function to round double arguments before a call
803   void round_double_arguments(ciMethod* dest_method);
804 
805   // rounding for strict float precision conformance
806   Node* precision_rounding(Node* n);
807 
808   // rounding for strict double precision conformance
809   Node* dprecision_rounding(Node* n);
810 
811   // Helper functions for fast/slow path codes
812   Node* opt_iff(Node* region, Node* iff);
813   Node* make_runtime_call(int flags,
814                           const TypeFunc* call_type, address call_addr,
815                           const char* call_name,
816                           const TypePtr* adr_type, // null if no memory effects
817                           Node* parm0 = nullptr, Node* parm1 = nullptr,
818                           Node* parm2 = nullptr, Node* parm3 = nullptr,
819                           Node* parm4 = nullptr, Node* parm5 = nullptr,
820                           Node* parm6 = nullptr, Node* parm7 = nullptr);
821 
822   Node* sign_extend_byte(Node* in);
823   Node* sign_extend_short(Node* in);
824 
825   enum {  // flag values for make_runtime_call
826     RC_NO_FP = 1,               // CallLeafNoFPNode
827     RC_NO_IO = 2,               // do not hook IO edges
828     RC_NO_LEAF = 4,             // CallStaticJavaNode
829     RC_MUST_THROW = 8,          // flag passed to add_safepoint_edges
830     RC_NARROW_MEM = 16,         // input memory is same as output
831     RC_UNCOMMON = 32,           // freq. expected to be like uncommon trap
832     RC_VECTOR = 64,             // CallLeafVectorNode
833     RC_LEAF = 0                 // null value:  no flags set
834   };
835 
836   // merge in all memory slices from new_mem, along the given path
837   void merge_memory(Node* new_mem, Node* region, int new_path);
838   void make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj, bool deoptimize = false);
839 
840   // Helper functions to build synchronizations
841   int next_monitor();
842   Node* insert_mem_bar(int opcode, Node* precedent = nullptr);
843   Node* insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent = nullptr);
844   // Optional 'precedent' is appended as an extra edge, to force ordering.
845   FastLockNode* shared_lock(Node* obj);
846   void shared_unlock(Node* box, Node* obj);
847 
848   // helper functions for the fast path/slow path idioms
849   Node* fast_and_slow(Node* in, const Type *result_type, Node* null_result, IfNode* fast_test, Node* fast_result, address slow_call, const TypeFunc *slow_call_type, Node* slow_arg, Klass* ex_klass, Node* slow_result);
850 
851   // Generate an instance-of idiom.  Used by both the instance-of bytecode
852   // and the reflective instance-of call.
853   Node* gen_instanceof(Node *subobj, Node* superkls, bool safe_for_replace = false);
854 
855   // Generate a check-cast idiom.  Used by both the check-cast bytecode
856   // and the array-store bytecode
857   Node* gen_checkcast(Node *subobj, Node* superkls, Node* *failure_control = nullptr, bool null_free = false);
858 
859   // Inline types
860   Node* inline_type_test(Node* obj, bool is_inline = true);
861   Node* is_val_mirror(Node* mirror);
862   Node* array_lh_test(Node* kls, jint mask, jint val, bool eq = true);
863   Node* flat_array_test(Node* array_or_klass, bool flat = true);
864   Node* null_free_array_test(Node* klass, bool null_free = true);
865   Node* inline_array_null_guard(Node* ary, Node* val, int nargs, bool safe_for_replace = false);
866 
867   Node* gen_subtype_check(Node* obj, Node* superklass);
868 
869   // Exact type check used for predicted calls and casts.
870   // Rewrites (*casted_receiver) to be casted to the stronger type.
871   // (Caller is responsible for doing replace_in_map.)
872   Node* type_check_receiver(Node* receiver, ciKlass* klass, float prob,
873                             Node* *casted_receiver);
874   Node* type_check(Node* recv_klass, const TypeKlassPtr* tklass, float prob);
875 
876   // Inexact type check used for predicted calls.
877   Node* subtype_check_receiver(Node* receiver, ciKlass* klass,
878                                Node** casted_receiver);
879 
880   // implementation of object creation
881   Node* set_output_for_allocation(AllocateNode* alloc,
882                                   const TypeOopPtr* oop_type,
883                                   bool deoptimize_on_exception=false);
884   Node* get_layout_helper(Node* klass_node, jint& constant_value);
885   Node* new_instance(Node* klass_node,
886                      Node* slow_test = nullptr,
887                      Node* *return_size_val = nullptr,
888                      bool deoptimize_on_exception = false,
889                      InlineTypeNode* inline_type_node = nullptr);
890   Node* new_array(Node* klass_node, Node* count_val, int nargs,
891                   Node* *return_size_val = nullptr,
892                   bool deoptimize_on_exception = false);
893 
894   // java.lang.String helpers
895   Node* load_String_length(Node* str, bool set_ctrl);
896   Node* load_String_value(Node* str, bool set_ctrl);
897   Node* load_String_coder(Node* str, bool set_ctrl);
898   void store_String_value(Node* str, Node* value);
899   void store_String_coder(Node* str, Node* value);
900   Node* capture_memory(const TypePtr* src_type, const TypePtr* dst_type);
901   Node* compress_string(Node* src, const TypeAryPtr* src_type, Node* dst, Node* count);
902   void inflate_string(Node* src, Node* dst, const TypeAryPtr* dst_type, Node* count);
903   void inflate_string_slow(Node* src, Node* dst, Node* start, Node* count);
904 
905   // Handy for making control flow
906   IfNode* create_and_map_if(Node* ctrl, Node* tst, float prob, float cnt) {
907     IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's
908     _gvn.set_type(iff, iff->Value(&_gvn)); // Value may be known at parse-time
909     // Place 'if' on worklist if it will be in graph
910     if (!tst->is_Con())  record_for_igvn(iff);     // Range-check and Null-check removal is later
911     return iff;
912   }
913 
914   IfNode* create_and_xform_if(Node* ctrl, Node* tst, float prob, float cnt) {
915     IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's
916     _gvn.transform(iff);                           // Value may be known at parse-time
917     // Place 'if' on worklist if it will be in graph
918     if (!tst->is_Con())  record_for_igvn(iff);     // Range-check and Null-check removal is later
919     return iff;
920   }
921 
922   void add_parse_predicates(int nargs = 0);
923   void add_parse_predicate(Deoptimization::DeoptReason reason, int nargs);
924 
925   Node* make_constant_from_field(ciField* field, Node* obj);
926   Node* load_mirror_from_klass(Node* klass);
927 
928   // Vector API support (implemented in vectorIntrinsics.cpp)
929   Node* box_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem, bool deoptimize_on_exception = false);
930   Node* unbox_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem, bool shuffle_to_vector = false);
931   Node* vector_shift_count(Node* cnt, int shift_op, BasicType bt, int num_elem);
932 };
933 
934 // Helper class to support building of control flow branches. Upon
935 // creation the map and sp at bci are cloned and restored upon de-
936 // struction. Typical use:
937 //
938 // { PreserveJVMState pjvms(this);
939 //   // code of new branch
940 // }
941 // // here the JVM state at bci is established
942 
943 class PreserveJVMState: public StackObj {
944  protected:
945   GraphKit*      _kit;
946 #ifdef ASSERT
947   int            _block;  // PO of current block, if a Parse
948   int            _bci;
949 #endif
950   SafePointNode* _map;
951   uint           _sp;
952 
953  public:
954   PreserveJVMState(GraphKit* kit, bool clone_map = true);
955   ~PreserveJVMState();
956 };
957 
958 // Helper class to build cutouts of the form if (p) ; else {x...}.
959 // The code {x...} must not fall through.
960 // The kit's main flow of control is set to the "then" continuation of if(p).
961 class BuildCutout: public PreserveJVMState {
962  public:
963   BuildCutout(GraphKit* kit, Node* p, float prob, float cnt = COUNT_UNKNOWN);
964   ~BuildCutout();
965 };
966 
967 // Helper class to preserve the original _reexecute bit and _sp and restore
968 // them back
969 class PreserveReexecuteState: public StackObj {
970  protected:
971   GraphKit*                 _kit;
972   uint                      _sp;
973   JVMState::ReexecuteState  _reexecute;
974 
975  public:
976   PreserveReexecuteState(GraphKit* kit);
977   ~PreserveReexecuteState();
978 };
979 
980 #endif // SHARE_OPTO_GRAPHKIT_HPP