test/hotspot/jtreg/vmTestbase/nsk/jdwp/ObjectReference/GetValues/getvalues001.java
changeset 50317 cf71bff5f533
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/hotspot/jtreg/vmTestbase/nsk/jdwp/ObjectReference/GetValues/getvalues001.java	Wed May 30 20:54:45 2018 -0700
@@ -0,0 +1,426 @@
+/*
+ * 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.ObjectReference.GetValues;
+
+import java.io.*;
+
+import nsk.share.*;
+import nsk.share.jpda.*;
+import nsk.share.jdwp.*;
+
+/**
+ * Test for JDWP command: ObjectReference.GetValues.
+ *
+ * See getvalues001.README for description of test execution.
+ *
+ * Test is executed by invoking method runIt().
+ * JDWP command is tested in method testCommand().
+ *
+ * @see #runIt()
+ * @see #testCommand()
+ */
+public class getvalues001 {
+
+    // exit status constants
+    static final int JCK_STATUS_BASE = 95;
+    static final int PASSED = 0;
+    static final int FAILED = 2;
+
+    // communication signals constants
+    static final String READY = "ready";
+    static final String QUIT = "quit";
+
+    // package and classes names constants
+    static final String PACKAGE_NAME = "nsk.jdwp.ObjectReference.GetValues";
+    static final String TEST_CLASS_NAME = PACKAGE_NAME + "." + "getvalues001";
+    static final String DEBUGEE_CLASS_NAME = TEST_CLASS_NAME + "a";
+
+    // tested JDWP command constants
+    static final String JDWP_COMMAND_NAME = "ObjectReference.GetValues";
+    static final int JDWP_COMMAND_ID = JDWP.Command.ObjectReference.GetValues;
+
+    // tested class name and signature constants
+    static final String TESTED_CLASS_NAME = DEBUGEE_CLASS_NAME + "$" + "TestedClass";
+    static final String TESTED_CLASS_SIGNATURE = "L" + TESTED_CLASS_NAME.replace('.', '/') + ";";
+
+    // name of the static field in the tested class with the tested object value
+    static final String OBJECT_FIELD_NAME = getvalues001a.OBJECT_FIELD_NAME;
+
+    // names and expected values of the tested fields
+    static final Object fields [][] = {
+                    { "booleanValue", "boolean",  new Boolean(true),           "own"},
+                    { "byteValue",    "byte",     new Byte((byte)0x0F),        "own"},
+                    { "charValue",    "char",     new Character('Z'),          "own"},
+                    { "intValue",     "int",      new Integer(100),            "own"},
+                    { "shortValue",   "short",    new Short((short)10),        "own"},
+                    { "longValue",    "long",     new Long((long)1000000),     "own"},
+                    { "floatValue",   "float",    new Float((float)3.14),      "own"},
+                    { "doubleValue",  "double",   new Double((double)2.8e-12), "own"},
+                    { "objectValue",  "objectID", new Long((long)0),           "own"},
+
+                };
+    static final int FIELDS_COUNT = fields.length;
+
+    // usual scaffold objects
+    ArgumentHandler argumentHandler = null;
+    Log log = null;
+    Binder binder = null;
+    Debugee debugee = null;
+    Transport transport = null;
+    IOPipe pipe = null;
+
+    // test passed or not
+    boolean success = true;
+
+    // -------------------------------------------------------------------
+
+    /**
+     * Start test from command line.
+     */
+    public static void main (String argv[]) {
+        System.exit(run(argv,System.out) + JCK_STATUS_BASE);
+    }
+
+    /**
+     * Start JCK-compilant test.
+     */
+    public static int run(String argv[], PrintStream out) {
+        return new getvalues001().runIt(argv, out);
+    }
+
+    // -------------------------------------------------------------------
+
+    /**
+     * Perform test execution.
+     */
+    public int runIt(String argv[], PrintStream out) {
+
+        // make log for debugger messages
+        argumentHandler = new ArgumentHandler(argv);
+        log = new Log(out, argumentHandler);
+
+        // execute test and display results
+        try {
+            log.display("\n>>> Preparing debugee for testing \n");
+
+            // launch debugee
+            binder = new Binder(argumentHandler, log);
+            log.display("Launching debugee");
+            debugee = binder.bindToDebugee(DEBUGEE_CLASS_NAME);
+            transport = debugee.getTransport();
+            pipe = debugee.createIOPipe();
+
+            // make debuggee ready for testing
+            prepareDebugee();
+
+            // work with prepared debugee
+            try {
+                log.display("\n>>> Obtaining requred data from debugee \n");
+
+                // query debugee for TypeID of tested class
+                log.display("Getting ReferenceTypeID by signature:\n"
+                            + "  " + TESTED_CLASS_SIGNATURE);
+                long classID = debugee.getReferenceTypeID(TESTED_CLASS_SIGNATURE);
+                log.display("  got classID: " + classID);
+
+                // query debuggee for objectID value from static field
+                log.display("Getting objectID value from static field: "
+                            + OBJECT_FIELD_NAME);
+                long objectID = queryObjectID(classID,
+                            OBJECT_FIELD_NAME, JDWP.Tag.OBJECT);
+                log.display("  got objectID: " + objectID);
+
+                // query debugee for fieldIDs of tested class static fields
+                log.display("Getting fieldIDs the tested class with the tested values");
+                long fieldIDs[] = queryClassFieldIDs(classID);
+
+                // perform testing JDWP command
+                log.display("\n>>> Testing JDWP command \n");
+                testCommand(objectID, fieldIDs);
+
+            } finally {
+                // quit debugee
+                log.display("\n>>> Finishing test \n");
+                quitDebugee();
+            }
+
+        } catch (Failure e) {
+            log.complain("TEST FAILED: " + e.getMessage());
+            e.printStackTrace(out);
+            success = false;
+        } catch (Exception e) {
+            log.complain("Caught unexpected exception:\n" + e);
+            e.printStackTrace(out);
+            success = false;
+        }
+
+        if (!success) {
+            log.complain("TEST FAILED");
+            return FAILED;
+        }
+
+        out.println("TEST PASSED");
+        return PASSED;
+
+    }
+
+    /**
+     * Prepare debugee for testing and waiting for ready signal.
+     */
+    void prepareDebugee() {
+        // wait for VM_INIT event from debugee
+        log.display("Waiting for VM_INIT event");
+        debugee.waitForVMInit();
+
+        // query debugee for VM-dependent ID sizes
+        log.display("Querying for IDSizes");
+        debugee.queryForIDSizes();
+
+        // resume initially suspended debugee
+        log.display("Resuming debugee VM");
+        debugee.resume();
+
+        // wait for READY signal from debugee
+        log.display("Waiting for signal from debugee: " + READY);
+        String signal = pipe.readln();
+        log.display("Received signal from debugee: " + signal);
+        if (! signal.equals(READY)) {
+            throw new TestBug("Unexpected signal received form debugee: " + signal
+                            + " (expected: " + READY + ")");
+        }
+    }
+
+    /**
+     * Sending debugee signal to quit and waiting for it exits.
+     */
+    void quitDebugee() {
+        // send debugee signal to quit
+        log.display("Sending signal to debugee: " + QUIT);
+        pipe.println(QUIT);
+
+        // wait for debugee exits
+        log.display("Waiting for debugee exits");
+        int code = debugee.waitFor();
+
+        // analize debugee exit status code
+        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;
+        }
+    }
+
+    /**
+     * Query debuggee for objectID value of static class field.
+     */
+    long queryObjectID(long classID, String fieldName, byte tag) {
+        // get fieledID for static field (declared in the class)
+        long fieldID = debugee.getClassFieldID(classID, fieldName, true);
+        // get value of the field
+        JDWP.Value value = debugee.getStaticFieldValue(classID, fieldID);
+
+        // check that value has THREAD tag
+        if (value.getTag() != tag) {
+            throw new Failure("Wrong objectID tag received from field \"" + fieldName
+                            + "\": " + value.getTag() + " (expected: " + tag + ")");
+        }
+
+        // extract threadID from the value
+        long objectID = ((Long)value.getValue()).longValue();
+        return objectID;
+    }
+
+    /**
+     * Query debugee for fieldIDs and them into nested_classesIDs array.
+     */
+    long[] queryClassFieldIDs(long typeID) {
+        // create array for expected filedIDs
+        long fieldIDs[] = new long[FIELDS_COUNT];
+        for (int i = 0; i < FIELDS_COUNT; i++) {
+            fieldIDs[i] = 0;
+        }
+
+        // obtain requested fieldIDs form debuggee
+        int count = 0;
+        try {
+            CommandPacket command = new CommandPacket(JDWP.Command.ReferenceType.Fields);
+            command.addReferenceTypeID(typeID);
+            command.setLength();
+
+            ReplyPacket reply = debugee.receiveReplyFor(command);
+            reply.resetPosition();
+
+            long declared = reply.getInt();
+            if (declared < FIELDS_COUNT) {
+                throw new Failure("Too few fields of the tested class returned: " + declared
+                                    + " (expected: at least " + FIELDS_COUNT + ")");
+            }
+
+            for (int i = 0; i < declared; i++ ) {
+                long fieldID = reply.getFieldID();
+                String name = reply.getString();
+                String signature = reply.getString();
+                int modBits = reply.getInt();
+
+                for (int j = 0; j < FIELDS_COUNT; j++) {
+                    if (fields[j][0].equals(name)) {
+                        fieldIDs[j] = fieldID;
+                        break;
+                    }
+                }
+            }
+
+            if (!reply.isParsed()) {
+                throw new Failure("Extra trailing bytes found in the reply packet at: "
+                                    + reply.currentPosition());
+            }
+
+        } catch (BoundException e) {
+            throw new Failure("Unable to extract field IDs from the reply packet:\n"
+                            + e.getMessage());
+        }
+
+        return fieldIDs;
+    }
+
+    /**
+     * Extract and check i-th value from the reply packet.
+     */
+    void checkValue(int i, JDWP.Value value) {
+        if (!fields[i][2].equals(value.getValue())) {
+            log.complain("Unexpected value for " + i + " field received: " + value
+                            + " (expected: " + fields[i][2] + ")");
+            success = false;
+        }
+    }
+
+    /**
+     * Perform testing JDWP command for specified objectID.
+     */
+    void testCommand(long objectID, long fieldIDs[]) {
+        int count = fieldIDs.length;
+
+        // create command packet
+        log.display("Create command packet:");
+        log.display("Command: " + JDWP_COMMAND_NAME);
+        CommandPacket command = new CommandPacket(JDWP_COMMAND_ID);
+
+        // add out data to the command packet
+        log.display("  objectID: " + objectID);
+        command.addObjectID(objectID);
+        log.display("  fields: " + count);
+        command.addInt(count);
+        for (int i = 0; i < count; i++) {
+            log.display("  #" + i +": fieldID: " + fieldIDs[i]);
+            command.addFieldID(fieldIDs[i]);
+        }
+        command.setLength();
+
+        // send command packet to debugee
+        try {
+            log.display("Sending command packet:\n" + command);
+            transport.write(command);
+        } catch (IOException e) {
+            log.complain("Unable to send command packet:\n" + e);
+            success = false;
+            return;
+        }
+
+        ReplyPacket reply = new ReplyPacket();
+
+        // receive reply packet from debugee
+        try {
+            log.display("Waiting for reply packet");
+            transport.read(reply);
+            log.display("Reply packet received:\n" + reply);
+        } catch (IOException e) {
+            log.complain("Unable to read reply packet:\n" + e);
+            success = false;
+            return;
+        }
+
+        // check reply packet header
+        try{
+            log.display("Checking reply packet header");
+            reply.checkHeader(command.getPacketID());
+        } catch (BoundException e) {
+            log.complain("Bad header of reply packet: " + e.getMessage());
+            success = false;
+        }
+
+        // start parsing reply packet data
+        log.display("Parsing reply packet:");
+        reply.resetPosition();
+
+        // extract and check number of values
+        int values = 0;
+        try {
+            values = reply.getInt();
+            log.display("  values: " + values);
+
+        } catch (BoundException e) {
+            log.complain("Unable to extract number of values form reply packet:\n" + e.getMessage());
+            success = false;
+        }
+
+        // check if number of values are as expected
+        if (values < 0) {
+            log.complain("Negative number of values received:" + values
+                        + " (expected: " + count + ")");
+            success = false;
+        } else if (values != count) {
+            log.complain("Unexpected number of values received:" + values
+                        + " (expected: " + count + ")");
+            success = false;
+        }
+
+        // extract and check each value
+        for (int i = 0; i < values; i++ ) {
+            log.display("  value #" + i + " (field: " + fields[i][0] + ")");
+
+            // extract value
+            JDWP.Value value = null;
+            try {
+                value = reply.getValue();
+                log.display("    value: " + value);
+            } catch (BoundException e) {
+                log.complain("Unable to extract " + i + " value:\n" + e.getMessage());
+                success = false;
+                break;
+            }
+
+            // extract and check value by known type tag
+            checkValue(i, value);
+        }
+
+        // check for extra data in reply packet
+        if (! reply.isParsed()) {
+            log.complain("Extra trailing bytes found in reply packet at: "
+                        + "0x" + reply.toHexString(reply.currentDataPosition(), 4));
+            success = false;
+        }
+    }
+
+}