8032970: Add stack size check methods to WhiteBox API

Reviewed-by: twisti, kvn, iignatyev

hotspot/src/share/vm/prims/whitebox.cpp

@@ -33,9 +33,11 @@
 #include "prims/whitebox.hpp"
 #include "prims/wbtestmethods/parserTests.hpp"
 
+#include "runtime/thread.hpp"
 #include "runtime/arguments.hpp"
 #include "runtime/interfaceSupport.hpp"
 #include "runtime/os.hpp"
+
 #include "utilities/debug.hpp"
 #include "utilities/macros.hpp"
 #include "utilities/exceptions.hpp"
@@ -576,6 +578,15 @@ WB_ENTRY(jobjectArray, WB_GetNMethod(JNIEnv* env, jobject o, jobject method, jbo
 WB_END
 
 
+WB_ENTRY(jlong, WB_GetThreadStackSize(JNIEnv* env, jobject o))
+  return (jlong) Thread::current()->stack_size();
+WB_END
+
+WB_ENTRY(jlong, WB_GetThreadRemainingStackSize(JNIEnv* env, jobject o))
+  JavaThread* t = JavaThread::current();
+  return (jlong) t->stack_available(os::current_stack_pointer()) - (jlong) StackShadowPages * os::vm_page_size();
+WB_END
+
 //Some convenience methods to deal with objects from java
 int WhiteBox::offset_for_field(const char* field_name, oop object,
     Symbol* signature_symbol) {
@@ -690,6 +701,8 @@ static JNINativeMethod methods[] = {
   {CC"getCPUFeatures",     CC"()Ljava/lang/String;",  (void*)&WB_GetCPUFeatures     },
   {CC"getNMethod",         CC"(Ljava/lang/reflect/Executable;Z)[Ljava/lang/Object;",
                                                       (void*)&WB_GetNMethod         },
+  {CC"getThreadStackSize", CC"()J",                   (void*)&WB_GetThreadStackSize },
+  {CC"getThreadRemainingStackSize", CC"()J",          (void*)&WB_GetThreadRemainingStackSize },
 };
 
 #undef CC

hotspot/test/TEST.groups

@@ -136,7 +136,8 @@ needs_compact3 = \
   serviceability/threads/TestFalseDeadLock.java \
   compiler/tiered/NonTieredLevelsTest.java \
   compiler/tiered/TieredLevelsTest.java \
-  compiler/intrinsics/bmi/verifycode
+  compiler/intrinsics/bmi/verifycode \
+  runtime/whitebox/WBStackSize.java
 
 # Compact 2 adds full VM tests
 compact2 = \

hotspot/test/runtime/whitebox/WBStackSize.java

@@ -0,0 +1,121 @@
+/*
+ * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test WBStackSize
+ * @summary verify that whitebox functions getThreadFullStackSize() and getThreadRemainingStackSize are working
+ * @library /testlibrary /testlibrary/whitebox
+ * @build WBStackSize
+ * @run main ClassFileInstaller sun.hotspot.WhiteBox
+ * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions -XX:+WhiteBoxAPI -Xss512k WBStackSize
+ */
+
+/*
+ * The test may product a false failure if too big StackYellowPages/StackRedPages/ShackShadowPages
+ * VM options are specified. The proper test would retrieve the page size from VM and account for these options
+ * instead of check below:
+ *     Math.abs(actualStackSize - configStackSize) > configStackSize * 0.1
+ *
+ * Please file a test bug, if this is a problem.
+ */
+
+import com.sun.management.HotSpotDiagnosticMXBean;
+import sun.hotspot.WhiteBox;
+
+public class WBStackSize {
+
+    static final long K = 1024;
+
+    static final long MIN_STACK_SIZE = 8 * K;
+    static final long MAX_STACK_SIZE_ALLOCATED_IN_MAIN = 200 * K; // current value is about 130k on 64-bit platforms
+
+    static final WhiteBox wb = WhiteBox.getWhiteBox();
+
+    static long stackSizeOnOverflow = -1;
+
+    static int eatAllStack() {
+        return eatAllStack() * 2;
+    }
+
+    static void testStackOverflow() {
+
+        stackSizeOnOverflow = wb.getThreadRemainingStackSize();
+
+        if (stackSizeOnOverflow > MIN_STACK_SIZE) {
+
+            try {
+                testStackOverflow();
+            } catch (StackOverflowError e) {
+                // We caught SOE too early. The error will be reported in main()
+            }
+
+        } else {
+
+            try {
+                eatAllStack();
+                throw new RuntimeException("Haven't caught StackOverflowError at all");
+            } catch (StackOverflowError e) {
+                // OK: we caught the anticipated error
+            }
+        }
+    }
+
+    public static void main(String[] args) {
+        HotSpotDiagnosticMXBean bean = sun.management.ManagementFactoryHelper.getDiagnosticMXBean();
+        long configStackSize = Long.valueOf(bean.getVMOption("ThreadStackSize").getValue()) * K;
+
+        System.out.println("ThreadStackSize VM option: " + configStackSize);
+
+        long actualStackSize = wb.getThreadStackSize();
+        System.out.println("Full stack size: " + actualStackSize);
+
+        if (Math.abs(actualStackSize - configStackSize) > configStackSize * 0.1) {
+            throw new RuntimeException("getThreadFullStackSize value [" + actualStackSize
+                                     + "] should be within 90%..110% of the value returned by HotSpotDiagnosticMXBean");
+        }
+
+        long remainingStackSize = wb.getThreadRemainingStackSize();
+        System.out.println("Remaining stack size in main(): " + remainingStackSize);
+
+        // Up to 200k can be already allocated by VM
+        if (remainingStackSize > configStackSize
+                || (configStackSize > MAX_STACK_SIZE_ALLOCATED_IN_MAIN
+                && remainingStackSize < configStackSize - MAX_STACK_SIZE_ALLOCATED_IN_MAIN)) {
+
+            throw new RuntimeException("getThreadRemainingStackSize value [" + remainingStackSize
+                                     + "] should be at least ThreadStackSize value [" + configStackSize + "] minus ["
+                                     + MAX_STACK_SIZE_ALLOCATED_IN_MAIN + "]");
+        }
+
+        testStackOverflow();
+
+        if (stackSizeOnOverflow > MIN_STACK_SIZE) {
+            throw new RuntimeException("Caught StackOverflowError too early: when there were "
+                                     + stackSizeOnOverflow + " bytes in stack");
+        } else if (stackSizeOnOverflow < 0) {
+            throw new RuntimeException("Internal test error: stackRemainingSize < 0");
+        } else {
+            System.out.println("Caught StackOverflowError as expected");
+        }
+    }
+}

hotspot/test/testlibrary/whitebox/sun/hotspot/WhiteBox.java

@@ -150,6 +150,8 @@ public class WhiteBox {
   public native int stressVirtualSpaceResize(long reservedSpaceSize, long magnitude, long iterations);
   public native void runMemoryUnitTests();
   public native void readFromNoaccessArea();
+  public native long getThreadStackSize();
+  public native long getThreadRemainingStackSize();
 
   // CPU features
   public native String getCPUFeatures();