jdk-24/test/hotspot/jtreg/runtime/stack/Stack015.java

/*
 * Copyright (c) 2000, 2024, 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
 * @key stress
 *
 * @summary converted from VM testbase nsk/stress/stack/stack015.
 * VM testbase keywords: [stress, stack, nonconcurrent]
 * VM testbase readme:
 * DESCRIPTION
 *     This test provokes multiple stack overflows in the multiple
 *     threads -- by invoking synchronized virtual recursive method
 *     for the given fixed depth of recursion from within another
 *     recursive method already deeply invoked.
 *     This test measures a number of recursive invocations until
 *     stack overflow, and then tries to provoke similar stack overflows
 *     in 10 times in each of 10 threads. Each provocation consists of
 *     invoking that recursive method for the given fixed depth
 *     of invocations which is 100 times that depth measured before.
 *     The test is deemed passed, if VM have not crashed, and
 *     if exception other than due to stack overflow was not
 *     thrown.
 * COMMENTS
 *     This test crashes HS versions 2.0, 1.3, and 1.4 on Solaris.
 *     However, it passes against all these HS versions on Win32.
 *     See the bug:
 *     4366625 (P4/S4) multiple stack overflow causes HS crash
 *
 * @requires vm.opt.DeoptimizeALot != true
 * @run main/othervm/timeout=900 Stack015
 */

public class Stack015 extends Stack015i {
    final static int THREADS = 10;
    final static int CYCLES = 10;
    final static int STEP = 10;
    final static int RESERVE = 100;

    public static void main(String[] args) {
        //
        // The test will invoke the particular Stack015.recurse()
        // method via abstract test.recurse() invocations.
        //
        Stack015i test = new Stack015();
        Stack015i.test = test;

        //
        // Measure maximal recursion depth until stack overflow:
        //
        int maxDepth = 0;
        for (int depth = 0; ; depth += STEP) {
            try {
                test.recurse(depth);
                maxDepth = depth;
            } catch (StackOverflowError | OutOfMemoryError err) {
                break;
            }
        }
        System.out.println("Max. depth: " + maxDepth);

        //
        // Execute multiple threads repeatedly provoking stack overflows:
        //
        Stack015i threads[] = new Stack015i[THREADS];
        for (int i = 0; i < threads.length; i++) {
            threads[i] = new Stack015();
            threads[i].depthToTry = RESERVE * maxDepth;
            threads[i].start();
        }
        for (int i = 0; i < threads.length; i++) {
            if (threads[i].isAlive()) {
                try {
                    threads[i].join();
                } catch (InterruptedException exception) {
                    throw new RuntimeException(exception);
                }
            }
        }
        //
        // Check if unexpected exceptions were thrown:
        //
        for (int i = 0; i < threads.length; i++) {
            if (threads[i].thrown != null) {
                threads[i].thrown.printStackTrace();
                throw new RuntimeException("Exception in the thread " + threads[i], threads[i].thrown);
            }
        }
    }

    synchronized void syncRecurse(int depth) {
        if (depth > 0) {
            syncRecurse(depth - 1);
        }
    }
}

abstract class Stack015i extends Thread {
    //
    // Pure virtual method:
    //
    abstract void syncRecurse(int depth);

    void recurse(int depth) {
        //
        // Stack overflow must occur here:
        //
        syncRecurse(Stack015.STEP);
        //
        // If no stack overflow occured, try again with deeper stack:
        //
        if (depth > 0) {
            recurse(depth - 1);
        }
    }

    Throwable thrown = null;
    int depthToTry;

    static Stack015i test;

    public void run() {
        //
        // Provoke multiple stack overflows:
        //
        for (int i = 0; i < Stack015.CYCLES; i++) {
            try {
                //
                // All threads invoke the same synchronized method:
                //
                test.recurse(depthToTry);

                throw new Exception(
                        "TEST_RFE: no stack overflow thrown" +
                                ", need to try deeper recursion?");

            } catch (StackOverflowError | OutOfMemoryError err) {
                // It's OK
            } catch (Throwable throwable) {
                // It isn't OK!
                thrown = throwable;
                break;
            }
        }
    }
}