1 /*
   2  * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /*
  25  * @test jdk.vm.ci.hotspot.test.HotSpotConstantReflectionProviderTest
  26  * @requires (os.simpleArch == "x64" | os.simpleArch == "sparcv9" | os.simpleArch == "aarch64")
  27  * @modules jdk.vm.ci/jdk.vm.ci.runtime
  28  *          jdk.vm.ci/jdk.vm.ci.meta
  29  *          jdk.vm.ci/jdk.vm.ci.hotspot
  30  *          java.base/jdk.internal.vm.annotation
  31  *          java.base/jdk.internal.misc
  32  * @library /testlibrary /test/lib /compiler/jvmci/jdk.vm.ci.hotspot.test/src
  33  * @build jdk.vm.ci.hotspot.test.DummyClass
  34  * @run driver ClassFileInstaller jdk.vm.ci.hotspot.test.DummyClass
  35  * @run testng/othervm/timeout=300 -Xbootclasspath/a:.
  36  *      -XX:+UnlockExperimentalVMOptions -XX:+EnableJVMCI
  37  *       jdk.vm.ci.hotspot.test.HotSpotConstantReflectionProviderTest
  38  */
  39 
  40 package jdk.vm.ci.hotspot.test;
  41 
  42 import static jdk.vm.ci.hotspot.test.TestHelper.CONSTANT_REFLECTION_PROVIDER;
  43 
  44 import java.lang.reflect.Method;
  45 import jdk.vm.ci.hotspot.HotSpotResolvedJavaField;
  46 import jdk.vm.ci.meta.JavaConstant;
  47 import jdk.vm.ci.meta.Constant;
  48 import jdk.vm.ci.meta.MemoryAccessProvider;
  49 import jdk.vm.ci.meta.MethodHandleAccessProvider;
  50 import jdk.vm.ci.meta.ResolvedJavaField;
  51 import jdk.vm.ci.meta.ResolvedJavaType;
  52 import org.testng.Assert;
  53 import org.testng.annotations.Test;
  54 
  55 public class HotSpotConstantReflectionProviderTest {
  56 
  57     @Test(dataProvider = "forObjectDataProvider", dataProviderClass = ForObjectDataProvider.class)
  58     public void testForObject(Object obj, String expected) {
  59         JavaConstant jConst = TestHelper.CONSTANT_REFLECTION_PROVIDER.forObject(obj);
  60         Assert.assertNotNull(jConst,
  61                              "An instance of JavaConstant returned by" + " \"forObject\" method should not be null");
  62         Assert.assertEquals(jConst.toString(), expected, "Unexpected result:");
  63     }
  64 
  65     @Test(dataProvider = "forStringDataProvider", dataProviderClass = ForStringDataProvider.class)
  66     public void testForString(String string, String expected) {
  67         JavaConstant jConst = CONSTANT_REFLECTION_PROVIDER.forString(string);
  68         Assert.assertNotNull(jConst,
  69                              "An instance of JavaConstant returned by" + " \"forString\" method should not be null");
  70         Assert.assertEquals(jConst.toString(), expected, "Unexpected result:");
  71     }
  72 
  73     @Test(dataProvider = "constantEqualsDataProvider", dataProviderClass = ConstantEqualsDataProvider.class)
  74     public void testConstantEquals(Constant const1, Constant const2, Boolean expected) {
  75         Assert.assertEquals(CONSTANT_REFLECTION_PROVIDER.constantEquals(const1, const2), expected,
  76                             "Unexpected result:");
  77     }
  78 
  79     @Test(dataProvider = "readArrayLengthDataProvider", dataProviderClass = ReadArrayLengthDataProvider.class)
  80     public void testReadArrayLength(JavaConstant array, Integer expected) {
  81         Assert.assertEquals(CONSTANT_REFLECTION_PROVIDER.readArrayLength(array), expected,
  82                             "Unexpected result:");
  83     }
  84 
  85     @Test(dataProvider = "readArrayElementDataProvider", dataProviderClass = ReadArrayElementDataProvider.class)
  86     public void testReadArrayElement(JavaConstant array, int index, Object expected) {
  87         Assert.assertEquals(CONSTANT_REFLECTION_PROVIDER.readArrayElement(array, index), expected,
  88                             "Unexpected result:");
  89     }
  90 
  91     @Test(dataProvider = "readFieldValueDataProvider", dataProviderClass = ReadFieldValueDataProvider.class)
  92     public void testReadFieldValue(ResolvedJavaField field, JavaConstant receiver, JavaConstant expected) {
  93         JavaConstant actual = CONSTANT_REFLECTION_PROVIDER.readFieldValue(field, receiver);
  94         Assert.assertEquals(actual == null ? "null" : actual.toString(),
  95                             expected == null ? "null" : expected.toString(), "Unexpected result:");
  96     }
  97 
  98     @Test(dataProvider = "readFieldValueNegativeDataProvider",
  99             dataProviderClass = ReadFieldValueDataProvider.class,
 100             expectedExceptions = {NullPointerException.class})
 101     public void testNegativeReadFieldValue(ResolvedJavaField field, JavaConstant receiver) {
 102         CONSTANT_REFLECTION_PROVIDER.readFieldValue(field, receiver);
 103     }
 104 
 105     @Test(dataProvider = "readStableFieldValueDataProvider",
 106             dataProviderClass = ReadStableFieldValueDataProvider.class)
 107     public void testReadStableFieldValue(ResolvedJavaField field, JavaConstant receiver, boolean isDefStab,
 108                                          JavaConstant expected) {
 109         Assert.assertEquals(
 110                 CONSTANT_REFLECTION_PROVIDER.readStableFieldValue(field, receiver, isDefStab),
 111                 expected,
 112                 "Unexpected result:");
 113     }
 114 
 115     @Test(dataProvider = "readStableFieldValueArrayDataProvider",
 116             dataProviderClass = ReadStableFieldValueDataProvider.class)
 117     public void testReadStableFieldValueForArray(ResolvedJavaField field, JavaConstant receiver, boolean isDefStab,
 118                                                  int arrayDim, JavaConstant expected) {
 119         JavaConstant result = CONSTANT_REFLECTION_PROVIDER.readStableFieldValue(field, receiver,
 120                                                                                 isDefStab);
 121         boolean resultDefStab = false;
 122         int resultStableDim = -1;
 123         try {
 124             Class<?> hotSpotObjectConstantImplClass = Class.forName(
 125                     "jdk.vm.ci.hotspot.HotSpotObjectConstantImpl");
 126             Method getStableDimensionMethod = hotSpotObjectConstantImplClass.getDeclaredMethod(
 127                     "getStableDimension");
 128             Method isDefaultStableMethod = hotSpotObjectConstantImplClass.getDeclaredMethod(
 129                     "isDefaultStable");
 130             getStableDimensionMethod.setAccessible(true);
 131             isDefaultStableMethod.setAccessible(true);
 132             resultDefStab = (boolean) isDefaultStableMethod.invoke(result);
 133             resultStableDim = (int) getStableDimensionMethod.invoke(result);
 134         } catch (ReflectiveOperationException e) {
 135             throw new Error("Unexpected error: " + e, e);
 136         }
 137         Assert.assertEquals(resultDefStab, isDefStab,
 138                             "Wrong default stable value for " + result.toString());
 139         Assert.assertEquals(resultStableDim, arrayDim,
 140                             "Wrong array dimension for " + result.toString());
 141         Assert.assertEquals(result.toString(), expected.toString(), "Unexpected result:");
 142     }
 143 
 144     @Test(dataProvider = "readStableFieldValueNegativeDataProvider",
 145             dataProviderClass = ReadStableFieldValueDataProvider.class,
 146             expectedExceptions = {NullPointerException.class})
 147     public void testNegativeReadStableFieldValue(ResolvedJavaField field, JavaConstant receiver, boolean isDefStab) {
 148         CONSTANT_REFLECTION_PROVIDER.readStableFieldValue(field, receiver, isDefStab);
 149     }
 150 
 151     @Test(dataProvider = "readConstantFieldValueDataProvider",
 152             dataProviderClass = ReadConstantFieldValueDataProvider.class)
 153     public void testReadConstantFieldValue(ResolvedJavaField field, JavaConstant receiver, JavaConstant expected,
 154                                            String testInfo) {
 155         String msg = String.format("Unexpected result for %s. Field is stable = %s.", testInfo,
 156                                    ((HotSpotResolvedJavaField) field).isStable());
 157         Assert.assertEquals(CONSTANT_REFLECTION_PROVIDER.readConstantFieldValue(field, receiver),
 158                             expected, msg);
 159     }
 160 
 161     @Test(dataProvider = "readConstantFieldValueNegativeDataProvider",
 162             dataProviderClass = ReadConstantFieldValueDataProvider.class,
 163             expectedExceptions = {NullPointerException.class})
 164     public void testNegativeReadConstantFieldValue(ResolvedJavaField field, JavaConstant receiver) {
 165         CONSTANT_REFLECTION_PROVIDER.readConstantFieldValue(field, receiver);
 166     }
 167 
 168     @Test(dataProvider = "readConstantArrayElementDataProvider",
 169             dataProviderClass = ReadConstantArrayElementDataProvider.class)
 170     public void testReadConstantArrayElement(JavaConstant array, int index, JavaConstant expected, String testInfo) {
 171         JavaConstant actual = CONSTANT_REFLECTION_PROVIDER.readConstantArrayElement(array, index);
 172         Assert.assertEquals(actual == null ? "null" : actual.toString(),
 173                             expected == null ? "null" : expected.toString(),
 174                             String.format("Unexpected result while testing %s:", testInfo));
 175     }
 176 
 177     @Test(dataProvider = "readConstantArrayElementForOffsetDataProvider",
 178             dataProviderClass = ReadConstantArrayElementDataProvider.class)
 179     public void testReadConstantArrayElementForOffset(JavaConstant array, long offset, JavaConstant expected,
 180                                                       String testInfo) {
 181         JavaConstant actual = CONSTANT_REFLECTION_PROVIDER.readConstantArrayElementForOffset(array,
 182                                                                                              offset);
 183         Assert.assertEquals(actual == null ? "null" : actual.toString(),
 184                             expected == null ? "null" : expected.toString(),
 185                             String.format("Unexpected result while testing %s:", testInfo));
 186     }
 187 
 188     @Test(dataProvider = "asJavaTypeDataProvider", dataProviderClass = AsJavaTypeDataProvider.class)
 189     public void testAsJavaType(JavaConstant constant, String expected) {
 190         ResolvedJavaType actual = CONSTANT_REFLECTION_PROVIDER.asJavaType(constant);
 191         Assert.assertEquals(actual == null ? "null" : actual.toJavaName(),
 192                             expected == null ? "null" : expected,
 193                             "Unexpected result, wrong type returned:");
 194     }
 195 
 196     @Test(dataProvider = "boxPrimitiveDataProvider", dataProviderClass = BoxPrimitiveDataProvider.class)
 197     public void testBoxPrimitive(JavaConstant constant, JavaConstant expected) {
 198         JavaConstant actual = CONSTANT_REFLECTION_PROVIDER.boxPrimitive(constant);
 199         Assert.assertEquals(actual, expected, "Unexpected result:");
 200     }
 201 
 202     @Test(dataProvider = "unboxPrimitiveDataProvider", dataProviderClass = UnboxPrimitiveDataProvider.class)
 203     public void testUnboxPrimitive(JavaConstant constant, JavaConstant expected) {
 204         JavaConstant actual = CONSTANT_REFLECTION_PROVIDER.unboxPrimitive(constant);
 205         Assert.assertEquals(actual, expected, "Unexpected result:");
 206     }
 207 
 208     @Test(dataProvider = "isEmbeddableDataProvider", dataProviderClass = IsEmbeddableDataProvider.class)
 209     public void testIsEmbeddable(JavaConstant constant, boolean expected) {
 210         boolean actual = CONSTANT_REFLECTION_PROVIDER.isEmbeddable(constant);
 211         Assert.assertEquals(actual, expected, "Unexpected result:");
 212     }
 213 
 214     @Test
 215     public void testGetMemoryAccessProvider() {
 216         MemoryAccessProvider actual = CONSTANT_REFLECTION_PROVIDER.getMemoryAccessProvider();
 217         Assert.assertNotNull(actual, "Returned MemoryAccessProvider instance should not be null");
 218     }
 219 
 220     @Test
 221     public void testGetMethodHandleAccess() {
 222         MethodHandleAccessProvider actual = CONSTANT_REFLECTION_PROVIDER.getMethodHandleAccess();
 223         Assert.assertNotNull(actual,
 224                              "Returned MethodHandleAccessProvider instance should not be null");
 225     }
 226 }