/*

 * Copyright (c) 2003, 2018, 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/strace/strace001.

 * VM testbase keywords: [stress, quick, strace]

 * VM testbase readme:

 * DESCRIPTION

 *     The test checks up java.lang.Thread.getStackTrace() method for many threads,

 *     that recursively invoke a pure java method in running mode ("alive" stack).

 *     The test fails if:

 *     - amount of stack trace elements is more than depth of recursion plus

 *       four elements corresponding to invocations of Thread.run(), Thread.wait(),

 *       Thread.exit(), Thread.yield() and ThreadGroup.remove() methods;

 *     - there is at least one element corresponding to invocation of unexpected

 *       method.

 *

 * @library /vmTestbase

 *          /test/lib

 * @run driver jdk.test.lib.FileInstaller . .

 * @run main/othervm nsk.stress.strace.strace001

 */

package nsk.stress.strace;

import nsk.share.ArgumentParser;

import nsk.share.Failure;

import nsk.share.Log;

import java.io.PrintStream;

/**

 * The test check up <code>java.lang.Thread.getStackTrace()</code> method for many threads,

 * that recursively invoke a pure java method in running mode ("alive" stack).

 * <p>

 * <p>The test creates <code>THRD_COUNT</code> instances of <code>strace001Thread</code>

 * class, tries to get their stack traces and checks up that returned array contains

 * correct stack frames. Each stack frame must be corresponded to one of the following

 * methods defined by the <code>EXPECTED_METHODS</code> array.</p>

 * <p>These checking are performed <code>REPEAT_COUNT</code> times.</p>

 */

public class strace001 {

    static final int DEPTH = 200;

    static final int THRD_COUNT = 100;

    static final int REPEAT_COUNT = 10;

    static final String[] EXPECTED_METHODS = {

            "java.lang.System.arraycopy",

            "java.lang.Object.wait",

            "java.lang.Thread.exit",

            "java.lang.Thread.yield",

            "java.lang.ThreadGroup.remove",

            "java.lang.ThreadGroup.threadTerminated",

            "nsk.stress.strace.strace001Thread.run",

            "nsk.stress.strace.strace001Thread.recursiveMethod"

    };

    static volatile boolean isLocked = false;

    static PrintStream out;

    static long waitTime = 2;

    static Object waitStart = new Object();

    static strace001Thread[] threads;

    static StackTraceElement[][] snapshots = new StackTraceElement[THRD_COUNT][];

    static Log log;

    public static void main(String[] args) {

        out = System.out;

        int exitCode = run(args);

        System.exit(exitCode + 95);

    }

    volatile int achivedCount = 0;

    public static int run(String[] args) {

        ArgumentParser argHandler = new ArgumentParser(args);

        log = new Log(out, argHandler);

        waitTime = argHandler.getWaitTime() * 60000;

        strace001 test = new strace001();

        boolean res = true;

        for (int j = 0; j < REPEAT_COUNT; j++) {

            test.startThreads();

            if (!test.makeSnapshot(j + 1)) res = false;

            display("waiting for threads finished\n");

            test.finishThreads();

        }

        if (!res) {

            complain("***>>>Test failed<<<***");

            return 2;

        }

        return 0;

    }

    void startThreads() {

        threads = new strace001Thread[THRD_COUNT];

        achivedCount = 0;

        String tmp_name;

        for (int i = 0; i < THRD_COUNT; i++) {

            tmp_name = "strace001Thread" + Integer.toString(i);

            threads[i] = new strace001Thread(this, tmp_name);

        }

        for (int i = 0; i < THRD_COUNT; i++) {

            threads[i].start();

        }

        waitFor("all threads started ...");

        synchronized (waitStart) {

            isLocked = true;

            waitStart.notifyAll();

        }

        try {

            Thread.yield();

            Thread.sleep(1);

        } catch (InterruptedException e) {

            complain("" + e);

        }

    }

    void waitFor(String msg) {

        if (msg.length() > 0)

            display("waiting for " + msg);

        while (achivedCount < THRD_COUNT) {

            try {

                Thread.sleep(1);

            } catch (InterruptedException e) {

                complain("" + e);

            }

        }

        achivedCount = 0;

    }

    boolean makeSnapshot(int repeat_number) {

        for (int i = 0; i < threads.length; i++) {

            snapshots[i] = threads[i].getStackTrace();

        }

        return checkTraces(repeat_number);

    }

    boolean checkTraces(int repeat_number) {

        StackTraceElement[] elements;

        boolean res = true;

        display(">>> snapshot " + repeat_number);

        int expectedCount = DEPTH + 1;

        for (int i = 0; i < threads.length; i++) {

            elements = snapshots[i];

            if (elements == null)

                continue;

            if (elements.length == 0)

                continue;

            if (elements.length > 3) {

                display("\tchecking " + threads[i].getName()

                        + "(trace elements: " + elements.length + ")");

            }

            if (elements.length > expectedCount) {

                complain(threads[i].getName() + ">Contains more then " +

                        +expectedCount + " elements");

            }

            for (int j = 0; j < elements.length; j++) {

                if (!checkElement(elements[j])) {

                    complain(threads[i].getName() + ">Unexpected method name: "

                            + elements[j].getMethodName());

                    complain("\tat " + j + " position");

                    if (elements[j].isNativeMethod()) {

                        complain("\tline number: (native method)");

                        complain("\tclass name: " + elements[j].getClassName());

                    } else {

                        complain("\tline number: " + elements[j].getLineNumber());

                        complain("\tclass name: " + elements[j].getClassName());

                        complain("\tfile name: " + elements[j].getFileName());

                    }

                    res = false;

                }

            }

        }

        return res;

    }

    boolean checkElement(StackTraceElement element) {

        String name = element.getClassName() + "." + element.getMethodName();

        for (int i = 0; i < EXPECTED_METHODS.length; i++) {

            if (EXPECTED_METHODS[i].compareTo(name) == 0)

                return true;

        }

        return false;

    }

    void finishThreads() {

        try {

            for (int i = 0; i < threads.length; i++) {

                if (threads[i].isAlive())

                    threads[i].join(waitTime / THRD_COUNT);

            }

        } catch (InterruptedException e) {

            complain("" + e);

        }

        isLocked = false;

    }

    static void display(String message) {

        log.display(message);

    }

    static void complain(String message) {

        log.complain(message);

    }

}

class strace001Thread extends Thread {

    private int currentDepth = 0;

    strace001 test;

    strace001Thread(strace001 test, String name) {

        this.test = test;

        setName(name);

    }

    public void run() {

        try {

            recursiveMethod();

        } catch (Throwable throwable) {

            System.err.println("# ERROR: " + getName() + ": " + throwable);

            System.exit(1);

        }

    }

    void recursiveMethod() {

        currentDepth++;

        if (currentDepth == 1) {

            synchronized (test) {

                test.achivedCount++;

            }

            int alltime = 0;

            while (!strace001.isLocked) {

                synchronized (test) {

                    try {

                        test.wait(1);

                        alltime++;

                    } catch (InterruptedException e) {

                        strace001.complain("" + e);

                    }

                    if (alltime > strace001.waitTime) {

                        throw new Failure("out of wait time");

                    }

                }

            }

        }

        if (strace001.DEPTH - currentDepth > 0) {

            recursiveMethod();

        }

        currentDepth--;

    }

}