8204943: Improve message of ArrayStoreException

Reviewed-by: lfoltan, hseigel

src/hotspot/share/oops/klass.cpp

@@ -142,7 +142,10 @@ void Klass::check_valid_for_instantiation(bool throwError, TRAPS) {
 
 
 void Klass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) {
-  THROW(vmSymbols::java_lang_ArrayStoreException());
+  ResourceMark rm(THREAD);
+  assert(s != NULL, "Throw NPE!");
+  THROW_MSG(vmSymbols::java_lang_ArrayStoreException(),
+            err_msg("arraycopy: source type %s is not an array", s->klass()->external_name()));
 }
 
 

src/hotspot/share/oops/objArrayKlass.cpp

@@ -235,7 +235,19 @@ void ObjArrayKlass::do_copy(arrayOop s, size_t src_offset,
       // slow case: need individual subtype checks
       // note: don't use obj_at_put below because it includes a redundant store check
       if (!ArrayAccess<ARRAYCOPY_DISJOINT | ARRAYCOPY_CHECKCAST>::oop_arraycopy(s, src_offset, d, dst_offset, length)) {
-        THROW(vmSymbols::java_lang_ArrayStoreException());
+        ResourceMark rm(THREAD);
+        stringStream ss;
+        if (!bound->is_subtype_of(stype)) {
+          ss.print("arraycopy: type mismatch: can not copy %s[] into %s[]",
+                   stype->external_name(), bound->external_name());
+        } else {
+          // oop_arraycopy should return the index in the source array that
+          // contains the problematic oop.
+          ss.print("arraycopy: element type mismatch: can not cast one of the elements"
+                   " of %s[] to the type of the destination array, %s",
+                   stype->external_name(), bound->external_name());
+        }
+        THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
       }
     }
   }
@@ -246,13 +258,21 @@ void ObjArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d,
   assert(s->is_objArray(), "must be obj array");
 
   if (!d->is_objArray()) {
-    THROW(vmSymbols::java_lang_ArrayStoreException());
+    ResourceMark rm(THREAD);
+    stringStream ss;
+    if (d->is_typeArray()) {
+      ss.print("arraycopy: type mismatch: can not copy object array[] into %s[]",
+               type2name_tab[ArrayKlass::cast(d->klass())->element_type()]);
+    } else {
+      ss.print("arraycopy: destination type %s is not an array", d->klass()->external_name());
+    }
+    THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
   }
 
   // Check is all offsets and lengths are non negative
   if (src_pos < 0 || dst_pos < 0 || length < 0) {
     // Pass specific exception reason.
-    ResourceMark rm;
+    ResourceMark rm(THREAD);
     stringStream ss;
     if (src_pos < 0) {
       ss.print("arraycopy: source index %d out of bounds for object array[%d]",
@@ -269,7 +289,7 @@ void ObjArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d,
   if ((((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) ||
       (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length())) {
     // Pass specific exception reason.
-    ResourceMark rm;
+    ResourceMark rm(THREAD);
     stringStream ss;
     if (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) {
       ss.print("arraycopy: last source index %u out of bounds for object array[%d]",

src/hotspot/share/oops/typeArrayKlass.cpp

@@ -131,15 +131,31 @@ oop TypeArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
 void TypeArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) {
   assert(s->is_typeArray(), "must be type array");
 
-  // Check destination
+  // Check destination type.
-  if (!d->is_typeArray() || element_type() != TypeArrayKlass::cast(d->klass())->element_type()) {
+  if (!d->is_typeArray()) {
-    THROW(vmSymbols::java_lang_ArrayStoreException());
+    ResourceMark rm(THREAD);
+    stringStream ss;
+    if (d->is_objArray()) {
+      ss.print("arraycopy: type mismatch: can not copy %s[] into object array[]",
+               type2name_tab[ArrayKlass::cast(s->klass())->element_type()]);
+    } else {
+      ss.print("arraycopy: destination type %s is not an array", d->klass()->external_name());
+    }
+    THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
+  }
+  if (element_type() != TypeArrayKlass::cast(d->klass())->element_type()) {
+    ResourceMark rm(THREAD);
+    stringStream ss;
+    ss.print("arraycopy: type mismatch: can not copy %s[] into %s[]",
+             type2name_tab[ArrayKlass::cast(s->klass())->element_type()],
+             type2name_tab[ArrayKlass::cast(d->klass())->element_type()]);
+    THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
   }
 
-  // Check is all offsets and lengths are non negative
+  // Check if all offsets and lengths are non negative.
   if (src_pos < 0 || dst_pos < 0 || length < 0) {
     // Pass specific exception reason.
-    ResourceMark rm;
+    ResourceMark rm(THREAD);
     stringStream ss;
     if (src_pos < 0) {
       ss.print("arraycopy: source index %d out of bounds for %s[%d]",
@@ -156,7 +172,7 @@ void TypeArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos
   if ((((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) ||
       (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length())) {
     // Pass specific exception reason.
-    ResourceMark rm;
+    ResourceMark rm(THREAD);
     stringStream ss;
     if (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) {
       ss.print("arraycopy: last source index %u out of bounds for %s[%d]",

src/hotspot/share/prims/jni.cpp

@@ -2630,7 +2630,17 @@ JNI_ENTRY(void, jni_SetObjectArrayElement(JNIEnv *env, jobjectArray array, jsize
     if (v == NULL || v->is_a(ObjArrayKlass::cast(a->klass())->element_klass())) {
       a->obj_at_put(index, v);
     } else {
-      THROW(vmSymbols::java_lang_ArrayStoreException());
+      ResourceMark rm(THREAD);
+      stringStream ss;
+      Klass *bottom_kl = ObjArrayKlass::cast(a->klass())->bottom_klass();
+      ss.print("type mismatch: can not store %s to %s[%d]",
+               v->klass()->external_name(),
+               bottom_kl->is_typeArray_klass() ? type2name_tab[ArrayKlass::cast(bottom_kl)->element_type()] : bottom_kl->external_name(),
+               index);
+      for (int dims = ArrayKlass::cast(a->klass())->dimension(); dims > 1; --dims) {
+        ss.print("[]");
+      }
+      THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
     }
   } else {
     char buf[jintAsStringSize];

test/hotspot/jtreg/runtime/exceptionMsgs/ArrayStoreException/ArrayStoreExceptionTest.java

@@ -0,0 +1,205 @@
+/*
+ * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018 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 ArrayStoreException message. The message lists
+ *   information about the array types involved.
+ * @library /test/lib
+ * @run main ArrayStoreExceptionTest
+ */
+
+import java.util.Date;
+import jdk.test.lib.Asserts;
+
+/**
+ * Tests the detailed messages of the ArrayStoreException.
+ */
+public class ArrayStoreExceptionTest {
+
+    static {
+        System.loadLibrary("ArrayStoreExceptionTest");
+    }
+
+    static void testASMessages(Object from, Object to, String message) throws Exception {
+        try {
+            System.arraycopy(from, 1, to, 3, 2);
+            Asserts.fail("Expected ArrayStoreException not thrown");
+        } catch (ArrayStoreException e) {
+            Asserts.assertEquals(e.getMessage(), message);
+        }
+    }
+
+    static native void doNativeArrayStore(Object[] src, Object dst, int index);
+
+    static void testNativeASMessages(Object[] array, Object elem, int index, String message)
+        throws Exception {
+        try {
+            doNativeArrayStore(array, elem, index);
+            Asserts.fail("Expected ArrayStoreException not thrown");
+        } catch (ArrayStoreException e) {
+            Asserts.assertEquals(e.getMessage(), message);
+        }
+    }
+
+    static native void doNativeArrayStore2(Object src, Object dst, int index);
+
+    static void testNativeASMessages2(Object array, Object elem, int index, String message)
+        throws Exception {
+        try {
+            doNativeArrayStore2(array, elem, index);
+            Asserts.fail("Expected ArrayStoreException not thrown");
+        } catch (ArrayIndexOutOfBoundsException e) {
+            Asserts.assertEquals(e.getMessage(), message);
+        }
+    }
+
+    public static void main(String[] args) throws Exception {
+        try {
+            boolean[]    za1 = new boolean[3];
+            byte[]       ba1 = new byte[3];
+            short[]      sa1 = new short[3];
+            char[]       ca1 = new char[3];
+            int[]        ia1 = new int[3];
+            long[]       la1 = new long[3];
+            float[]      fa1 = new float[3];
+            double[]     da1 = new double[3];
+            Object[]     oa1 = new Object[3];
+
+            boolean[]    za2 = new boolean[9];
+            byte[]       ba2 = new byte[9];
+            short[]      sa2 = new short[9];
+            char[]       ca2 = new char[9];
+            int[]        ia2 = new int[9];
+            long[]       la2 = new long[9];
+            float[]      fa2 = new float[9];
+            double[]     da2 = new double[9];
+            Object[]     oa2 = new Object[9];
+
+            boolean[][]  za3 = new boolean[9][9];
+            byte[][]     ba3 = new byte[9][9];
+            short[][]    sa3 = new short[9][9];
+            char[][]     ca3 = new char[9][9];
+            int[][]      ia3 = new int[9][9];
+            long[][]     la3 = new long[9][9];
+            float[][]    fa3 = new float[9][9];
+            double[][]   da3 = new double[9][9];
+            Object[][]   oa3 = new Object[9][9];
+
+            int[][][]    ia4 = new int[9][9][9];
+            Object[][][] oa4 = new Object[9][9][9];
+
+
+            testASMessages(za1, ba2, "arraycopy: type mismatch: can not copy boolean[] into byte[]");
+            testASMessages(ba1, sa2, "arraycopy: type mismatch: can not copy byte[] into short[]");
+            testASMessages(sa1, ca2, "arraycopy: type mismatch: can not copy short[] into char[]");
+            testASMessages(ca1, ia2, "arraycopy: type mismatch: can not copy char[] into int[]");
+            testASMessages(ia1, la2, "arraycopy: type mismatch: can not copy int[] into long[]");
+            testASMessages(la1, fa2, "arraycopy: type mismatch: can not copy long[] into float[]");
+            testASMessages(fa1, da2, "arraycopy: type mismatch: can not copy float[] into double[]");
+            testASMessages(da1, oa2, "arraycopy: type mismatch: can not copy double[] into object array[]");
+            testASMessages(oa1, za2, "arraycopy: type mismatch: can not copy object array[] into boolean[]");
+
+            testASMessages(za1, oa2, "arraycopy: type mismatch: can not copy boolean[] into object array[]");
+            testASMessages(ba1, za2, "arraycopy: type mismatch: can not copy byte[] into boolean[]");
+            testASMessages(sa1, ba2, "arraycopy: type mismatch: can not copy short[] into byte[]");
+            testASMessages(ca1, sa2, "arraycopy: type mismatch: can not copy char[] into short[]");
+            testASMessages(ia1, ca2, "arraycopy: type mismatch: can not copy int[] into char[]");
+            testASMessages(la1, ia2, "arraycopy: type mismatch: can not copy long[] into int[]");
+            testASMessages(fa1, la2, "arraycopy: type mismatch: can not copy float[] into long[]");
+            testASMessages(da1, fa2, "arraycopy: type mismatch: can not copy double[] into float[]");
+            testASMessages(oa1, da2, "arraycopy: type mismatch: can not copy object array[] into double[]");
+
+            testASMessages(za3, ba2, "arraycopy: type mismatch: can not copy object array[] into byte[]");
+            testASMessages(ba3, sa2, "arraycopy: type mismatch: can not copy object array[] into short[]");
+            testASMessages(sa3, ca2, "arraycopy: type mismatch: can not copy object array[] into char[]");
+            testASMessages(ca3, ia2, "arraycopy: type mismatch: can not copy object array[] into int[]");
+            testASMessages(ia3, la2, "arraycopy: type mismatch: can not copy object array[] into long[]");
+            testASMessages(la3, fa2, "arraycopy: type mismatch: can not copy object array[] into float[]");
+            testASMessages(fa3, da2, "arraycopy: type mismatch: can not copy object array[] into double[]");
+            testASMessages(oa3, za2, "arraycopy: type mismatch: can not copy object array[] into boolean[]");
+
+            testASMessages(za1, oa3, "arraycopy: type mismatch: can not copy boolean[] into object array[]");
+            testASMessages(ba1, za3, "arraycopy: type mismatch: can not copy byte[] into object array[]");
+            testASMessages(sa1, ba3, "arraycopy: type mismatch: can not copy short[] into object array[]");
+            testASMessages(ca1, sa3, "arraycopy: type mismatch: can not copy char[] into object array[]");
+            testASMessages(ia1, ca3, "arraycopy: type mismatch: can not copy int[] into object array[]");
+            testASMessages(la1, ia3, "arraycopy: type mismatch: can not copy long[] into object array[]");
+            testASMessages(fa1, la3, "arraycopy: type mismatch: can not copy float[] into object array[]");
+            testASMessages(da1, fa3, "arraycopy: type mismatch: can not copy double[] into object array[]");
+
+            //testASMessages(null, ba2,  "arraycopy: type mismatch: can not copy boolean[] into byte[]"); NPE
+            //testASMessages(za1,  null, "arraycopy: type mismatch: can not copy boolean[] into byte[]"); NPE
+            testASMessages("This is not an array", ia2, "arraycopy: source type java.lang.String is not an array");
+            testASMessages(la1, "This is not an array", "arraycopy: destination type java.lang.String is not an array");
+
+            //testASMessages(null, oa2,  "arraycopy: type mismatch: can not copy boolean[] into byte[]"); NPE
+            //testASMessages(oa1,  null, "arraycopy: type mismatch: can not copy boolean[] into byte[]"); NPE
+            testASMessages("This is not an array", oa2, "arraycopy: source type java.lang.String is not an array");
+            testASMessages(oa1, "This is not an array", "arraycopy: destination type java.lang.String is not an array");
+
+            String[] Sa1 = new String[3];
+            Date[]   Da1 = new Date[3];
+            String[] Sa2 = new String[9];
+            Date[]   Da2 = new Date[9];
+
+            for (int i = 0; i < 3; i++) {
+                Sa1[i] = "" + i;
+                oa1[i] = "" + i;
+            }
+            testASMessages(Sa1, Da2,
+                           "arraycopy: type mismatch: can not copy java.lang.String[] " +
+                           "into java.util.Date[]");
+            testASMessages(oa1, Da2,
+                           "arraycopy: element type mismatch: can not cast one of the " +
+                           "elements of java.lang.Object[] to the type of the destination " +
+                           "array, java.util.Date");
+
+            // These should succeed.
+            doNativeArrayStore(Sa1, "This is a string", 0);
+            doNativeArrayStore(oa1, "This is a string", 2);
+
+            testNativeASMessages(Da1, "This is not a date", 0,
+                                 "type mismatch: can not store java.lang.String to java.util.Date[0]");
+            testNativeASMessages(Da1, "This is not a date", 2,
+                                 "type mismatch: can not store java.lang.String to java.util.Date[2]");
+            testNativeASMessages(oa3, "This is not a date", 2,
+                                 "type mismatch: can not store java.lang.String to java.lang.Object[2][]");
+            testNativeASMessages(oa4, "This is not a date", 1,
+                                 "type mismatch: can not store java.lang.String to java.lang.Object[1][][]");
+            testNativeASMessages(ia3, "This is not a date", 1,
+                                 "type mismatch: can not store java.lang.String to int[1][]");
+            testNativeASMessages(ia4, "This is not a date", 2,
+                                 "type mismatch: can not store java.lang.String to int[2][][]");
+
+            testNativeASMessages2("This is not an array", "This is not a date", 2, "2");
+
+        } catch (java.lang.RuntimeException e) {
+            throw e;
+        } catch (Exception e) {
+            e.printStackTrace();
+            Asserts.fail("Wrong exception thrown: " + e);
+        }
+    }
+}

test/hotspot/jtreg/runtime/exceptionMsgs/ArrayStoreException/libArrayStoreExceptionTest.c

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018 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.
+ */
+
+#include <jni.h>
+
+JNIEXPORT void JNICALL
+  Java_ArrayStoreExceptionTest_doNativeArrayStore(JNIEnv *env, jclass klass,
+                                                  jobjectArray array, jobject element, jint index) {
+  (*env)->SetObjectArrayElement(env, array, index, element);
+}
+
+JNIEXPORT void JNICALL
+  Java_ArrayStoreExceptionTest_doNativeArrayStore2(JNIEnv *env, jclass klass,
+                                                   jobject array, jobject element, jint index) {
+  (*env)->SetObjectArrayElement(env, (jobjectArray)array, index, element);
+}