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