1 /*
  2  * Copyright (c) 1997, 2022, 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_CFGNODE_HPP
 26 #define SHARE_OPTO_CFGNODE_HPP
 27 
 28 #include "opto/multnode.hpp"
 29 #include "opto/node.hpp"
 30 #include "opto/opcodes.hpp"
 31 #include "opto/type.hpp"
 32 
 33 // Portions of code courtesy of Clifford Click
 34 
 35 // Optimization - Graph Style
 36 
 37 class Matcher;
 38 class Node;
 39 class   RegionNode;
 40 class   TypeNode;
 41 class     PhiNode;
 42 class   GotoNode;
 43 class   MultiNode;
 44 class     MultiBranchNode;
 45 class       IfNode;
 46 class       PCTableNode;
 47 class         JumpNode;
 48 class         CatchNode;
 49 class       NeverBranchNode;
 50 class     BlackholeNode;
 51 class   ProjNode;
 52 class     CProjNode;
 53 class       IfTrueNode;
 54 class       IfFalseNode;
 55 class       CatchProjNode;
 56 class     JProjNode;
 57 class       JumpProjNode;
 58 class     SCMemProjNode;
 59 class PhaseIdealLoop;
 60 
 61 //------------------------------RegionNode-------------------------------------
 62 // The class of RegionNodes, which can be mapped to basic blocks in the
 63 // program.  Their inputs point to Control sources.  PhiNodes (described
 64 // below) have an input point to a RegionNode.  Merged data inputs to PhiNodes
 65 // correspond 1-to-1 with RegionNode inputs.  The zero input of a PhiNode is
 66 // the RegionNode, and the zero input of the RegionNode is itself.
 67 class RegionNode : public Node {
 68 private:
 69   bool _is_unreachable_region;
 70 
 71   bool is_possible_unsafe_loop(const PhaseGVN* phase) const;
 72   bool is_unreachable_from_root(const PhaseGVN* phase) const;
 73 public:
 74   // Node layout (parallels PhiNode):
 75   enum { Region,                // Generally points to self.
 76          Control                // Control arcs are [1..len)
 77   };
 78 
 79   RegionNode(uint required) : Node(required), _is_unreachable_region(false) {
 80     init_class_id(Class_Region);
 81     init_req(0, this);
 82   }
 83 
 84   Node* is_copy() const {
 85     const Node* r = _in[Region];
 86     if (r == NULL)
 87       return nonnull_req();
 88     return NULL;  // not a copy!
 89   }
 90   PhiNode* has_phi() const;        // returns an arbitrary phi user, or NULL
 91   PhiNode* has_unique_phi() const; // returns the unique phi user, or NULL
 92   // Is this region node unreachable from root?
 93   bool is_unreachable_region(const PhaseGVN* phase);
 94   virtual int Opcode() const;
 95   virtual uint size_of() const { return sizeof(*this); }
 96   virtual bool pinned() const { return (const Node*)in(0) == this; }
 97   virtual bool is_CFG() const { return true; }
 98   virtual uint hash() const { return NO_HASH; } // CFG nodes do not hash
 99   virtual bool depends_only_on_test() const { return false; }
100   virtual const Type* bottom_type() const { return Type::CONTROL; }
101   virtual const Type* Value(PhaseGVN* phase) const;
102   virtual Node* Identity(PhaseGVN* phase);
103   virtual Node* Ideal(PhaseGVN* phase, bool can_reshape);
104   virtual const RegMask &out_RegMask() const;
105   bool optimize_trichotomy(PhaseIterGVN* igvn);
106 };
107 
108 //------------------------------JProjNode--------------------------------------
109 // jump projection for node that produces multiple control-flow paths
110 class JProjNode : public ProjNode {
111  public:
112   JProjNode( Node* ctrl, uint idx ) : ProjNode(ctrl,idx) {}
113   virtual int Opcode() const;
114   virtual bool  is_CFG() const { return true; }
115   virtual uint  hash() const { return NO_HASH; }  // CFG nodes do not hash
116   virtual const Node* is_block_proj() const { return in(0); }
117   virtual const RegMask& out_RegMask() const;
118   virtual uint  ideal_reg() const { return 0; }
119 };
120 
121 //------------------------------PhiNode----------------------------------------
122 // PhiNodes merge values from different Control paths.  Slot 0 points to the
123 // controlling RegionNode.  Other slots map 1-for-1 with incoming control flow
124 // paths to the RegionNode.
125 class PhiNode : public TypeNode {
126   friend class PhaseRenumberLive;
127 
128   const TypePtr* const _adr_type; // non-null only for Type::MEMORY nodes.
129   // The following fields are only used for data PhiNodes to indicate
130   // that the PhiNode represents the value of a known instance field.
131         int _inst_mem_id; // Instance memory id (node index of the memory Phi)
132         int _inst_id;     // Instance id of the memory slice.
133   const int _inst_index;  // Alias index of the instance memory slice.
134   // Array elements references have the same alias_idx but different offset.
135   const int _inst_offset; // Offset of the instance memory slice.
136   // Size is bigger to hold the _adr_type field.
137   virtual uint hash() const;    // Check the type
138   virtual bool cmp( const Node &n ) const;
139   virtual uint size_of() const { return sizeof(*this); }
140 
141   // Determine if CMoveNode::is_cmove_id can be used at this join point.
142   Node* is_cmove_id(PhaseTransform* phase, int true_path);
143   bool wait_for_region_igvn(PhaseGVN* phase);
144   bool is_data_loop(RegionNode* r, Node* uin, const PhaseGVN* phase);
145 
146   static Node* clone_through_phi(Node* root_phi, const Type* t, uint c, PhaseIterGVN* igvn);
147   static Node* merge_through_phi(Node* root_phi, PhaseIterGVN* igvn);
148 
149 public:
150   // Node layout (parallels RegionNode):
151   enum { Region,                // Control input is the Phi's region.
152          Input                  // Input values are [1..len)
153   };
154 
155   PhiNode( Node *r, const Type *t, const TypePtr* at = NULL,
156            const int imid = -1,
157            const int iid = TypeOopPtr::InstanceTop,
158            const int iidx = Compile::AliasIdxTop,
159            const int ioffs = Type::OffsetTop )
160     : TypeNode(t,r->req()),
161       _adr_type(at),
162       _inst_mem_id(imid),
163       _inst_id(iid),
164       _inst_index(iidx),
165       _inst_offset(ioffs)
166   {
167     init_class_id(Class_Phi);
168     init_req(0, r);
169     verify_adr_type();
170   }
171   // create a new phi with in edges matching r and set (initially) to x
172   static PhiNode* make( Node* r, Node* x );
173   // extra type arguments override the new phi's bottom_type and adr_type
174   static PhiNode* make( Node* r, Node* x, const Type *t, const TypePtr* at = NULL );
175   // create a new phi with narrowed memory type
176   PhiNode* slice_memory(const TypePtr* adr_type) const;
177   PhiNode* split_out_instance(const TypePtr* at, PhaseIterGVN *igvn) const;
178   // like make(r, x), but does not initialize the in edges to x
179   static PhiNode* make_blank( Node* r, Node* x );
180 
181   // Accessors
182   RegionNode* region() const { Node* r = in(Region); assert(!r || r->is_Region(), ""); return (RegionNode*)r; }
183 
184   bool is_tripcount(BasicType bt) const;
185 
186   // Determine a unique non-trivial input, if any.
187   // Ignore casts if it helps.  Return NULL on failure.
188   Node* unique_input(PhaseTransform *phase, bool uncast);
189   Node* unique_input(PhaseTransform *phase) {
190     Node* uin = unique_input(phase, false);
191     if (uin == NULL) {
192       uin = unique_input(phase, true);
193     }
194     return uin;
195   }
196 
197   // Check for a simple dead loop.
198   enum LoopSafety { Safe = 0, Unsafe, UnsafeLoop };
199   LoopSafety simple_data_loop_check(Node *in) const;
200   // Is it unsafe data loop? It becomes a dead loop if this phi node removed.
201   bool is_unsafe_data_reference(Node *in) const;
202   int  is_diamond_phi(bool check_control_only = false) const;
203   virtual int Opcode() const;
204   virtual bool pinned() const { return in(0) != 0; }
205   virtual const TypePtr *adr_type() const { verify_adr_type(true); return _adr_type; }
206 
207   void  set_inst_mem_id(int inst_mem_id) { _inst_mem_id = inst_mem_id; }
208   const int inst_mem_id() const { return _inst_mem_id; }
209   const int inst_id()     const { return _inst_id; }
210   const int inst_index()  const { return _inst_index; }
211   const int inst_offset() const { return _inst_offset; }
212   bool is_same_inst_field(const Type* tp, int mem_id, int id, int index, int offset) {
213     return type()->basic_type() == tp->basic_type() &&
214            inst_mem_id() == mem_id &&
215            inst_id()     == id     &&
216            inst_index()  == index  &&
217            inst_offset() == offset &&
218            type()->higher_equal(tp);
219   }
220   Node* try_clean_mem_phi(PhaseGVN *phase);
221 
222   InlineTypeNode* push_inline_types_through(PhaseGVN* phase, bool can_reshape, ciInlineKlass* vk, bool is_init);
223 
224   virtual const Type* Value(PhaseGVN* phase) const;
225   virtual Node* Identity(PhaseGVN* phase);
226   virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);
227   virtual const RegMask &out_RegMask() const;
228   virtual const RegMask &in_RegMask(uint) const;
229 #ifndef PRODUCT
230   virtual void dump_spec(outputStream *st) const;
231 #endif
232 #ifdef ASSERT
233   void verify_adr_type(VectorSet& visited, const TypePtr* at) const;
234   void verify_adr_type(bool recursive = false) const;
235 #else //ASSERT
236   void verify_adr_type(bool recursive = false) const {}
237 #endif //ASSERT
238 };
239 
240 //------------------------------GotoNode---------------------------------------
241 // GotoNodes perform direct branches.
242 class GotoNode : public Node {
243 public:
244   GotoNode( Node *control ) : Node(control) {}
245   virtual int Opcode() const;
246   virtual bool pinned() const { return true; }
247   virtual bool  is_CFG() const { return true; }
248   virtual uint hash() const { return NO_HASH; }  // CFG nodes do not hash
249   virtual const Node *is_block_proj() const { return this; }
250   virtual bool depends_only_on_test() const { return false; }
251   virtual const Type *bottom_type() const { return Type::CONTROL; }
252   virtual const Type* Value(PhaseGVN* phase) const;
253   virtual Node* Identity(PhaseGVN* phase);
254   virtual const RegMask &out_RegMask() const;
255 };
256 
257 //------------------------------CProjNode--------------------------------------
258 // control projection for node that produces multiple control-flow paths
259 class CProjNode : public ProjNode {
260 public:
261   CProjNode( Node *ctrl, uint idx ) : ProjNode(ctrl,idx) {}
262   virtual int Opcode() const;
263   virtual bool  is_CFG() const { return true; }
264   virtual uint hash() const { return NO_HASH; }  // CFG nodes do not hash
265   virtual const Node *is_block_proj() const { return in(0); }
266   virtual const RegMask &out_RegMask() const;
267   virtual uint ideal_reg() const { return 0; }
268 };
269 
270 //---------------------------MultiBranchNode-----------------------------------
271 // This class defines a MultiBranchNode, a MultiNode which yields multiple
272 // control values. These are distinguished from other types of MultiNodes
273 // which yield multiple values, but control is always and only projection #0.
274 class MultiBranchNode : public MultiNode {
275 public:
276   MultiBranchNode( uint required ) : MultiNode(required) {
277     init_class_id(Class_MultiBranch);
278   }
279   // returns required number of users to be well formed.
280   virtual int required_outcnt() const = 0;
281 };
282 
283 //------------------------------IfNode-----------------------------------------
284 // Output selected Control, based on a boolean test
285 class IfNode : public MultiBranchNode {
286   // Size is bigger to hold the probability field.  However, _prob does not
287   // change the semantics so it does not appear in the hash & cmp functions.
288   virtual uint size_of() const { return sizeof(*this); }
289 
290 private:
291   // Helper methods for fold_compares
292   bool cmpi_folds(PhaseIterGVN* igvn, bool fold_ne = false);
293   bool is_ctrl_folds(Node* ctrl, PhaseIterGVN* igvn);
294   bool has_shared_region(ProjNode* proj, ProjNode*& success, ProjNode*& fail);
295   bool has_only_uncommon_traps(ProjNode* proj, ProjNode*& success, ProjNode*& fail, PhaseIterGVN* igvn);
296   Node* merge_uncommon_traps(ProjNode* proj, ProjNode* success, ProjNode* fail, PhaseIterGVN* igvn);
297   static void improve_address_types(Node* l, Node* r, ProjNode* fail, PhaseIterGVN* igvn);
298   bool is_cmp_with_loadrange(ProjNode* proj);
299   bool is_null_check(ProjNode* proj, PhaseIterGVN* igvn);
300   bool is_side_effect_free_test(ProjNode* proj, PhaseIterGVN* igvn);
301   void reroute_side_effect_free_unc(ProjNode* proj, ProjNode* dom_proj, PhaseIterGVN* igvn);
302   ProjNode* uncommon_trap_proj(CallStaticJavaNode*& call) const;
303   bool fold_compares_helper(ProjNode* proj, ProjNode* success, ProjNode* fail, PhaseIterGVN* igvn);
304   static bool is_dominator_unc(CallStaticJavaNode* dom_unc, CallStaticJavaNode* unc);
305 
306 protected:
307   ProjNode* range_check_trap_proj(int& flip, Node*& l, Node*& r);
308   Node* Ideal_common(PhaseGVN *phase, bool can_reshape);
309   Node* search_identical(int dist);
310 
311   Node* simple_subsuming(PhaseIterGVN* igvn);
312 
313 public:
314 
315   // Degrees of branch prediction probability by order of magnitude:
316   // PROB_UNLIKELY_1e(N) is a 1 in 1eN chance.
317   // PROB_LIKELY_1e(N) is a 1 - PROB_UNLIKELY_1e(N)
318 #define PROB_UNLIKELY_MAG(N)    (1e- ## N ## f)
319 #define PROB_LIKELY_MAG(N)      (1.0f-PROB_UNLIKELY_MAG(N))
320 
321   // Maximum and minimum branch prediction probabilties
322   // 1 in 1,000,000 (magnitude 6)
323   //
324   // Although PROB_NEVER == PROB_MIN and PROB_ALWAYS == PROB_MAX
325   // they are used to distinguish different situations:
326   //
327   // The name PROB_MAX (PROB_MIN) is for probabilities which correspond to
328   // very likely (unlikely) but with a concrete possibility of a rare
329   // contrary case.  These constants would be used for pinning
330   // measurements, and as measures for assertions that have high
331   // confidence, but some evidence of occasional failure.
332   //
333   // The name PROB_ALWAYS (PROB_NEVER) is to stand for situations for which
334   // there is no evidence at all that the contrary case has ever occurred.
335 
336 #define PROB_NEVER              PROB_UNLIKELY_MAG(6)
337 #define PROB_ALWAYS             PROB_LIKELY_MAG(6)
338 
339 #define PROB_MIN                PROB_UNLIKELY_MAG(6)
340 #define PROB_MAX                PROB_LIKELY_MAG(6)
341 
342   // Static branch prediction probabilities
343   // 1 in 10 (magnitude 1)
344 #define PROB_STATIC_INFREQUENT  PROB_UNLIKELY_MAG(1)
345 #define PROB_STATIC_FREQUENT    PROB_LIKELY_MAG(1)
346 
347   // Fair probability 50/50
348 #define PROB_FAIR               (0.5f)
349 
350   // Unknown probability sentinel
351 #define PROB_UNKNOWN            (-1.0f)
352 
353   // Probability "constructors", to distinguish as a probability any manifest
354   // constant without a names
355 #define PROB_LIKELY(x)          ((float) (x))
356 #define PROB_UNLIKELY(x)        (1.0f - (float)(x))
357 
358   // Other probabilities in use, but without a unique name, are documented
359   // here for lack of a better place:
360   //
361   // 1 in 1000 probabilities (magnitude 3):
362   //     threshold for converting to conditional move
363   //     likelihood of null check failure if a null HAS been seen before
364   //     likelihood of slow path taken in library calls
365   //
366   // 1 in 10,000 probabilities (magnitude 4):
367   //     threshold for making an uncommon trap probability more extreme
368   //     threshold for for making a null check implicit
369   //     likelihood of needing a gc if eden top moves during an allocation
370   //     likelihood of a predicted call failure
371   //
372   // 1 in 100,000 probabilities (magnitude 5):
373   //     threshold for ignoring counts when estimating path frequency
374   //     likelihood of FP clipping failure
375   //     likelihood of catching an exception from a try block
376   //     likelihood of null check failure if a null has NOT been seen before
377   //
378   // Magic manifest probabilities such as 0.83, 0.7, ... can be found in
379   // gen_subtype_check() and catch_inline_exceptions().
380 
381   float _prob;                  // Probability of true path being taken.
382   float _fcnt;                  // Frequency counter
383   IfNode( Node *control, Node *b, float p, float fcnt )
384     : MultiBranchNode(2), _prob(p), _fcnt(fcnt) {
385     init_class_id(Class_If);
386     init_req(0,control);
387     init_req(1,b);
388   }
389   virtual int Opcode() const;
390   virtual bool pinned() const { return true; }
391   virtual const Type *bottom_type() const { return TypeTuple::IFBOTH; }
392   virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);
393   virtual const Type* Value(PhaseGVN* phase) const;
394   virtual int required_outcnt() const { return 2; }
395   virtual const RegMask &out_RegMask() const;
396   Node* fold_compares(PhaseIterGVN* phase);
397   static Node* up_one_dom(Node* curr, bool linear_only = false);
398   Node* dominated_by(Node* prev_dom, PhaseIterGVN* igvn);
399 
400   // Takes the type of val and filters it through the test represented
401   // by if_proj and returns a more refined type if one is produced.
402   // Returns NULL is it couldn't improve the type.
403   static const TypeInt* filtered_int_type(PhaseGVN* phase, Node* val, Node* if_proj);
404 
405   bool is_flat_array_check(PhaseTransform* phase, Node** array = NULL);
406 
407 #ifndef PRODUCT
408   virtual void dump_spec(outputStream *st) const;
409 #endif
410 };
411 
412 class RangeCheckNode : public IfNode {
413 private:
414   int is_range_check(Node* &range, Node* &index, jint &offset);
415 
416 public:
417   RangeCheckNode(Node* control, Node *b, float p, float fcnt)
418     : IfNode(control, b, p, fcnt) {
419     init_class_id(Class_RangeCheck);
420   }
421 
422   virtual int Opcode() const;
423   virtual Node* Ideal(PhaseGVN *phase, bool can_reshape);
424 };
425 
426 class IfProjNode : public CProjNode {
427 public:
428   IfProjNode(IfNode *ifnode, uint idx) : CProjNode(ifnode,idx) {}
429   virtual Node* Identity(PhaseGVN* phase);
430 
431 protected:
432   // Type of If input when this branch is always taken
433   virtual bool always_taken(const TypeTuple* t) const = 0;
434 };
435 
436 class IfTrueNode : public IfProjNode {
437 public:
438   IfTrueNode( IfNode *ifnode ) : IfProjNode(ifnode,1) {
439     init_class_id(Class_IfTrue);
440   }
441   virtual int Opcode() const;
442 
443 protected:
444   virtual bool always_taken(const TypeTuple* t) const { return t == TypeTuple::IFTRUE; }
445 };
446 
447 class IfFalseNode : public IfProjNode {
448 public:
449   IfFalseNode( IfNode *ifnode ) : IfProjNode(ifnode,0) {
450     init_class_id(Class_IfFalse);
451   }
452   virtual int Opcode() const;
453 
454 protected:
455   virtual bool always_taken(const TypeTuple* t) const { return t == TypeTuple::IFFALSE; }
456 };
457 
458 
459 //------------------------------PCTableNode------------------------------------
460 // Build an indirect branch table.  Given a control and a table index,
461 // control is passed to the Projection matching the table index.  Used to
462 // implement switch statements and exception-handling capabilities.
463 // Undefined behavior if passed-in index is not inside the table.
464 class PCTableNode : public MultiBranchNode {
465   virtual uint hash() const;    // Target count; table size
466   virtual bool cmp( const Node &n ) const;
467   virtual uint size_of() const { return sizeof(*this); }
468 
469 public:
470   const uint _size;             // Number of targets
471 
472   PCTableNode( Node *ctrl, Node *idx, uint size ) : MultiBranchNode(2), _size(size) {
473     init_class_id(Class_PCTable);
474     init_req(0, ctrl);
475     init_req(1, idx);
476   }
477   virtual int Opcode() const;
478   virtual const Type* Value(PhaseGVN* phase) const;
479   virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);
480   virtual const Type *bottom_type() const;
481   virtual bool pinned() const { return true; }
482   virtual int required_outcnt() const { return _size; }
483 };
484 
485 //------------------------------JumpNode---------------------------------------
486 // Indirect branch.  Uses PCTable above to implement a switch statement.
487 // It emits as a table load and local branch.
488 class JumpNode : public PCTableNode {
489   virtual uint size_of() const { return sizeof(*this); }
490 public:
491   float* _probs; // probability of each projection
492   float _fcnt;   // total number of times this Jump was executed
493   JumpNode( Node* control, Node* switch_val, uint size, float* probs, float cnt)
494     : PCTableNode(control, switch_val, size),
495       _probs(probs), _fcnt(cnt) {
496     init_class_id(Class_Jump);
497   }
498   virtual int   Opcode() const;
499   virtual const RegMask& out_RegMask() const;
500   virtual const Node* is_block_proj() const { return this; }
501 };
502 
503 class JumpProjNode : public JProjNode {
504   virtual uint hash() const;
505   virtual bool cmp( const Node &n ) const;
506   virtual uint size_of() const { return sizeof(*this); }
507 
508  private:
509   const int  _dest_bci;
510   const uint _proj_no;
511   const int  _switch_val;
512  public:
513   JumpProjNode(Node* jumpnode, uint proj_no, int dest_bci, int switch_val)
514     : JProjNode(jumpnode, proj_no), _dest_bci(dest_bci), _proj_no(proj_no), _switch_val(switch_val) {
515     init_class_id(Class_JumpProj);
516   }
517 
518   virtual int Opcode() const;
519   virtual const Type* bottom_type() const { return Type::CONTROL; }
520   int  dest_bci()    const { return _dest_bci; }
521   int  switch_val()  const { return _switch_val; }
522   uint proj_no()     const { return _proj_no; }
523 #ifndef PRODUCT
524   virtual void dump_spec(outputStream *st) const;
525   virtual void dump_compact_spec(outputStream *st) const;
526 #endif
527 };
528 
529 //------------------------------CatchNode--------------------------------------
530 // Helper node to fork exceptions.  "Catch" catches any exceptions thrown by
531 // a just-prior call.  Looks like a PCTableNode but emits no code - just the
532 // table.  The table lookup and branch is implemented by RethrowNode.
533 class CatchNode : public PCTableNode {
534 public:
535   CatchNode( Node *ctrl, Node *idx, uint size ) : PCTableNode(ctrl,idx,size){
536     init_class_id(Class_Catch);
537   }
538   virtual int Opcode() const;
539   virtual const Type* Value(PhaseGVN* phase) const;
540 };
541 
542 // CatchProjNode controls which exception handler is targeted after a call.
543 // It is passed in the bci of the target handler, or no_handler_bci in case
544 // the projection doesn't lead to an exception handler.
545 class CatchProjNode : public CProjNode {
546   virtual uint hash() const;
547   virtual bool cmp( const Node &n ) const;
548   virtual uint size_of() const { return sizeof(*this); }
549 
550 private:
551   const int _handler_bci;
552 
553 public:
554   enum {
555     fall_through_index =  0,      // the fall through projection index
556     catch_all_index    =  1,      // the projection index for catch-alls
557     no_handler_bci     = -1       // the bci for fall through or catch-all projs
558   };
559 
560   CatchProjNode(Node* catchnode, uint proj_no, int handler_bci)
561     : CProjNode(catchnode, proj_no), _handler_bci(handler_bci) {
562     init_class_id(Class_CatchProj);
563     assert(proj_no != fall_through_index || handler_bci < 0, "fall through case must have bci < 0");
564   }
565 
566   virtual int Opcode() const;
567   virtual Node* Identity(PhaseGVN* phase);
568   virtual const Type *bottom_type() const { return Type::CONTROL; }
569   int  handler_bci() const        { return _handler_bci; }
570   bool is_handler_proj() const    { return _handler_bci >= 0; }
571 #ifndef PRODUCT
572   virtual void dump_spec(outputStream *st) const;
573 #endif
574 };
575 
576 
577 //---------------------------------CreateExNode--------------------------------
578 // Helper node to create the exception coming back from a call
579 class CreateExNode : public TypeNode {
580 public:
581   CreateExNode(const Type* t, Node* control, Node* i_o) : TypeNode(t, 2) {
582     init_req(0, control);
583     init_req(1, i_o);
584   }
585   virtual int Opcode() const;
586   virtual Node* Identity(PhaseGVN* phase);
587   virtual bool pinned() const { return true; }
588   uint match_edge(uint idx) const { return 0; }
589   virtual uint ideal_reg() const { return Op_RegP; }
590 };
591 
592 //------------------------------NeverBranchNode-------------------------------
593 // The never-taken branch.  Used to give the appearance of exiting infinite
594 // loops to those algorithms that like all paths to be reachable.  Encodes
595 // empty.
596 class NeverBranchNode : public MultiBranchNode {
597 public:
598   NeverBranchNode( Node *ctrl ) : MultiBranchNode(1) { init_req(0,ctrl); }
599   virtual int Opcode() const;
600   virtual bool pinned() const { return true; };
601   virtual const Type *bottom_type() const { return TypeTuple::IFBOTH; }
602   virtual const Type* Value(PhaseGVN* phase) const;
603   virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);
604   virtual int required_outcnt() const { return 2; }
605   virtual void emit(CodeBuffer &cbuf, PhaseRegAlloc *ra_) const { }
606   virtual uint size(PhaseRegAlloc *ra_) const { return 0; }
607 #ifndef PRODUCT
608   virtual void format( PhaseRegAlloc *, outputStream *st ) const;
609 #endif
610 };
611 
612 //------------------------------BlackholeNode----------------------------
613 // Blackhole all arguments. This node would survive through the compiler
614 // the effects on its arguments, and would be finally matched to nothing.
615 class BlackholeNode : public MultiNode {
616 public:
617   BlackholeNode(Node* ctrl) : MultiNode(1) {
618     init_req(TypeFunc::Control, ctrl);
619   }
620   virtual int   Opcode() const;
621   virtual uint ideal_reg() const { return 0; } // not matched in the AD file
622   virtual const Type* bottom_type() const { return TypeTuple::MEMBAR; }
623 
624   const RegMask &in_RegMask(uint idx) const {
625     // Fake the incoming arguments mask for blackholes: accept all registers
626     // and all stack slots. This would avoid any redundant register moves
627     // for blackhole inputs.
628     return RegMask::All;
629   }
630 #ifndef PRODUCT
631   virtual void format(PhaseRegAlloc* ra, outputStream* st) const;
632 #endif
633 };
634 
635 
636 #endif // SHARE_OPTO_CFGNODE_HPP