untrace001.java

/*
 * Copyright (c) 2002, 2020, 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
 *
 * @summary converted from VM Testbase nsk/jdb/untrace/untrace001.
 * VM Testbase keywords: [jpda, jdb]
 * VM Testbase readme:
 * DECSRIPTION
 * A positive test case for the 'untrace methods <thread id>' command.
 * The debuggee program (untrace001a.java) creates an additional
 * thread with name like "MyThread-1" and starts it. The jdb
 * suspends the debuggee at a moment when the additional thread is
 * waiting for notification for lock objects and then turns on method
 * tracing for this thread by 'trace methods <thread id>' command.
 * After expected notification the additional thread invokes checked
 * debuggee's methods. Thus jdb output must have the trace messages of checked methods'
 * entrance and exit.
 * At second phase jdb suspends the debuggee and turns off tracing
 * by checked command. After resuming the debuggee's additional
 * thread invokes checked methods again. Tracing messages and debuggee's
 * suspentions are not expected at this moment.
 * The test passes if jdb output has one 'enter' messages and one 'exit'
 * messages for every checked method.
 * The test consists of two program:
 *   untrace001.java - launches jdb and debuggee, writes commands to jdb, reads the jdb output,
 *   untrace001a.java - the debugged application.
 * COMMENTS
 * Modified due to fix of the bug:
 *  4785781 TTY: debuggee hangs in jdb 'untrace001' test in Mantis
 *
 * @library /vmTestbase
 *          /test/lib
 * @build nsk.jdb.untrace.untrace001.untrace001a
 * @run main/othervm
 *      nsk.jdb.untrace.untrace001.untrace001
 *      -arch=${os.family}-${os.simpleArch}
 *      -waittime=5
 *      -debugee.vmkind=java
 *      -transport.address=dynamic
 *      -jdb=${test.jdk}/bin/jdb
 *      -java.options="${test.vm.opts} ${test.java.opts}"
 *      -workdir=.
 *      -debugee.vmkeys="${test.vm.opts} ${test.java.opts}"
 */

package nsk.jdb.untrace.untrace001;

import nsk.share.*;
import nsk.share.jdb.*;

import java.io.*;
import java.util.*;

public class untrace001 extends JdbTest {

    public static void main (String argv[]) {
        System.exit(run(argv, System.out) + JCK_STATUS_BASE);
    }

    public static int run(String argv[], PrintStream out) {
        debuggeeClass =  DEBUGGEE_CLASS;
        firstBreak = FIRST_BREAK;
        lastBreak = LAST_BREAK;
        return new untrace001().runTest(argv, out);
    }

    static final String PACKAGE_NAME    = "nsk.jdb.untrace.untrace001";
    static final String TEST_CLASS      = PACKAGE_NAME + ".untrace001";
    static final String DEBUGGEE_CLASS  = TEST_CLASS + "a";
    static final String FIRST_BREAK     = DEBUGGEE_CLASS + ".main";
    static final String LAST_BREAK      = DEBUGGEE_CLASS + ".breakHere";
    static final String MYTHREAD        = "MyThread";
    static final String DEBUGGEE_THREAD = PACKAGE_NAME + "." + MYTHREAD;

    static final String[] CHECKED_METHODS = {"func1", "func2", "func3"};

    protected void runCases() {
        String[] reply;
        Paragrep grep;
        int count;
        Vector v;
        String found;
        String[] threads;

        jdb.setBreakpointInMethod(LAST_BREAK);
        reply = jdb.receiveReplyFor(JdbCommand.cont);

        threads = jdb.getThreadIds(DEBUGGEE_THREAD);

        if (threads.length != 1) {
            log.complain("jdb should report 1 instance of " + DEBUGGEE_THREAD);
            log.complain("Found: " + threads.length);
            success = false;
        }

        for (int i = 0; i < threads.length; i++) {
            reply = jdb.receiveReplyFor(JdbCommand.trace + "methods " + threads[i]);
        }

        // resumes debuggee suspended on method enter and exit until hit of the breakpoint
        for (int i = 0; i < (CHECKED_METHODS.length*threads.length*2 + 1); i++) {
            reply = jdb.receiveReplyFor(JdbCommand.cont);
        }

        for (int i = 0; i < threads.length; i++) {
            reply = jdb.receiveReplyFor(JdbCommand.untrace + "methods " + threads[i]);
        }

        jdb.contToExit(CHECKED_METHODS.length*threads.length*2 + 2);

        reply = jdb.getTotalReply();
        if (!checkTrace(CHECKED_METHODS, reply)) {
            success = false;
        }
    }

    private boolean checkTrace (String[] checkedMethods, String[] reply) {
        Paragrep grep;
        String found;
        int count;
        Vector v = new Vector();
        boolean result = true;

        grep = new Paragrep(reply);
        for (int i = 0; i < checkedMethods.length; i++) {
            v.removeAllElements();
            v.add(DEBUGGEE_THREAD + "." + checkedMethods[i]);
            v.add("Method entered");
            count = grep.find(v);
            if (count != 1) {
                log.complain("Count of method enter is incorrect for the method : " + DEBUGGEE_THREAD + "." + checkedMethods[i]);
                log.complain("Should be 1 trace messages, found : " + count);
                result= false;
            }

            v.removeAllElements();
            v.add(DEBUGGEE_THREAD + "." + checkedMethods[i]);
            v.add("Method exited");
            count = grep.find(v);
            if (count != 1) {
                log.complain("Count of method exit is incorrect for the method : " + DEBUGGEE_THREAD + "." + checkedMethods[i]);
                log.complain("Should be 1 trace messages, found : " + count);
                result= false;
            }
        }
        return result;
    }
}