1 /*
  2  * Copyright (c) 1997, 2024, 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 #include "precompiled.hpp"
 26 #include "oops/oop.inline.hpp"
 27 #include "runtime/basicLock.inline.hpp"
 28 #include "runtime/objectMonitor.hpp"
 29 #include "runtime/synchronizer.hpp"
 30 
 31 void BasicLock::print_on(outputStream* st, oop owner) const {
 32   st->print("monitor");
 33   if (UseObjectMonitorTable) {
 34     ObjectMonitor* mon = object_monitor_cache();
 35     if (mon != nullptr) {
 36       mon->print_on(st);
 37     }
 38   } else if (LockingMode == LM_LEGACY) {
 39     markWord mark_word = displaced_header();
 40     if (mark_word.value() != 0) {
 41       // Print monitor info if there's an owning oop and it refers to this BasicLock.
 42       bool print_monitor_info = (owner != nullptr) && (owner->mark() == markWord::from_pointer((void*)this));
 43       mark_word.print_on(st, print_monitor_info);
 44     }
 45   }
 46 }
 47 
 48 void BasicLock::move_to(oop obj, BasicLock* dest) {
 49   // Check to see if we need to inflate the lock. This is only needed
 50   // if an object is locked using "this" lightweight monitor. In that
 51   // case, the displaced_header() is unlocked/neutral, because the
 52   // displaced_header() contains the header for the originally unlocked
 53   // object. However the lock could have already been inflated. But it
 54   // does not matter, this inflation will just be a no-op. For other cases,
 55   // the displaced header will be either 0x0 or 0x3, which are location
 56   // independent, therefore the BasicLock is free to move.
 57   //
 58   // During OSR we may need to relocate a BasicLock (which contains a
 59   // displaced word) from a location in an interpreter frame to a
 60   // new location in a compiled frame.  "this" refers to the source
 61   // BasicLock in the interpreter frame.  "dest" refers to the destination
 62   // BasicLock in the new compiled frame.  We *always* inflate in move_to()
 63   // when the object is locked using "this" lightweight monitor.
 64   //
 65   // The always-Inflate policy works properly, but it depends on the
 66   // inflated fast-path operations in fast_lock and fast_unlock to avoid
 67   // performance problems. See x86/macroAssembler_x86.cpp: fast_lock()
 68   // and fast_unlock() for examples.
 69   //
 70   // Note that there is a way to safely swing the object's markword from
 71   // one stack location to another.  This avoids inflation.  Obviously,
 72   // we need to ensure that both locations refer to the current thread's stack.
 73   // There are some subtle concurrency issues, however, and since the benefit is
 74   // small (given the support for inflated fast-path locking in the fast_lock, etc)
 75   // we'll leave that optimization for another time.
 76 
 77   if (LockingMode == LM_LEGACY) {
 78     if (displaced_header().is_neutral()) {
 79       // The object is locked and the resulting ObjectMonitor* will also be
 80       // locked so it can't be async deflated until ownership is dropped.
 81       ObjectSynchronizer::inflate_helper(obj);
 82       // WARNING: We cannot put a check here, because the inflation
 83       // will not update the displaced header. Once BasicLock is inflated,
 84       // no one should ever look at its content.
 85     } else {
 86       // Typically the displaced header will be 0 (recursive stack lock) or
 87       // unused_mark.  Naively we'd like to assert that the displaced mark
 88       // value is either 0, neutral, or 3.  But with the advent of the
 89       // store-before-CAS avoidance in fast_lock/compiler_lock_object
 90       // we can find any flavor mark in the displaced mark.
 91     }
 92     dest->set_displaced_header(displaced_header());
 93   } else if (UseObjectMonitorTable) {
 94     // Preserve the ObjectMonitor*, the cache is cleared when a box is reused
 95     // and only read while the lock is held, so no stale ObjectMonitor* is
 96     // encountered.
 97     dest->set_object_monitor_cache(object_monitor_cache());
 98   }
 99 #ifdef ASSERT
100   else {
101     dest->set_bad_metadata_deopt();
102   }
103 #endif
104 }