/*

 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.

 * Copyright (c) 2019 SAP SE. 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 Test extended NullPointerException message for

 *   classfiles generated with debug information. In this case the name

 *   of the variable containing the array is printed.

 * @bug 8218628

 * @modules java.base/java.lang:open

 *          java.base/jdk.internal.org.objectweb.asm

 * @library /test/lib

 * @compile -g NullPointerExceptionTest.java

 * @run main/othervm -XX:MaxJavaStackTraceDepth=1 -XX:+ShowCodeDetailsInExceptionMessages NullPointerExceptionTest hasDebugInfo

 */

/**

 * @test

 * @summary Test extended NullPointerException message for class

 *   files generated without debugging information. The message lists

 *   detailed information about the entity that is null.

 * @bug 8218628

 * @modules java.base/java.lang:open

 *          java.base/jdk.internal.org.objectweb.asm

 * @library /test/lib

 * @compile NullPointerExceptionTest.java

 * @run main/othervm -XX:MaxJavaStackTraceDepth=1 -XX:+ShowCodeDetailsInExceptionMessages NullPointerExceptionTest

 */

import java.io.ByteArrayInputStream;

import java.io.ByteArrayOutputStream;

import java.io.ObjectInputStream;

import java.io.ObjectOutputStream;

import java.lang.invoke.MethodHandles.Lookup;

import java.util.ArrayList;

import jdk.internal.org.objectweb.asm.ClassWriter;

import jdk.internal.org.objectweb.asm.Label;

import jdk.internal.org.objectweb.asm.MethodVisitor;

import jdk.test.lib.Asserts;

import static java.lang.invoke.MethodHandles.lookup;

import static jdk.internal.org.objectweb.asm.Opcodes.ACC_PUBLIC;

import static jdk.internal.org.objectweb.asm.Opcodes.ACC_SUPER;

import static jdk.internal.org.objectweb.asm.Opcodes.ACONST_NULL;

import static jdk.internal.org.objectweb.asm.Opcodes.ALOAD;

import static jdk.internal.org.objectweb.asm.Opcodes.ASTORE;

import static jdk.internal.org.objectweb.asm.Opcodes.GETFIELD;

import static jdk.internal.org.objectweb.asm.Opcodes.GETSTATIC;

import static jdk.internal.org.objectweb.asm.Opcodes.ICONST_1;

import static jdk.internal.org.objectweb.asm.Opcodes.ICONST_2;

import static jdk.internal.org.objectweb.asm.Opcodes.INVOKESPECIAL;

import static jdk.internal.org.objectweb.asm.Opcodes.INVOKEVIRTUAL;

import static jdk.internal.org.objectweb.asm.Opcodes.ARETURN;

import static jdk.internal.org.objectweb.asm.Opcodes.IRETURN;

import static jdk.internal.org.objectweb.asm.Opcodes.RETURN;

/**

 * Tests NullPointerExceptions

 */

public class NullPointerExceptionTest {

    // Some fields used in the test.

    static Object nullStaticField;

    NullPointerExceptionTest nullInstanceField;

    static int[][][][] staticArray;

    static long[][] staticLongArray = new long[1000][];

    DoubleArrayGen dag;

    ArrayList<String> names = new ArrayList<>();

    ArrayList<String> curr;

    static boolean hasDebugInfo = false;

    static {

        staticArray       = new int[1][][][];

        staticArray[0]    = new int[1][][];

        staticArray[0][0] = new int[1][];

    }

    public static void checkMessage(Throwable t, String expression,

                                    String obtainedMsg, String expectedMsg) {

        System.out.println("\nSource code:\n  " + expression + "\n\nOutput:");

        t.printStackTrace(System.out);

        if (obtainedMsg != expectedMsg && // E.g. both are null.

            !obtainedMsg.equals(expectedMsg)) {

            System.out.println("expected msg: " + expectedMsg);

            Asserts.assertEquals(expectedMsg, obtainedMsg);

        }

        System.out.println("\n----");

    }

    public static void main(String[] args) throws Exception {

        NullPointerExceptionTest t = new NullPointerExceptionTest();

        if (args.length > 0) {

            hasDebugInfo = true;

        }

        System.out.println("Tests for the first part of the message:");

        System.out.println("========================================\n");

        // Test the message printed for the failed action.

        t.testFailedAction();

        System.out.println("Tests for the second part of the message:");

        System.out.println("=========================================\n");

        // Test the method printed for the null entity.

        t.testNullEntity();

        System.out.println("Further tests:");

        System.out.println("==============\n");

        // Test if parameters are used in the code.

        // This is relevant if there is no debug information.

        t.testParameters();

        // Test that no message is printed for exceptions

        // allocated explicitly.

        t.testCreation();

        // Test that no message is printed for exceptions

        // thrown in native methods.

        t.testNative();

        // Test that two calls to getMessage() return the same

        // message.

        // It is a design decision that it returns two different

        // String objects.

        t.testSameMessage();

        // Test serialization.

        // It is a design decision that after serialization the

        // the message is lost.

        t.testSerialization();

        // Test that messages are printed for code generated

        // on-the-fly.

        t.testGeneratedCode();

        // Some more interesting complex messages.

        t.testComplexMessages();

    }

    // Helper method to cause test case.

    private double callWithTypes(String[][] dummy1, int[][][] dummy2, float dummy3, long dummy4, short dummy5,

                                 boolean dummy6, byte dummy7, double dummy8, char dummy9) {

        return 0.0;

    }

    @SuppressWarnings("null")

    public void testFailedAction() {

        int[]     ia1 = null;

        float[]   fa1 = null;

        Object[]  oa1 = null;

        boolean[] za1 = null;

        byte[]    ba1 = null;

        char[]    ca1 = null;

        short[]   sa1 = null;

        long[]    la1 = null;

        double[]  da1 = null;

        // iaload

        try {

            int val = ia1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "int val = ia1[0];", e.getMessage(),

                         "Cannot load from int array because " +

                         (hasDebugInfo ? "\"ia1\"" : "\"<local1>\"") + " is null");

        }

        // faload

        try {

            float val = fa1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "float val = fa1[0];", e.getMessage(),

                         "Cannot load from float array because " +

                         (hasDebugInfo ? "\"fa1\"" : "\"<local2>\"") + " is null");

        }

        // aaload

        try {

            Object val = oa1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "Object val = oa1[0];", e.getMessage(),

                         "Cannot load from object array because " +

                         (hasDebugInfo ? "\"oa1\"" : "\"<local3>\"") + " is null");

        }

        // baload (boolean)

        try {

            boolean val = za1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "boolean val = za1[0];", e.getMessage(),

                         "Cannot load from byte/boolean array because " +

                         (hasDebugInfo ? "\"za1\"" : "\"<local4>\"") + " is null");

        }

        // baload (byte)

        try {

            byte val = ba1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "byte val = ba1[0];", e.getMessage(),

                         "Cannot load from byte/boolean array because " +

                         (hasDebugInfo ? "\"ba1\"" : "\"<local5>\"") + " is null");

        }

        // caload

        try {

            char val = ca1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "char val = ca1[0];", e.getMessage(),

                         "Cannot load from char array because " +

                         (hasDebugInfo ? "\"ca1\"" : "\"<local6>\"") + " is null");

        }

        // saload

        try {

            short val = sa1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "short val = sa1[0];", e.getMessage(),

                         "Cannot load from short array because " +

                         (hasDebugInfo ? "\"sa1\"" : "\"<local7>\"") + " is null");

        }

        // laload

        try {

            long val = la1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "long val = la1[0];", e.getMessage(),

                         "Cannot load from long array because " +

                         (hasDebugInfo ? "\"la1\"" : "\"<local8>\"") + " is null");

        }

        // daload

        try {

            double val = da1[0];

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "double val = da1[0];", e.getMessage(),

                         "Cannot load from double array because " +

                         (hasDebugInfo ? "\"da1\"" : "\"<local9>\"") + " is null");

        }

        // iastore

        try {

            ia1[0] = 0;

            System.out.println(ia1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "ia1[0] = 0;", e.getMessage(),

                         "Cannot store to int array because " +

                         (hasDebugInfo ? "\"ia1\"" : "\"<local1>\"") + " is null");

        }

        // fastore

        try {

            fa1[0] = 0.7f;

            System.out.println(fa1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "fa1[0] = 0.7f;", e.getMessage(),

                         "Cannot store to float array because " +

                         (hasDebugInfo ? "\"fa1\"" : "\"<local2>\"") + " is null");

        }

        // aastore

        try {

            oa1[0] = new Object();

            System.out.println(oa1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "oa1[0] = new Object();", e.getMessage(),

                         "Cannot store to object array because " +

                         (hasDebugInfo ? "\"oa1\"" : "\"<local3>\"") + " is null");

        }

        // bastore (boolean)

        try {

            za1[0] = false;

            System.out.println(za1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "za1[0] = false;", e.getMessage(),

                         "Cannot store to byte/boolean array because " +

                         (hasDebugInfo ? "\"za1\"" : "\"<local4>\"") + " is null");

        }

        // bastore (byte)

        try {

            ba1[0] = 0;

            System.out.println(ba1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "ba1[0] = 0;", e.getMessage(),

                         "Cannot store to byte/boolean array because " +

                         (hasDebugInfo ? "\"ba1\"" : "\"<local5>\"") + " is null");

        }

        // castore

        try {

            ca1[0] = 0;

            System.out.println(ca1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "ca1[0] = 0;", e.getMessage(),

                         "Cannot store to char array because " +

                         (hasDebugInfo ? "\"ca1\"" : "\"<local6>\"") + " is null");

        }

        // sastore

        try {

            sa1[0] = 0;

            System.out.println(sa1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "sa1[0] = 0;", e.getMessage(),

                         "Cannot store to short array because " +

                         (hasDebugInfo ? "\"sa1\"" : "\"<local7>\"") + " is null");

        }

        // lastore

        try {

            la1[0] = 0;

            System.out.println(la1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "la1[0] = 0;", e.getMessage(),

                         "Cannot store to long array because " +

                         (hasDebugInfo ? "\"la1\"" : "\"<local8>\"") + " is null");

        }

        // dastore

        try {

            da1[0] = 0;

            System.out.println(da1[0]);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "da1[0] = 0;", e.getMessage(),

                         "Cannot store to double array because " +

                         (hasDebugInfo ? "\"da1\"" : "\"<local9>\"") + " is null");

        }

        // arraylength

        try {

            int val = za1.length;

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, " int val = za1.length;", e.getMessage(),

                         "Cannot read the array length because " +

                         (hasDebugInfo ? "\"za1\"" : "\"<local4>\"") + " is null");

        }

        // athrow

        try {

            RuntimeException exc = null;

            throw exc;

        } catch (NullPointerException e) {

            checkMessage(e, "throw exc;", e.getMessage(),

                         "Cannot throw exception because " +

                         (hasDebugInfo ? "\"exc\"" : "\"<local10>\"") + " is null");

        }

        // monitorenter

        try {

            synchronized (nullInstanceField) {

                // desired

            }

        } catch (NullPointerException e) {

            checkMessage(e, "synchronized (nullInstanceField) { ... }", e.getMessage(),

                         "Cannot enter synchronized block because " +

                         "\"this.nullInstanceField\" is null");

        }

        // monitorexit

        // No test available

        // getfield

        try {

            Object val = nullInstanceField.nullInstanceField;

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "Object val = nullInstanceField.nullInstanceField;", e.getMessage(),

                         "Cannot read field \"nullInstanceField\" because " +

                         "\"this.nullInstanceField\" is null");

        }

        // putfield

        try {

            nullInstanceField.nullInstanceField = new NullPointerExceptionTest();

            System.out.println(nullInstanceField.nullInstanceField);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "nullInstanceField.nullInstanceField = new NullPointerExceptionTest();", e.getMessage(),

                         "Cannot assign field \"nullInstanceField\" because " +

                         "\"this.nullInstanceField\" is null");

        }

        // invokevirtual

        try {

            String val = nullInstanceField.toString();

            System.out.println(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "String val = nullInstanceField.toString();", e.getMessage(),

                         "Cannot invoke \"Object.toString()\" because " +

                         "\"this.nullInstanceField\" is null");

        }

        // invokeinterface

        try {

            NullPointerExceptionTest obj = this;

            Object val = obj.dag.getArray();

            Asserts.assertNull(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "Object val = obj.dag.getArray();", e.getMessage(),

                         "Cannot invoke \"NullPointerExceptionTest$DoubleArrayGen.getArray()\" because " +

                         (hasDebugInfo ? "\"obj" : "\"<local10>") + ".dag\" is null");

        }

        // invokespecial

        G g = null;

        try {

            byte[] classBytes = G.generateSub2GTestClass();

            Lookup lookup = lookup();

            Class<?> clazz = lookup.defineClass(classBytes);

            g = (G) clazz.getDeclaredConstructor().newInstance();

        } catch (Exception e) {

            e.printStackTrace();

            Asserts.fail("Generating class Sub2G failed.");

        }

        try {

            g.m2("Beginning");

        } catch (NullPointerException e) {

            checkMessage(e, "return super.m2(x).substring(2); // ... where super is null by bytecode manipulation.", e.getMessage(),

                         "Cannot invoke \"G.m2(String)\" because \"null\" is null");

        }

        // Test parameter and return types

        try {

            boolean val = (nullInstanceField.callWithTypes(null, null, 0.0f, 0L, (short)0, false, (byte)0, 0.0, 'x') == 0.0);

            Asserts.assertTrue(val);

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "boolean val = (nullInstanceField.callWithTypes(null, null, 0.0f, 0L, (short)0, false, (byte)0, 0.0, 'x') == 0.0);", e.getMessage(),

                         "Cannot invoke \"NullPointerExceptionTest.callWithTypes(String[][], int[][][], float, long, short, boolean, byte, double, char)\" because " +

                         "\"this.nullInstanceField\" is null");

        }

    }

    static void test_iload() {

        int i0 = 0;

        int i1 = 1;

        int i2 = 2;

        int i3 = 3;

        @SuppressWarnings("unused")

        int i4 = 4;

        int i5 = 5;

        int[][] a = new int[6][];

        // iload_0

        try {

            a[i0][0] = 77;

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "a[i0][0] = 77;", e.getMessage(),

                         "Cannot store to int array because " +

                         (hasDebugInfo ? "\"a[i0]\"" : "\"<local6>[<local0>]\"") + " is null");

        }

        // iload_1

        try {

            a[i1][0] = 77;

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "a[i1][0] = 77;", e.getMessage(),

                         "Cannot store to int array because " +

                         (hasDebugInfo ? "\"a[i1]\"" : "\"<local6>[<local1>]\"") + " is null");

        }

        // iload_2

        try {

            a[i2][0] = 77;

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "a[i2][0] = 77;", e.getMessage(),

                         "Cannot store to int array because " +

                         (hasDebugInfo ? "\"a[i2]\"" : "\"<local6>[<local2>]\"") + " is null");

        }

        // iload_3

        try {

            a[i3][0] = 77;

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "a[i3][0] = 77;", e.getMessage(),

                         "Cannot store to int array because " +

                         (hasDebugInfo ? "\"a[i3]\"" : "\"<local6>[<local3>]\"") + " is null");

        }

        // iload

        try {

            a[i5][0] = 77;

            Asserts.fail();

        } catch (NullPointerException e) {

            checkMessage(e, "a[i5][0] = 77;", e.getMessage(),

                         "Cannot store to int array because " +

                         (hasDebugInfo ? "\"a[i5]\"" : "\"<local6>[<local5>]\"") + " is null");

        }

    }

    // Other datatyes than int are not needed.

    // If we implement l2d and similar bytecodes, we can print

    // long expressions as array indexes. Then these here could

    // be used.

    static void test_lload() {

        long long0 = 0L;  // l0 looks like 10. Therefore long0.

        long long1 = 1L;

        long long2 = 2L;