From 1092a927dc106864506492334527eee7001d41c0 Mon Sep 17 00:00:00 2001
From: jimmyk <jimmyk@ca.ibm.com>
Date: Tue, 9 Feb 2021 15:58:45 -0500
Subject: [PATCH] Enable Global Lock Reservation by default on Power

Global Lock Reservation is now enabled by default on Power. This is the same
behavior as if the -XX:+GlobalLockReservation option was used. To use the
previous form of lock reservation, Global Lock Reservation can be disabled
with the option -XX:-GlobalLockReservation.

Global Lock Reservation is not supported on other platforms so this change
only affects Power.

Updated documentation and comments to reflect Global Lock Reservation now
being on by default on Power.

Issue: #11424
Signed-off-by: jimmyk <jimmyk@ca.ibm.com>
---
 doc/compiler/ObjectLockword.md                |  4 ++--
 .../compiler/p/codegen/J9TreeEvaluator.cpp    |  4 ++--
 runtime/vm/jvminit.c                          | 21 +++++++++++--------
 3 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/doc/compiler/ObjectLockword.md b/doc/compiler/ObjectLockword.md
index 506d3d4eee0..4c44c1b1567 100644
--- a/doc/compiler/ObjectLockword.md
+++ b/doc/compiler/ObjectLockword.md
@@ -1,5 +1,5 @@
 <!--
-Copyright (c) 2019, 2020 IBM Corp. and others
+Copyright (c) 2019, 2021 IBM Corp. and others
 
 This program and the accompanying materials are made available under
 the terms of the Eclipse Public License 2.0 which accompanies this
@@ -275,7 +275,7 @@ The Inflated state is also the same as before. It is used to handle cases where
 ## Current Lock Reservation <a name="current-reservation"></a>
 x86 and z have not been fully updated to use all the features of the new lockword format. As such, they effectively use the original system with a lockword that has a 4 bit RC instead of 5 bits. The Learning bit is always set to 0.
 
-Under Power, lock reservation is now controlled by the `-XX:+GlobalLockReservation` option. Without the option, lockwords are always initialized to Flat-Unlocked and never reach any of the Reserved or Learning states. With the option set, lockwords may be initialized to New-PreLearning, New-AutoReserve or Flat-Unlocked. `-XX:-GlobalLockReservation` (note the minus sign) can be used to disable lock reservation. Lock reservation is disabled by default so this is only useful to override an enable option that occurs earlier in command line processing.
+Under Power, Global Lock Reservation is enabled by default. Lockwords may be initialized to New-PreLearning, New-AutoReserve or Flat-Unlocked. To disable Global Lock Reservation, the `-XX:-GlobalLockReservation` option must be set. when the option is set, lockwords are always initialized to Flat-Unlocked and the original lock reservation scheme is used. `-XX:+GlobalLockReservation` (note the plus sign) can be used to enable lock reservation (if it was disabled by an option that occurs earlier in command line processing) or to modify some of the lock reservation related suboptions that are described later in this document.
 
 ### Reservation Process
 The purpose of the new Learning state is to try and reduce the number of lock reservation cancellations by acting as a halfway step towards reservation. If the same object is locked by the same thread enough times without another thread attempting to lock the object, then a prediction is made that it will be safe to reserve the object. The object will transition to a Reserved state. This information is tracked in the Learning state exclusive LC field. The first time a new object is locked it transitions from New-PreLearning to Learning-Locked but the LC will remain at 0. If the same thread locks the object again, even if it is a nested locking action, the LC is incremented. When the LC is equal to `reservedTransitionThreshold` (default value of 1), the next time the object is locked by the same thread it will go to Reserved-Locked instead of Learning-Locked. `reservedTransitionThreshold` can be set via the option `-XX:+GlobalLockReservation:reservedTransitionThreshold=#`. Due to the LC field only having 2 bits, values of `reservedTransitionThreshold` of 4 or higher will prevent transition from Learning to Reserved.
diff --git a/runtime/compiler/p/codegen/J9TreeEvaluator.cpp b/runtime/compiler/p/codegen/J9TreeEvaluator.cpp
index 4c93a660736..4a9db079378 100644
--- a/runtime/compiler/p/codegen/J9TreeEvaluator.cpp
+++ b/runtime/compiler/p/codegen/J9TreeEvaluator.cpp
@@ -4980,7 +4980,7 @@ TR::Register *J9::Power::TreeEvaluator::VMmonexitEvaluator(TR::Node *node, TR::C
       baseReg = objectClassReg;
       }
 
-   /* If the -XX:+GlobalLockReservation option is NOT set, try to use the original aggressive reserved locking code path. */
+   /* If the -XX:-GlobalLockReservation option is set, try to use the original aggressive reserved locking code path. */
    if (!fej9->isEnableGlobalLockReservationSet())
       {
       bool reserveLocking = false, normalLockWithReservationPreserving = false;
@@ -7405,7 +7405,7 @@ TR::Register *J9::Power::TreeEvaluator::VMmonentEvaluator(TR::Node *node, TR::Co
       baseReg = objectClassReg;
       }
 
-   /* If the -XX:+GlobalLockReservation option is NOT set, try to use the original aggressive reserved locking code path. */
+   /* If the -XX:-GlobalLockReservation option is set, try to use the original aggressive reserved locking code path. */
    if (!fej9->isEnableGlobalLockReservationSet())
       {
       bool reserveLocking = false, normalLockWithReservationPreserving = false;
diff --git a/runtime/vm/jvminit.c b/runtime/vm/jvminit.c
index d192099f9df..a7a68e51614 100644
--- a/runtime/vm/jvminit.c
+++ b/runtime/vm/jvminit.c
@@ -2424,8 +2424,14 @@ IDATA VMInitStages(J9JavaVM *vm, IDATA stage, void* reserved) {
 				printLockwordWhat(vm);
 			}
 
-			/* Global Lock Reservation is off by default. */
+			/* Global Lock Reservation is currently only supported on Power. */
+#if defined(AIXPPC) || defined(LINUXPPC)
+			/* Global Lock Reservation is ON by default on Power. */
+			vm->enableGlobalLockReservation = 1;
+#else
+			/* Global Lock Reservation is OFF by default on other platforms. */
 			vm->enableGlobalLockReservation = 0;
+#endif /* defined(AIXPPC) || defined(LINUXPPC) */
 
 			/* Set default parameters for Global Lock Reservation. */
 			vm->reservedTransitionThreshold = 1;
@@ -2437,22 +2443,19 @@ IDATA VMInitStages(J9JavaVM *vm, IDATA stage, void* reserved) {
 			argIndex = FIND_AND_CONSUME_ARG(EXACT_MATCH, VMOPT_XXNOGLOBALLOCKRESERVATION, NULL);
 			argIndex2 = FIND_AND_CONSUME_ARG(EXACT_MATCH, VMOPT_XXGLOBALLOCKRESERVATION, NULL);
 
-			if ((argIndex2 >= 0) && (argIndex2 > argIndex)) {
-				/* Global Lock Reservation is currently only supported on Power. */
-#if defined(AIXPPC) || defined(LINUXPPC)
-				vm->enableGlobalLockReservation = 1;
-#endif /* defined(AIXPPC) || defined(LINUXPPC) */
+			if ((argIndex >= 0) && (argIndex > argIndex2)) {
+				vm->enableGlobalLockReservation = 0;
 			}
 
 			argIndex2 = FIND_AND_CONSUME_ARG_FORWARD(STARTSWITH_MATCH, VMOPT_XXGLOBALLOCKRESERVATIONCOLON, NULL);
 
 			while (argIndex2 >= 0) {
-				if (argIndex2 > argIndex) {
-					/* Global Lock Reservation is currently only supported on Power. */
+				/* Global Lock Reservation is currently only supported on Power. */
 #if defined(AIXPPC) || defined(LINUXPPC)
+				if (argIndex2 > argIndex) {
 					vm->enableGlobalLockReservation = 1;
-#endif /* defined(AIXPPC) || defined(LINUXPPC) */
 				}
+#endif /* defined(AIXPPC) || defined(LINUXPPC) */
 
 				optionValue = NULL;
 				GET_OPTION_OPTION(argIndex2, ':', ':', &optionValue);