1 /*
   2  * Copyright (c) 1999, 2015, 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_VM_OPTO_LOCKNODE_HPP
  26 #define SHARE_VM_OPTO_LOCKNODE_HPP
  27 
  28 #include "opto/node.hpp"
  29 #include "opto/opcodes.hpp"
  30 #include "opto/subnode.hpp"
  31 #if defined AD_MD_HPP
  32 # include AD_MD_HPP
  33 #elif defined TARGET_ARCH_MODEL_x86_32
  34 # include "adfiles/ad_x86_32.hpp"
  35 #elif defined TARGET_ARCH_MODEL_x86_64
  36 # include "adfiles/ad_x86_64.hpp"
  37 #elif defined TARGET_ARCH_MODEL_sparc
  38 # include "adfiles/ad_sparc.hpp"
  39 #elif defined TARGET_ARCH_MODEL_zero
  40 # include "adfiles/ad_zero.hpp"
  41 #elif defined TARGET_ARCH_MODEL_ppc_64
  42 # include "adfiles/ad_ppc_64.hpp"
  43 #elif defined TARGET_ARCH_MODEL_aarch32
  44 # include "adfiles/ad_aarch32.hpp"
  45 #endif
  46 
  47 //------------------------------BoxLockNode------------------------------------
  48 class BoxLockNode : public Node {
  49   const int     _slot; // stack slot
  50   RegMask     _inmask; // OptoReg corresponding to stack slot
  51   bool _is_eliminated; // Associated locks were safely eliminated
  52 
  53 public:
  54   BoxLockNode( int lock );
  55   virtual int Opcode() const;
  56   virtual void emit(CodeBuffer &cbuf, PhaseRegAlloc *ra_) const;
  57   virtual uint size(PhaseRegAlloc *ra_) const;
  58   virtual const RegMask &in_RegMask(uint) const;
  59   virtual const RegMask &out_RegMask() const;
  60   virtual uint size_of() const;
  61   virtual uint hash() const;
  62   virtual uint cmp( const Node &n ) const;
  63   virtual const class Type *bottom_type() const { return TypeRawPtr::BOTTOM; }
  64   virtual uint ideal_reg() const { return Op_RegP; }
  65 
  66   static OptoReg::Name reg(Node* box_node);
  67   static BoxLockNode* box_node(Node* box_node);
  68   static bool same_slot(Node* box1, Node* box2) {
  69     return box1->as_BoxLock()->_slot == box2->as_BoxLock()->_slot;
  70   }
  71   int stack_slot() const { return _slot; }
  72 
  73   bool is_eliminated() const { return _is_eliminated; }
  74   // mark lock as eliminated.
  75   void set_eliminated()      { _is_eliminated = true; }
  76 
  77   // Is BoxLock node used for one simple lock region?
  78   bool is_simple_lock_region(LockNode** unique_lock, Node* obj);
  79 
  80 #ifndef PRODUCT
  81   virtual void format( PhaseRegAlloc *, outputStream *st ) const;
  82   virtual void dump_spec(outputStream *st) const { st->print("  Lock %d",_slot); }
  83 #endif
  84 };
  85 
  86 //------------------------------FastLockNode-----------------------------------
  87 class FastLockNode: public CmpNode {
  88 private:
  89   BiasedLockingCounters*        _counters;
  90   RTMLockingCounters*       _rtm_counters; // RTM lock counters for inflated locks
  91   RTMLockingCounters* _stack_rtm_counters; // RTM lock counters for stack locks
  92 
  93 public:
  94   FastLockNode(Node *ctrl, Node *oop, Node *box) : CmpNode(oop,box) {
  95     init_req(0,ctrl);
  96     init_class_id(Class_FastLock);
  97     _counters = NULL;
  98     _rtm_counters = NULL;
  99     _stack_rtm_counters = NULL;
 100   }
 101   Node* obj_node() const { return in(1); }
 102   Node* box_node() const { return in(2); }
 103   void  set_box_node(Node* box) { set_req(2, box); }
 104 
 105   // FastLock and FastUnlockNode do not hash, we need one for each correspoding
 106   // LockNode/UnLockNode to avoid creating Phi's.
 107   virtual uint hash() const ;                  // { return NO_HASH; }
 108   virtual uint size_of() const;
 109   virtual uint cmp( const Node &n ) const ;    // Always fail, except on self
 110   virtual int Opcode() const;
 111   virtual const Type *Value( PhaseTransform *phase ) const { return TypeInt::CC; }
 112   const Type *sub(const Type *t1, const Type *t2) const { return TypeInt::CC;}
 113 
 114   void create_lock_counter(JVMState* s);
 115   void create_rtm_lock_counter(JVMState* state);
 116   BiasedLockingCounters*        counters() const { return _counters; }
 117   RTMLockingCounters*       rtm_counters() const { return _rtm_counters; }
 118   RTMLockingCounters* stack_rtm_counters() const { return _stack_rtm_counters; }
 119 };
 120 
 121 
 122 //------------------------------FastUnlockNode---------------------------------
 123 class FastUnlockNode: public CmpNode {
 124 public:
 125   FastUnlockNode(Node *ctrl, Node *oop, Node *box) : CmpNode(oop,box) {
 126     init_req(0,ctrl);
 127     init_class_id(Class_FastUnlock);
 128   }
 129   Node* obj_node() const { return in(1); }
 130   Node* box_node() const { return in(2); }
 131 
 132 
 133   // FastLock and FastUnlockNode do not hash, we need one for each correspoding
 134   // LockNode/UnLockNode to avoid creating Phi's.
 135   virtual uint hash() const ;                  // { return NO_HASH; }
 136   virtual uint cmp( const Node &n ) const ;    // Always fail, except on self
 137   virtual int Opcode() const;
 138   virtual const Type *Value( PhaseTransform *phase ) const { return TypeInt::CC; }
 139   const Type *sub(const Type *t1, const Type *t2) const { return TypeInt::CC;}
 140 
 141 };
 142 
 143 #endif // SHARE_VM_OPTO_LOCKNODE_HPP