threadgroup001.java

/*
 * Copyright (c) 2001, 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.
 */

package nsk.jdwp.ThreadReference.ThreadGroup;

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

import nsk.share.*;
import nsk.share.jpda.*;
import nsk.share.jdwp.*;

public class threadgroup001 {
    static final int JCK_STATUS_BASE = 95;
    static final int PASSED = 0;
    static final int FAILED = 2;
    static final String PACKAGE_NAME = "nsk.jdwp.ThreadReference.ThreadGroup";
    static final String TEST_CLASS_NAME = PACKAGE_NAME + "." + "threadgroup001";
    static final String DEBUGEE_CLASS_NAME = TEST_CLASS_NAME + "a";

    static final String JDWP_COMMAND_NAME = "ThreadReference.ThreadGroup";
    static final int JDWP_COMMAND_ID = JDWP.Command.ThreadReference.ThreadGroup;

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

    public static int run(String argv[], PrintStream out) {
        return new threadgroup001().runIt(argv, out);
    }

    public int runIt(String argv[], PrintStream out) {

        boolean success = true;

        try {
            ArgumentHandler argumentHandler = new ArgumentHandler(argv);
            Log log = new Log(out, argumentHandler);

            try {

                Binder binder = new Binder(argumentHandler, log);
                log.display("Start debugee VM");
                Debugee debugee = binder.bindToDebugee(DEBUGEE_CLASS_NAME);
                Transport transport = debugee.getTransport();
                IOPipe pipe = debugee.createIOPipe();

                log.display("Waiting for VM_INIT event");
                debugee.waitForVMInit();

                log.display("Querying for IDSizes");
                debugee.queryForIDSizes();

                log.display("Resume debugee VM");
                debugee.resume();

                log.display("Waiting for command: " + "ready");
                String cmd = pipe.readln();
                log.display("Received command: " + cmd);


                try {

                    // get top level thread groups

                    log.display("Getting IDs for top level thread groups");

                    long[] threadGroupIDs = null;
                    int groups = 0;

                    {
                        log.display("Create command packet " + "TopLevelThreadGroups");
                        CommandPacket command = new CommandPacket(JDWP.Command.VirtualMachine.TopLevelThreadGroups);

                        log.display("Waiting for reply to command");
                        ReplyPacket reply = debugee.receiveReplyFor(command);
                        log.display("Valid reply packet received");

                        log.display("Parsing reply packet:");
                        reply.resetPosition();

                        groups = reply.getInt();
                        log.display("  groups: " + groups);

                        threadGroupIDs = new long[groups];

                        for (int i = 0; i < groups; i++) {
                            long threadGroupID = reply.getObjectID();
                            log.display("  #" + i + " threadGroupID: " + threadGroupID);
                            threadGroupIDs[i] = threadGroupID;
                        }

                        if (groups < 0) {
                            log.complain("Negative number of thread groups returned while getting top level thread groups IDs: " + groups);
                            success = false;
                        }

                        if (groups == 0) {
                            log.complain("No thread groups IDs returned while getting top level thread groups IDs: " + groups);
                            success = false;
                        }

                    }

                    // get threads from all thread groups found

                    boolean found = false;
                    long checkedThreadGroupID = 0;

                    long[] threadIDs = null;
                    int threads = 0;

                    for (int i = 0; i < groups; i++) {
                        checkedThreadGroupID = threadGroupIDs[i];
                        log.display("Getting IDs of the thread from thread group: #" + i);

                        log.display("Create command packet " +
                                                "ThreadGroupReference.Children");
                        CommandPacket command = new CommandPacket(JDWP.Command.ThreadGroupReference.Children);
                        command.addObjectID(checkedThreadGroupID);
                        command.setLength();

                        log.display("Waiting for reply to command");
                        ReplyPacket reply = debugee.receiveReplyFor(command);
                        log.display("Valid reply packet received");

                        log.display("Parsing reply packet:");
                        reply.resetPosition();

                        threads = reply.getInt();
                        log.display("  threads: " + threads);

                        threadIDs = new long[threads];

                        for (int j = 0; j < threads; j++) {
                            long threadID = reply.getObjectID();
                            log.display("  #" + j + " threadID: " + threadID);
                            threadIDs[j] = threadID;
                        }

                        if (threads < 0) {
                            log.complain("Negative number of threads in the thread group: " + threads);
                            success = false;
                        }

                        if (threads > 0) {
                            log.display("Testing threads from thread group: #" + i);
                            found = true;
                        }
                    }

                    if (!found) {
                        log.complain("No threads found in all top level thread groups");
                        success = false;
                    }

                    // begin test of JDWP command

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

                        long threadID = threadIDs[i];

                        log.display("");
                        log.display("Getting ThreadGroup ID for " + i + " thread ID: "
                                        + threadID);
                        log.display("Create command " + JDWP_COMMAND_NAME
                                        + " with thread ID: " + threadID);
                        CommandPacket command = new CommandPacket(JDWP_COMMAND_ID);
                        command.addObjectID(threadID);
                        command.setLength();

                        log.display("Sending command packet:\n" + command);
                        transport.write(command);

                        log.display("Waiting for reply packet");
                        ReplyPacket reply = new ReplyPacket();
                        transport.read(reply);
                        log.display("Reply packet received:\n" + reply);

                        log.display("Checking reply packet header");
                        reply.checkHeader(command.getPacketID());

                        log.display("Parsing reply packet:");
                        reply.resetPosition();

                        long threadGroupID = reply.getObjectID();
                        log.display("  group: " + threadGroupID);

                        if (threadGroupID != checkedThreadGroupID) {
                            log.complain("Unexpected threadGroupID returned for a thread: " + threadGroupID
                                            + " (expected: " + checkedThreadGroupID + ")");
                            success = false;
                        }

                        if (! reply.isParsed()) {
                            log.complain("Extra trailing bytes found in reply packet at: " + reply.currentPosition());
                            success = false;
                        } else {
                            log.display("Reply packet parsed successfully");
                        }

                    }

                   // end test of JDWP command

                } catch (Exception e) {
                    log.complain("Caught exception while testing JDWP command: " + e);
                    success = false;
                } finally {
                    log.display("");
                    log.display("Sending command: " + "quit");
                    pipe.println("quit");

                    log.display("Waiting for debugee exits");
                    int code = debugee.waitFor();
                    if (code == JCK_STATUS_BASE + PASSED) {
                        log.display("Debugee PASSED with exit code: " + code);
                    } else {
                        log.complain("Debugee FAILED with exit code: " + code);
                        success = false;
                    }
                }

            } catch (Exception e) {
                log.complain("Caught unexpected exception while communicating with debugee: " + e);
                e.printStackTrace(out);
                success = false;
            }

            if (!success) {
                log.complain("TEST FAILED");
                return FAILED;
            }

        } catch (Exception e) {
            out.println("Caught unexpected exception while starting the test: " + e);
            e.printStackTrace(out);
            out.println("TEST FAILED");
            return FAILED;
        }

        out.println("TEST PASSED");
        return PASSED;

    }

}