1 /*
   2  * Copyright 2001-2009 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 class FastLockNode;
  26 class FastUnlockNode;
  27 class IdealKit;
  28 class Parse;
  29 class RootNode;
  30 
  31 //-----------------------------------------------------------------------------
  32 //----------------------------GraphKit-----------------------------------------
  33 // Toolkit for building the common sorts of subgraphs.
  34 // Does not know about bytecode parsing or type-flow results.
  35 // It is able to create graphs implementing the semantics of most
  36 // or all bytecodes, so that it can expand intrinsics and calls.
  37 // It may depend on JVMState structure, but it must not depend
  38 // on specific bytecode streams.
  39 class GraphKit : public Phase {
  40   friend class PreserveJVMState;
  41 
  42  protected:
  43   ciEnv*            _env;       // Compilation environment
  44   PhaseGVN         &_gvn;       // Some optimizations while parsing
  45   SafePointNode*    _map;       // Parser map from JVM to Nodes
  46   SafePointNode*    _exceptions;// Parser map(s) for exception state(s)
  47   int               _sp;        // JVM Expression Stack Pointer
  48   int               _bci;       // JVM Bytecode Pointer
  49   ciMethod*         _method;    // JVM Current Method
  50 
  51  private:
  52   SafePointNode*     map_not_null() const {
  53     assert(_map != NULL, "must call stopped() to test for reset compiler map");
  54     return _map;
  55   }
  56 
  57  public:
  58   GraphKit();                   // empty constructor
  59   GraphKit(JVMState* jvms);     // the JVM state on which to operate
  60 
  61 #ifdef ASSERT
  62   ~GraphKit() {
  63     assert(!has_exceptions(), "user must call transfer_exceptions_into_jvms");
  64   }
  65 #endif
  66 
  67   virtual Parse* is_Parse() const { return NULL; }
  68 
  69   ciEnv*        env()           const { return _env; }
  70   PhaseGVN&     gvn()           const { return _gvn; }
  71 
  72   void record_for_igvn(Node* n) const { C->record_for_igvn(n); }  // delegate to Compile
  73 
  74   // Handy well-known nodes:
  75   Node*         null()          const { return zerocon(T_OBJECT); }
  76   Node*         top()           const { return C->top(); }
  77   RootNode*     root()          const { return C->root(); }
  78 
  79   // Create or find a constant node
  80   Node* intcon(jint con)        const { return _gvn.intcon(con); }
  81   Node* longcon(jlong con)      const { return _gvn.longcon(con); }
  82   Node* makecon(const Type *t)  const { return _gvn.makecon(t); }
  83   Node* zerocon(BasicType bt)   const { return _gvn.zerocon(bt); }
  84   // (See also macro MakeConX in type.hpp, which uses intcon or longcon.)
  85 
  86   // Helper for byte_map_base
  87   Node* byte_map_base_node() {
  88     // Get base of card map
  89     CardTableModRefBS* ct = (CardTableModRefBS*)(Universe::heap()->barrier_set());
  90     assert(sizeof(*ct->byte_map_base) == sizeof(jbyte), "adjust users of this code");
  91     if (ct->byte_map_base != NULL) {
  92       return makecon(TypeRawPtr::make((address)ct->byte_map_base));
  93     } else {
  94       return null();
  95     }
  96   }
  97 
  98   jint  find_int_con(Node* n, jint value_if_unknown) {
  99     return _gvn.find_int_con(n, value_if_unknown);
 100   }
 101   jlong find_long_con(Node* n, jlong value_if_unknown) {
 102     return _gvn.find_long_con(n, value_if_unknown);
 103   }
 104   // (See also macro find_intptr_t_con in type.hpp, which uses one of these.)
 105 
 106   // JVM State accessors:
 107   // Parser mapping from JVM indices into Nodes.
 108   // Low slots are accessed by the StartNode::enum.
 109   // Then come the locals at StartNode::Parms to StartNode::Parms+max_locals();
 110   // Then come JVM stack slots.
 111   // Finally come the monitors, if any.
 112   // See layout accessors in class JVMState.
 113 
 114   SafePointNode*     map()      const { return _map; }
 115   bool               has_exceptions() const { return _exceptions != NULL; }
 116   JVMState*          jvms()     const { return map_not_null()->_jvms; }
 117   int                sp()       const { return _sp; }
 118   int                bci()      const { return _bci; }
 119   Bytecodes::Code    java_bc()  const;
 120   ciMethod*          method()   const { return _method; }
 121 
 122   void set_jvms(JVMState* jvms)       { set_map(jvms->map());
 123                                         assert(jvms == this->jvms(), "sanity");
 124                                         _sp = jvms->sp();
 125                                         _bci = jvms->bci();
 126                                         _method = jvms->has_method() ? jvms->method() : NULL; }
 127   void set_map(SafePointNode* m)      { _map = m; debug_only(verify_map()); }
 128   void set_sp(int i)                  { assert(i >= 0, "must be non-negative"); _sp = i; }
 129   void clean_stack(int from_sp); // clear garbage beyond from_sp to top
 130 
 131   void inc_sp(int i)                  { set_sp(sp() + i); }
 132   void set_bci(int bci)               { _bci = bci; }
 133 
 134   // Make sure jvms has current bci & sp.
 135   JVMState* sync_jvms()     const;
 136 #ifdef ASSERT
 137   // Make sure JVMS has an updated copy of bci and sp.
 138   // Also sanity-check method, depth, and monitor depth.
 139   bool jvms_in_sync() const;
 140 
 141   // Make sure the map looks OK.
 142   void verify_map() const;
 143 
 144   // Make sure a proposed exception state looks OK.
 145   static void verify_exception_state(SafePointNode* ex_map);
 146 #endif
 147 
 148   // Clone the existing map state.  (Implements PreserveJVMState.)
 149   SafePointNode* clone_map();
 150 
 151   // Set the map to a clone of the given one.
 152   void set_map_clone(SafePointNode* m);
 153 
 154   // Tell if the compilation is failing.
 155   bool failing() const { return C->failing(); }
 156 
 157   // Set _map to NULL, signalling a stop to further bytecode execution.
 158   // Preserve the map intact for future use, and return it back to the caller.
 159   SafePointNode* stop() { SafePointNode* m = map(); set_map(NULL); return m; }
 160 
 161   // Stop, but first smash the map's inputs to NULL, to mark it dead.
 162   void stop_and_kill_map();
 163 
 164   // Tell if _map is NULL, or control is top.
 165   bool stopped();
 166 
 167   // Tell if this method or any caller method has exception handlers.
 168   bool has_ex_handler();
 169 
 170   // Save an exception without blowing stack contents or other JVM state.
 171   // (The extra pointer is stuck with add_req on the map, beyond the JVMS.)
 172   static void set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop);
 173 
 174   // Recover a saved exception from its map.
 175   static Node* saved_ex_oop(SafePointNode* ex_map);
 176 
 177   // Recover a saved exception from its map, and remove it from the map.
 178   static Node* clear_saved_ex_oop(SafePointNode* ex_map);
 179 
 180 #ifdef ASSERT
 181   // Recover a saved exception from its map, and remove it from the map.
 182   static bool has_saved_ex_oop(SafePointNode* ex_map);
 183 #endif
 184 
 185   // Push an exception in the canonical position for handlers (stack(0)).
 186   void push_ex_oop(Node* ex_oop) {
 187     ensure_stack(1);  // ensure room to push the exception
 188     set_stack(0, ex_oop);
 189     set_sp(1);
 190     clean_stack(1);
 191   }
 192 
 193   // Detach and return an exception state.
 194   SafePointNode* pop_exception_state() {
 195     SafePointNode* ex_map = _exceptions;
 196     if (ex_map != NULL) {
 197       _exceptions = ex_map->next_exception();
 198       ex_map->set_next_exception(NULL);
 199       debug_only(verify_exception_state(ex_map));
 200     }
 201     return ex_map;
 202   }
 203 
 204   // Add an exception, using the given JVM state, without commoning.
 205   void push_exception_state(SafePointNode* ex_map) {
 206     debug_only(verify_exception_state(ex_map));
 207     ex_map->set_next_exception(_exceptions);
 208     _exceptions = ex_map;
 209   }
 210 
 211   // Turn the current JVM state into an exception state, appending the ex_oop.
 212   SafePointNode* make_exception_state(Node* ex_oop);
 213 
 214   // Add an exception, using the given JVM state.
 215   // Combine all exceptions with a common exception type into a single state.
 216   // (This is done via combine_exception_states.)
 217   void add_exception_state(SafePointNode* ex_map);
 218 
 219   // Combine all exceptions of any sort whatever into a single master state.
 220   SafePointNode* combine_and_pop_all_exception_states() {
 221     if (_exceptions == NULL)  return NULL;
 222     SafePointNode* phi_map = pop_exception_state();
 223     SafePointNode* ex_map;
 224     while ((ex_map = pop_exception_state()) != NULL) {
 225       combine_exception_states(ex_map, phi_map);
 226     }
 227     return phi_map;
 228   }
 229 
 230   // Combine the two exception states, building phis as necessary.
 231   // The second argument is updated to include contributions from the first.
 232   void combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map);
 233 
 234   // Reset the map to the given state.  If there are any half-finished phis
 235   // in it (created by combine_exception_states), transform them now.
 236   // Returns the exception oop.  (Caller must call push_ex_oop if required.)
 237   Node* use_exception_state(SafePointNode* ex_map);
 238 
 239   // Collect exceptions from a given JVM state into my exception list.
 240   void add_exception_states_from(JVMState* jvms);
 241 
 242   // Collect all raised exceptions into the current JVM state.
 243   // Clear the current exception list and map, returns the combined states.
 244   JVMState* transfer_exceptions_into_jvms();
 245 
 246   // Helper to throw a built-in exception.
 247   // Range checks take the offending index.
 248   // Cast and array store checks take the offending class.
 249   // Others do not take the optional argument.
 250   // The JVMS must allow the bytecode to be re-executed
 251   // via an uncommon trap.
 252   void builtin_throw(Deoptimization::DeoptReason reason, Node* arg = NULL);
 253 
 254   // Helper Functions for adding debug information
 255   void kill_dead_locals();
 256 #ifdef ASSERT
 257   bool dead_locals_are_killed();
 258 #endif
 259   // The call may deoptimize.  Supply required JVM state as debug info.
 260   // If must_throw is true, the call is guaranteed not to return normally.
 261   void add_safepoint_edges(SafePointNode* call,
 262                            bool must_throw = false);
 263 
 264   // How many stack inputs does the current BC consume?
 265   // And, how does the stack change after the bytecode?
 266   // Returns false if unknown.
 267   bool compute_stack_effects(int& inputs, int& depth);
 268 
 269   // Add a fixed offset to a pointer
 270   Node* basic_plus_adr(Node* base, Node* ptr, intptr_t offset) {
 271     return basic_plus_adr(base, ptr, MakeConX(offset));
 272   }
 273   Node* basic_plus_adr(Node* base, intptr_t offset) {
 274     return basic_plus_adr(base, base, MakeConX(offset));
 275   }
 276   // Add a variable offset to a pointer
 277   Node* basic_plus_adr(Node* base, Node* offset) {
 278     return basic_plus_adr(base, base, offset);
 279   }
 280   Node* basic_plus_adr(Node* base, Node* ptr, Node* offset);
 281 
 282   // Convert between int and long, and size_t.
 283   // (See macros ConvI2X, etc., in type.hpp for ConvI2X, etc.)
 284   Node* ConvI2L(Node* offset);
 285   Node* ConvL2I(Node* offset);
 286   // Find out the klass of an object.
 287   Node* load_object_klass(Node* object);
 288   // Find out the length of an array.
 289   Node* load_array_length(Node* array);
 290   // Helper function to do a NULL pointer check or ZERO check based on type.
 291   Node* null_check_common(Node* value, BasicType type,
 292                           bool assert_null, Node* *null_control);
 293   // Throw an exception if a given value is null.
 294   // Return the value cast to not-null.
 295   // Be clever about equivalent dominating null checks.
 296   Node* do_null_check(Node* value, BasicType type) {
 297     return null_check_common(value, type, false, NULL);
 298   }
 299   // Throw an uncommon trap if a given value is __not__ null.
 300   // Return the value cast to null, and be clever about dominating checks.
 301   Node* do_null_assert(Node* value, BasicType type) {
 302     return null_check_common(value, type, true, NULL);
 303   }
 304   // Null check oop.  Return null-path control into (*null_control).
 305   // Return a cast-not-null node which depends on the not-null control.
 306   // If never_see_null, use an uncommon trap (*null_control sees a top).
 307   // The cast is not valid along the null path; keep a copy of the original.
 308   Node* null_check_oop(Node* value, Node* *null_control,
 309                        bool never_see_null = false);
 310 
 311   // Cast obj to not-null on this path
 312   Node* cast_not_null(Node* obj, bool do_replace_in_map = true);
 313   // Replace all occurrences of one node by another.
 314   void replace_in_map(Node* old, Node* neww);
 315 
 316   void push(Node* n)    { map_not_null(); _map->set_stack(_map->_jvms,_sp++,n); }
 317   Node* pop()           { map_not_null(); return _map->stack(_map->_jvms,--_sp); }
 318   Node* peek(int off=0) { map_not_null(); return _map->stack(_map->_jvms, _sp - off - 1); }
 319 
 320   void push_pair(Node* ldval) {
 321     push(ldval);
 322     push(top());  // the halfword is merely a placeholder
 323   }
 324   void push_pair_local(int i) {
 325     // longs are stored in locals in "push" order
 326     push(  local(i+0) );  // the real value
 327     assert(local(i+1) == top(), "");
 328     push(top());  // halfword placeholder
 329   }
 330   Node* pop_pair() {
 331     // the second half is pushed last & popped first; it contains exactly nothing
 332     Node* halfword = pop();
 333     assert(halfword == top(), "");
 334     // the long bits are pushed first & popped last:
 335     return pop();
 336   }
 337   void set_pair_local(int i, Node* lval) {
 338     // longs are stored in locals as a value/half pair (like doubles)
 339     set_local(i+0, lval);
 340     set_local(i+1, top());
 341   }
 342 
 343   // Push the node, which may be zero, one, or two words.
 344   void push_node(BasicType n_type, Node* n) {
 345     int n_size = type2size[n_type];
 346     if      (n_size == 1)  push(      n );  // T_INT, ...
 347     else if (n_size == 2)  push_pair( n );  // T_DOUBLE, T_LONG
 348     else                   { assert(n_size == 0, "must be T_VOID"); }
 349   }
 350 
 351   Node* pop_node(BasicType n_type) {
 352     int n_size = type2size[n_type];
 353     if      (n_size == 1)  return pop();
 354     else if (n_size == 2)  return pop_pair();
 355     else                   return NULL;
 356   }
 357 
 358   Node* control()               const { return map_not_null()->control(); }
 359   Node* i_o()                   const { return map_not_null()->i_o(); }
 360   Node* returnadr()             const { return map_not_null()->returnadr(); }
 361   Node* frameptr()              const { return map_not_null()->frameptr(); }
 362   Node* local(uint idx)         const { map_not_null(); return _map->local(      _map->_jvms, idx); }
 363   Node* stack(uint idx)         const { map_not_null(); return _map->stack(      _map->_jvms, idx); }
 364   Node* argument(uint idx)      const { map_not_null(); return _map->argument(   _map->_jvms, idx); }
 365   Node* monitor_box(uint idx)   const { map_not_null(); return _map->monitor_box(_map->_jvms, idx); }
 366   Node* monitor_obj(uint idx)   const { map_not_null(); return _map->monitor_obj(_map->_jvms, idx); }
 367 
 368   void set_control  (Node* c)         { map_not_null()->set_control(c); }
 369   void set_i_o      (Node* c)         { map_not_null()->set_i_o(c); }
 370   void set_local(uint idx, Node* c)   { map_not_null(); _map->set_local(   _map->_jvms, idx, c); }
 371   void set_stack(uint idx, Node* c)   { map_not_null(); _map->set_stack(   _map->_jvms, idx, c); }
 372   void set_argument(uint idx, Node* c){ map_not_null(); _map->set_argument(_map->_jvms, idx, c); }
 373   void ensure_stack(uint stk_size)    { map_not_null(); _map->ensure_stack(_map->_jvms, stk_size); }
 374 
 375   // Access unaliased memory
 376   Node* memory(uint alias_idx);
 377   Node* memory(const TypePtr *tp) { return memory(C->get_alias_index(tp)); }
 378   Node* memory(Node* adr) { return memory(_gvn.type(adr)->is_ptr()); }
 379 
 380   // Access immutable memory
 381   Node* immutable_memory() { return C->immutable_memory(); }
 382 
 383   // Set unaliased memory
 384   void set_memory(Node* c, uint alias_idx) { merged_memory()->set_memory_at(alias_idx, c); }
 385   void set_memory(Node* c, const TypePtr *tp) { set_memory(c,C->get_alias_index(tp)); }
 386   void set_memory(Node* c, Node* adr) { set_memory(c,_gvn.type(adr)->is_ptr()); }
 387 
 388   // Get the entire memory state (probably a MergeMemNode), and reset it
 389   // (The resetting prevents somebody from using the dangling Node pointer.)
 390   Node* reset_memory();
 391 
 392   // Get the entire memory state, asserted to be a MergeMemNode.
 393   MergeMemNode* merged_memory() {
 394     Node* mem = map_not_null()->memory();
 395     assert(mem->is_MergeMem(), "parse memory is always pre-split");
 396     return mem->as_MergeMem();
 397   }
 398 
 399   // Set the entire memory state; produce a new MergeMemNode.
 400   void set_all_memory(Node* newmem);
 401 
 402   // Create a memory projection from the call, then set_all_memory.
 403   void set_all_memory_call(Node* call);
 404 
 405   // Create a LoadNode, reading from the parser's memory state.
 406   // (Note:  require_atomic_access is useful only with T_LONG.)
 407   Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt,
 408                   bool require_atomic_access = false) {
 409     // This version computes alias_index from bottom_type
 410     return make_load(ctl, adr, t, bt, adr->bottom_type()->is_ptr(),
 411                      require_atomic_access);
 412   }
 413   Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, const TypePtr* adr_type, bool require_atomic_access = false) {
 414     // This version computes alias_index from an address type
 415     assert(adr_type != NULL, "use other make_load factory");
 416     return make_load(ctl, adr, t, bt, C->get_alias_index(adr_type),
 417                      require_atomic_access);
 418   }
 419   // This is the base version which is given an alias index.
 420   Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, int adr_idx, bool require_atomic_access = false);
 421 
 422   // Create & transform a StoreNode and store the effect into the
 423   // parser's memory state.
 424   Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
 425                         const TypePtr* adr_type,
 426                         bool require_atomic_access = false) {
 427     // This version computes alias_index from an address type
 428     assert(adr_type != NULL, "use other store_to_memory factory");
 429     return store_to_memory(ctl, adr, val, bt,
 430                            C->get_alias_index(adr_type),
 431                            require_atomic_access);
 432   }
 433   // This is the base version which is given alias index
 434   // Return the new StoreXNode
 435   Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
 436                         int adr_idx,
 437                         bool require_atomic_access = false);
 438 
 439 
 440   // All in one pre-barrier, store, post_barrier
 441   // Insert a write-barrier'd store.  This is to let generational GC
 442   // work; we have to flag all oop-stores before the next GC point.
 443   //
 444   // It comes in 3 flavors of store to an object, array, or unknown.
 445   // We use precise card marks for arrays to avoid scanning the entire
 446   // array. We use imprecise for object. We use precise for unknown
 447   // since we don't know if we have an array or and object or even
 448   // where the object starts.
 449   //
 450   // If val==NULL, it is taken to be a completely unknown value. QQQ
 451 
 452   Node* store_oop(Node* ctl,
 453                   Node* obj,   // containing obj
 454                   Node* adr,  // actual adress to store val at
 455                   const TypePtr* adr_type,
 456                   Node* val,
 457                   const TypeOopPtr* val_type,
 458                   BasicType bt,
 459                   bool use_precise);
 460 
 461   Node* store_oop_to_object(Node* ctl,
 462                             Node* obj,   // containing obj
 463                             Node* adr,  // actual adress to store val at
 464                             const TypePtr* adr_type,
 465                             Node* val,
 466                             const TypeOopPtr* val_type,
 467                             BasicType bt) {
 468     return store_oop(ctl, obj, adr, adr_type, val, val_type, bt, false);
 469   }
 470 
 471   Node* store_oop_to_array(Node* ctl,
 472                            Node* obj,   // containing obj
 473                            Node* adr,  // actual adress to store val at
 474                            const TypePtr* adr_type,
 475                            Node* val,
 476                            const TypeOopPtr* val_type,
 477                            BasicType bt) {
 478     return store_oop(ctl, obj, adr, adr_type, val, val_type, bt, true);
 479   }
 480 
 481   // Could be an array or object we don't know at compile time (unsafe ref.)
 482   Node* store_oop_to_unknown(Node* ctl,
 483                              Node* obj,   // containing obj
 484                              Node* adr,  // actual adress to store val at
 485                              const TypePtr* adr_type,
 486                              Node* val,
 487                              BasicType bt);
 488 
 489   // For the few case where the barriers need special help
 490   void pre_barrier(Node* ctl, Node* obj, Node* adr, uint adr_idx,
 491                    Node* val, const TypeOopPtr* val_type, BasicType bt);
 492 
 493   void post_barrier(Node* ctl, Node* store, Node* obj, Node* adr, uint adr_idx,
 494                     Node* val, BasicType bt, bool use_precise);
 495 
 496   // Return addressing for an array element.
 497   Node* array_element_address(Node* ary, Node* idx, BasicType elembt,
 498                               // Optional constraint on the array size:
 499                               const TypeInt* sizetype = NULL);
 500 
 501   // Return a load of array element at idx.
 502   Node* load_array_element(Node* ctl, Node* ary, Node* idx, const TypeAryPtr* arytype);
 503 
 504   //---------------- Dtrace support --------------------
 505   void make_dtrace_method_entry_exit(ciMethod* method, bool is_entry);
 506   void make_dtrace_method_entry(ciMethod* method) {
 507     make_dtrace_method_entry_exit(method, true);
 508   }
 509   void make_dtrace_method_exit(ciMethod* method) {
 510     make_dtrace_method_entry_exit(method, false);
 511   }
 512 
 513   //--------------- stub generation -------------------
 514  public:
 515   void gen_stub(address C_function,
 516                 const char *name,
 517                 int is_fancy_jump,
 518                 bool pass_tls,
 519                 bool return_pc);
 520 
 521   //---------- help for generating calls --------------
 522 
 523   // Do a null check on the receiver, which is in argument(0).
 524   Node* null_check_receiver(ciMethod* callee) {
 525     assert(!callee->is_static(), "must be a virtual method");
 526     int nargs = 1 + callee->signature()->size();
 527     // Null check on self without removing any arguments.  The argument
 528     // null check technically happens in the wrong place, which can lead to
 529     // invalid stack traces when the primitive is inlined into a method
 530     // which handles NullPointerExceptions.
 531     Node* receiver = argument(0);
 532     _sp += nargs;
 533     receiver = do_null_check(receiver, T_OBJECT);
 534     _sp -= nargs;
 535     return receiver;
 536   }
 537 
 538   // Fill in argument edges for the call from argument(0), argument(1), ...
 539   // (The next step is to call set_edges_for_java_call.)
 540   void  set_arguments_for_java_call(CallJavaNode* call);
 541 
 542   // Fill in non-argument edges for the call.
 543   // Transform the call, and update the basics: control, i_o, memory.
 544   // (The next step is usually to call set_results_for_java_call.)
 545   void set_edges_for_java_call(CallJavaNode* call,
 546                                bool must_throw = false);
 547 
 548   // Finish up a java call that was started by set_edges_for_java_call.
 549   // Call add_exception on any throw arising from the call.
 550   // Return the call result (transformed).
 551   Node* set_results_for_java_call(CallJavaNode* call);
 552 
 553   // Similar to set_edges_for_java_call, but simplified for runtime calls.
 554   void  set_predefined_output_for_runtime_call(Node* call) {
 555     set_predefined_output_for_runtime_call(call, NULL, NULL);
 556   }
 557   void  set_predefined_output_for_runtime_call(Node* call,
 558                                                Node* keep_mem,
 559                                                const TypePtr* hook_mem);
 560   Node* set_predefined_input_for_runtime_call(SafePointNode* call);
 561 
 562   // helper functions for statistics
 563   void increment_counter(address counter_addr);   // increment a debug counter
 564   void increment_counter(Node*   counter_addr);   // increment a debug counter
 565 
 566   // Bail out to the interpreter right now
 567   // The optional klass is the one causing the trap.
 568   // The optional reason is debug information written to the compile log.
 569   // Optional must_throw is the same as with add_safepoint_edges.
 570   void uncommon_trap(int trap_request,
 571                      ciKlass* klass = NULL, const char* reason_string = NULL,
 572                      bool must_throw = false, bool keep_exact_action = false);
 573 
 574   // Shorthand, to avoid saying "Deoptimization::" so many times.
 575   void uncommon_trap(Deoptimization::DeoptReason reason,
 576                      Deoptimization::DeoptAction action,
 577                      ciKlass* klass = NULL, const char* reason_string = NULL,
 578                      bool must_throw = false, bool keep_exact_action = false) {
 579     uncommon_trap(Deoptimization::make_trap_request(reason, action),
 580                   klass, reason_string, must_throw, keep_exact_action);
 581   }
 582 
 583   // Report if there were too many traps at the current method and bci.
 584   // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
 585   // If there is no MDO at all, report no trap unless told to assume it.
 586   bool too_many_traps(Deoptimization::DeoptReason reason) {
 587     return C->too_many_traps(method(), bci(), reason);
 588   }
 589 
 590   // Report if there were too many recompiles at the current method and bci.
 591   bool too_many_recompiles(Deoptimization::DeoptReason reason) {
 592     return C->too_many_recompiles(method(), bci(), reason);
 593   }
 594 
 595   // Returns the object (if any) which was created the moment before.
 596   Node* just_allocated_object(Node* current_control);
 597 
 598   static bool use_ReduceInitialCardMarks() {
 599     return (ReduceInitialCardMarks
 600             && Universe::heap()->can_elide_tlab_store_barriers());
 601   }
 602 
 603   void sync_kit(IdealKit& ideal);
 604 
 605   // vanilla/CMS post barrier
 606   void write_barrier_post(Node *store, Node* obj, Node* adr, Node* val, bool use_precise);
 607 
 608   // G1 pre/post barriers
 609   void g1_write_barrier_pre(Node* obj,
 610                             Node* adr,
 611                             uint alias_idx,
 612                             Node* val,
 613                             const TypeOopPtr* val_type,
 614                             BasicType bt);
 615 
 616   void g1_write_barrier_post(Node* store,
 617                              Node* obj,
 618                              Node* adr,
 619                              uint alias_idx,
 620                              Node* val,
 621                              BasicType bt,
 622                              bool use_precise);
 623   // Helper function for g1
 624   private:
 625   void g1_mark_card(IdealKit& ideal, Node* card_adr, Node* store,  Node* index, Node* index_adr,
 626                     Node* buffer, const TypeFunc* tf);
 627 
 628   public:
 629   // Helper function to round double arguments before a call
 630   void round_double_arguments(ciMethod* dest_method);
 631   void round_double_result(ciMethod* dest_method);
 632 
 633   // rounding for strict float precision conformance
 634   Node* precision_rounding(Node* n);
 635 
 636   // rounding for strict double precision conformance
 637   Node* dprecision_rounding(Node* n);
 638 
 639   // rounding for non-strict double stores
 640   Node* dstore_rounding(Node* n);
 641 
 642   // Helper functions for fast/slow path codes
 643   Node* opt_iff(Node* region, Node* iff);
 644   Node* make_runtime_call(int flags,
 645                           const TypeFunc* call_type, address call_addr,
 646                           const char* call_name,
 647                           const TypePtr* adr_type, // NULL if no memory effects
 648                           Node* parm0 = NULL, Node* parm1 = NULL,
 649                           Node* parm2 = NULL, Node* parm3 = NULL,
 650                           Node* parm4 = NULL, Node* parm5 = NULL,
 651                           Node* parm6 = NULL, Node* parm7 = NULL);
 652   enum {  // flag values for make_runtime_call
 653     RC_NO_FP = 1,               // CallLeafNoFPNode
 654     RC_NO_IO = 2,               // do not hook IO edges
 655     RC_NO_LEAF = 4,             // CallStaticJavaNode
 656     RC_MUST_THROW = 8,          // flag passed to add_safepoint_edges
 657     RC_NARROW_MEM = 16,         // input memory is same as output
 658     RC_UNCOMMON = 32,           // freq. expected to be like uncommon trap
 659     RC_LEAF = 0                 // null value:  no flags set
 660   };
 661 
 662   // merge in all memory slices from new_mem, along the given path
 663   void merge_memory(Node* new_mem, Node* region, int new_path);
 664   void make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj);
 665 
 666   // Helper functions to build synchronizations
 667   int next_monitor();
 668   Node* insert_mem_bar(int opcode, Node* precedent = NULL);
 669   Node* insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent = NULL);
 670   // Optional 'precedent' is appended as an extra edge, to force ordering.
 671   FastLockNode* shared_lock(Node* obj);
 672   void shared_unlock(Node* box, Node* obj);
 673 
 674   // helper functions for the fast path/slow path idioms
 675   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, klassOop ex_klass, Node* slow_result);
 676 
 677   // Generate an instance-of idiom.  Used by both the instance-of bytecode
 678   // and the reflective instance-of call.
 679   Node* gen_instanceof( Node *subobj, Node* superkls );
 680 
 681   // Generate a check-cast idiom.  Used by both the check-cast bytecode
 682   // and the array-store bytecode
 683   Node* gen_checkcast( Node *subobj, Node* superkls,
 684                        Node* *failure_control = NULL );
 685 
 686   // Generate a subtyping check.  Takes as input the subtype and supertype.
 687   // Returns 2 values: sets the default control() to the true path and
 688   // returns the false path.  Only reads from constant memory taken from the
 689   // default memory; does not write anything.  It also doesn't take in an
 690   // Object; if you wish to check an Object you need to load the Object's
 691   // class prior to coming here.
 692   Node* gen_subtype_check(Node* subklass, Node* superklass);
 693 
 694   // Static parse-time type checking logic for gen_subtype_check:
 695   enum { SSC_always_false, SSC_always_true, SSC_easy_test, SSC_full_test };
 696   int static_subtype_check(ciKlass* superk, ciKlass* subk);
 697 
 698   // Exact type check used for predicted calls and casts.
 699   // Rewrites (*casted_receiver) to be casted to the stronger type.
 700   // (Caller is responsible for doing replace_in_map.)
 701   Node* type_check_receiver(Node* receiver, ciKlass* klass, float prob,
 702                             Node* *casted_receiver);
 703 
 704   // implementation of object creation
 705   Node* set_output_for_allocation(AllocateNode* alloc,
 706                                   const TypeOopPtr* oop_type,
 707                                   bool raw_mem_only);
 708   Node* get_layout_helper(Node* klass_node, jint& constant_value);
 709   Node* new_instance(Node* klass_node,
 710                      Node* slow_test = NULL,
 711                      bool raw_mem_only = false,
 712                      Node* *return_size_val = NULL);
 713   Node* new_array(Node* klass_node, Node* count_val, int nargs,
 714                   bool raw_mem_only = false, Node* *return_size_val = NULL);
 715 
 716   // Handy for making control flow
 717   IfNode* create_and_map_if(Node* ctrl, Node* tst, float prob, float cnt) {
 718     IfNode* iff = new (C, 2) IfNode(ctrl, tst, prob, cnt);// New IfNode's
 719     _gvn.set_type(iff, iff->Value(&_gvn)); // Value may be known at parse-time
 720     // Place 'if' on worklist if it will be in graph
 721     if (!tst->is_Con())  record_for_igvn(iff);     // Range-check and Null-check removal is later
 722     return iff;
 723   }
 724 
 725   IfNode* create_and_xform_if(Node* ctrl, Node* tst, float prob, float cnt) {
 726     IfNode* iff = new (C, 2) IfNode(ctrl, tst, prob, cnt);// New IfNode's
 727     _gvn.transform(iff);                           // Value may be known at parse-time
 728     // Place 'if' on worklist if it will be in graph
 729     if (!tst->is_Con())  record_for_igvn(iff);     // Range-check and Null-check removal is later
 730     return iff;
 731   }
 732 };
 733 
 734 // Helper class to support building of control flow branches. Upon
 735 // creation the map and sp at bci are cloned and restored upon de-
 736 // struction. Typical use:
 737 //
 738 // { PreserveJVMState pjvms(this);
 739 //   // code of new branch
 740 // }
 741 // // here the JVM state at bci is established
 742 
 743 class PreserveJVMState: public StackObj {
 744  protected:
 745   GraphKit*      _kit;
 746 #ifdef ASSERT
 747   int            _block;  // PO of current block, if a Parse
 748   int            _bci;
 749 #endif
 750   SafePointNode* _map;
 751   uint           _sp;
 752 
 753  public:
 754   PreserveJVMState(GraphKit* kit, bool clone_map = true);
 755   ~PreserveJVMState();
 756 };
 757 
 758 // Helper class to build cutouts of the form if (p) ; else {x...}.
 759 // The code {x...} must not fall through.
 760 // The kit's main flow of control is set to the "then" continuation of if(p).
 761 class BuildCutout: public PreserveJVMState {
 762  public:
 763   BuildCutout(GraphKit* kit, Node* p, float prob, float cnt = COUNT_UNKNOWN);
 764   ~BuildCutout();
 765 };
 766 
 767 // Helper class to preserve the original _reexecute bit and _sp and restore
 768 // them back
 769 class PreserveReexecuteState: public StackObj {
 770  protected:
 771   GraphKit*                 _kit;
 772   uint                      _sp;
 773   JVMState::ReexecuteState  _reexecute;
 774 
 775  public:
 776   PreserveReexecuteState(GraphKit* kit);
 777   ~PreserveReexecuteState();
 778 };