2 * Copyright (C) 2014, United States Government, as represented by the
3 * Administrator of the National Aeronautics and Space Administration.
6 * The Java Pathfinder core (jpf-core) platform is licensed under the
7 * Apache License, Version 2.0 (the "License"); you may not use this file except
8 * in compliance with the License. You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0.
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 package gov.nasa.jpf.vm;
20 import gov.nasa.jpf.Config;
21 import gov.nasa.jpf.annotation.MJI;
22 import gov.nasa.jpf.util.MethodInfoRegistry;
23 import gov.nasa.jpf.util.RunListener;
24 import gov.nasa.jpf.util.RunRegistry;
26 import java.lang.reflect.Modifier;
27 import java.util.ArrayList;
29 public class JPF_java_lang_reflect_Method extends NativePeer {
31 static MethodInfoRegistry registry;
33 // class init - this is called automatically from the NativePeer ctor
34 public static boolean init (Config conf) {
35 // this is an example of how to handle cross-initialization between
36 // native peers - this might also get explicitly called by the java.lang.Class
37 // peer, since it creates Method objects. Here we have to make sure
38 // we only reset between JPF runs
40 if (registry == null){
41 registry = new MethodInfoRegistry();
43 RunRegistry.getDefaultRegistry().addListener( new RunListener() {
45 public void reset (RunRegistry reg){
53 static int createMethodObject (MJIEnv env, ClassInfo ciMth, MethodInfo mi){
54 // note - it is the callers responsibility to ensure Method is properly initialized
55 int regIdx = registry.registerMethodInfo(mi);
56 int eidx = env.newObject( ciMth);
57 ElementInfo ei = env.getModifiableElementInfo(eidx);
59 ei.setIntField("regIdx", regIdx);
60 ei.setBooleanField("isAccessible", mi.isPublic());
65 // this is NOT an MJI method, but it is used outside this package, so
66 // we have to add 'final'
67 public static final MethodInfo getMethodInfo (MJIEnv env, int objRef){
68 return registry.getMethodInfo(env,objRef, "regIdx");
72 public int getName____Ljava_lang_String_2 (MJIEnv env, int objRef) {
73 MethodInfo mi = getMethodInfo(env, objRef);
75 int nameRef = env.getReferenceField( objRef, "name");
76 if (nameRef == MJIEnv.NULL) {
77 nameRef = env.newString(mi.getName());
78 env.setReferenceField(objRef, "name", nameRef);
85 public int getModifiers____I (MJIEnv env, int objRef){
86 MethodInfo mi = getMethodInfo(env, objRef);
87 return mi.getModifiers();
90 static int getParameterTypes( MJIEnv env, MethodInfo mi) {
91 ThreadInfo ti = env.getThreadInfo();
92 String[] argTypeNames = mi.getArgumentTypeNames();
93 int[] ar = new int[argTypeNames.length];
95 for (int i = 0; i < argTypeNames.length; i++) {
96 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(argTypeNames[i]);
97 if (!ci.isRegistered()) {
101 ar[i] = ci.getClassObjectRef();
104 int aRef = env.newObjectArray("Ljava/lang/Class;", argTypeNames.length);
105 for (int i = 0; i < argTypeNames.length; i++) {
106 env.setReferenceArrayElement(aRef, i, ar[i]);
113 public int getParameterTypes_____3Ljava_lang_Class_2 (MJIEnv env, int objRef){
114 return getParameterTypes(env, getMethodInfo(env, objRef));
117 // TODO: Fix for Groovy's model-checking
118 private static int getParameterizedTypeImplObj(String signature, MJIEnv env) {
120 ThreadInfo ti = env.getThreadInfo();
121 ClassLoaderInfo cli = env.getSystemClassLoaderInfo();
122 ClassInfo ci = cli.getResolvedClassInfo("sun.reflect.generics.reflectiveObjects.ParameterizedTypeImpl");
123 // Create a new object of type ParameterizedTypeImpl
124 int paramTypeRef = env.newObject(ci);
125 ElementInfo ei = env.getModifiableElementInfo(paramTypeRef);
126 // Get field information and fill out the fields
128 String className = Types.getGenericClassName(signature);
129 ClassInfo gci = cli.getResolvedClassInfo(className);
130 if (!gci.isRegistered()) {
131 gci.registerClass(ti);
133 ei.setReferenceField("rawType", gci.getClassObjectRef());
135 // actualTypeArguments
136 String[] parameterizedTypes = Types.getParameterizedTypesFromArgumentTypeNames(signature);
137 int[] types = new int[parameterizedTypes.length];
138 for(int j = 0; j < parameterizedTypes.length; j++) {
139 ClassInfo pci = cli.getResolvedClassInfo(parameterizedTypes[j]);
140 if (!pci.isRegistered()) {
141 pci.registerClass(ti);
143 types[j] = pci.getClassObjectRef();
145 int aRef = env.newObjectArray("Ljava/lang/reflect/Type;", parameterizedTypes.length);
146 // Set references for every array element
147 for (int j = 0; j < parameterizedTypes.length; j++) {
148 env.setReferenceArrayElement(aRef, j, types[j]);
150 ei.setReferenceField("actualTypeArguments", aRef);
153 String ownerType = Types.getOwnerClassName(signature);
154 if (ownerType != null) {
155 ClassInfo oci = ClassLoaderInfo.getCurrentResolvedClassInfo(ownerType);
156 if (!oci.isRegistered()) {
157 oci.registerClass(ti);
159 ei.setReferenceField("ownerType", oci.getClassObjectRef());
161 ei.setReferenceField("ownerType", MJIEnv.NULL);
167 static int getGenericParameterTypes( MJIEnv env, int objRef, MethodInfo mi) {
168 ThreadInfo ti = env.getThreadInfo();
169 String[] argTypeNames = mi.getArgumentGenericTypeNames();
170 int[] ar = new int[argTypeNames.length];
172 for (int i = 0; i < argTypeNames.length; i++) {
173 // Change this into just the generic class type if it is a generic class
174 if (Types.isGenericSignature(argTypeNames[i])) {
175 ar[i] = getParameterizedTypeImplObj(argTypeNames[i], env);
177 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(argTypeNames[i]);
178 if (!ci.isRegistered()) {
179 ci.registerClass(ti);
181 ar[i] = ci.getClassObjectRef();
184 int aRef = env.newObjectArray("Ljava/lang/reflect/Type;", argTypeNames.length);
185 for (int i = 0; i < argTypeNames.length; i++) {
186 env.setReferenceArrayElement(aRef, i, ar[i]);
193 public int getGenericParameterTypes_____3Ljava_lang_reflect_Type_2 (MJIEnv env, int objRef){
194 return getGenericParameterTypes(env, objRef, getMethodInfo(env, objRef));
198 public int getGenericReturnType____Ljava_lang_reflect_Type_2 (MJIEnv env, int objRef){
199 MethodInfo mi = getMethodInfo(env, objRef);
200 ThreadInfo ti = env.getThreadInfo();
203 if (Types.isGenericSignature(mi.getGenericReturnTypeName())) {
204 retRef = getParameterizedTypeImplObj(mi.getGenericReturnTypeName(), env);
206 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(mi.getReturnTypeName());
207 if (!ci.isRegistered()) {
208 ci.registerClass(ti);
210 retRef = ci.getClassObjectRef();
215 // TODO: Fix for Groovy's model-checking
216 // TODO: We have been able to only register the generic class and not yet the parameterized types
218 int getExceptionTypes(MJIEnv env, MethodInfo mi) {
219 ThreadInfo ti = env.getThreadInfo();
220 String[] exceptionNames = mi.getThrownExceptionClassNames();
222 if (exceptionNames == null) {
223 exceptionNames = new String[0];
226 int[] ar = new int[exceptionNames.length];
228 for (int i = 0; i < exceptionNames.length; i++) {
229 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(exceptionNames[i]);
230 if (!ci.isRegistered()) {
231 ci.registerClass(ti);
234 ar[i] = ci.getClassObjectRef();
237 int aRef = env.newObjectArray("Ljava/lang/Class;", exceptionNames.length);
238 for (int i = 0; i < exceptionNames.length; i++) {
239 env.setReferenceArrayElement(aRef, i, ar[i]);
246 public int getExceptionTypes_____3Ljava_lang_Class_2 (MJIEnv env, int objRef) {
247 return getExceptionTypes(env, getMethodInfo(env, objRef));
251 public int getDefaultValue____Ljava_lang_Object_2(MJIEnv env, int objRef) {
252 MethodInfo mi = getMethodInfo(env, objRef);
253 ClassInfo ci = mi.getClassInfo();
254 if(!ci.isInterface() || ci.getDirectInterfaceNames() == null || ci.getDirectInterfaceNames().length != 1 || !ci.getDirectInterfaceNames()[0].equals("java.lang.annotation.Annotation")) {
257 String annotationName = ci.getName();
258 AnnotationInfo ai = ci.getClassLoaderInfo().getResolvedAnnotationInfo(annotationName);
259 Object o = ai.getValue(mi.getName());
264 return env.liftNativeAnnotationValue(Types.getTypeName(mi.getReturnType()), o);
265 } catch(ClinitRequired e) {
266 env.handleClinitRequest(e.getRequiredClassInfo());
272 public int getReturnType____Ljava_lang_Class_2 (MJIEnv env, int objRef){
273 MethodInfo mi = getMethodInfo(env, objRef);
274 ThreadInfo ti = env.getThreadInfo();
276 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(mi.getReturnTypeName());
277 if (!ci.isRegistered()) {
278 ci.registerClass(ti);
281 return ci.getClassObjectRef();
285 public int getDeclaringClass____Ljava_lang_Class_2 (MJIEnv env, int objRef){
286 MethodInfo mi = getMethodInfo(env, objRef);
287 ClassInfo ci = mi.getClassInfo();
288 // it's got to be registered, otherwise we wouldn't be able to acquire the Method object
289 return ci.getClassObjectRef();
292 static int createBoxedReturnValueObject (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame) {
293 byte rt = mi.getReturnTypeCode();
294 int ret = MJIEnv.NULL;
298 if (rt == Types.T_DOUBLE) {
299 attr = frame.getLongResultAttr();
300 double v = frame.getDoubleResult();
301 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Double"));
302 rei = env.getModifiableElementInfo(ret);
303 rei.setDoubleField("value", v);
304 } else if (rt == Types.T_FLOAT) {
305 attr = frame.getResultAttr();
306 float v = frame.getFloatResult();
307 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Float"));
308 rei = env.getModifiableElementInfo(ret);
309 rei.setFloatField("value", v);
310 } else if (rt == Types.T_LONG) {
311 attr = frame.getLongResultAttr();
312 long v = frame.getLongResult();
313 ret = env.valueOfLong(v);
314 } else if (rt == Types.T_BYTE) {
315 attr = frame.getResultAttr();
316 int v = frame.getResult();
317 ret = env.valueOfByte((byte)v);
318 } else if (rt == Types.T_CHAR) {
319 attr = frame.getResultAttr();
320 int v = frame.getResult();
321 ret = env.valueOfCharacter((char)v);
322 } else if (rt == Types.T_SHORT) {
323 attr = frame.getResultAttr();
324 int v = frame.getResult();
325 ret = env.valueOfShort((short)v);
326 } else if (rt == Types.T_INT) {
327 attr = frame.getResultAttr();
328 int v = frame.getResult();
329 ret = env.valueOfInteger(v);
330 } else if (rt == Types.T_BOOLEAN) {
331 attr = frame.getResultAttr();
332 int v = frame.getResult();
333 ret = env.valueOfBoolean((v == 1)? true: false);
334 } else if (mi.isReferenceReturnType()){
335 attr = frame.getResultAttr();
336 ret = frame.getReferenceResult();
339 env.setReturnAttribute(attr);
343 static boolean pushUnboxedArguments (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame, int argIdx, int argsRef) {
345 ClassInfo sourceClass;
346 String destTypeNames[];
347 int nArgs, passedCount, sourceRef;
348 byte sourceType, destTypes[];
350 destTypes = mi.getArgumentTypes();
351 destTypeNames = mi.getArgumentTypeNames();
352 nArgs = destTypeNames.length;
354 // according to the API docs, passing null instead of an empty array is allowed for no args
355 passedCount = (argsRef != MJIEnv.NULL) ? env.getArrayLength(argsRef) : 0;
357 if (nArgs != passedCount) {
358 env.throwException(IllegalArgumentException.class.getName(), "Wrong number of arguments passed. Actual = " + passedCount + ". Expected = " + nArgs);
362 for (int i = 0; i < nArgs; i++) {
363 sourceRef = env.getReferenceArrayElement(argsRef, i);
365 // we have to handle null references explicitly
366 if (sourceRef == MJIEnv.NULL) {
367 if ((destTypes[i] != Types.T_REFERENCE) && (destTypes[i] != Types.T_ARRAY)) {
368 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Actual = (null). Expected = " + destTypeNames[i]);
372 frame.pushRef(MJIEnv.NULL);
376 source = env.getElementInfo(sourceRef);
377 sourceClass = source.getClassInfo();
378 sourceType = getSourceType( sourceClass, destTypes[i], destTypeNames[i]);
380 Object attr = env.getElementInfo(argsRef).getFields().getFieldAttr(i);
381 if ((argIdx = pushArg( argIdx, frame, source, sourceType, destTypes[i], attr)) < 0 ){
382 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Source Class = " + sourceClass.getName() + ". Dest Class = " + destTypeNames[i]);
390 // this returns the primitive type in case we have to unbox, and otherwise checks reference type compatibility
391 private static byte getSourceType (ClassInfo ciArgVal, byte destType, String destTypeName){
394 case Types.T_BOOLEAN:
402 return Types.getUnboxedType(ciArgVal.getName());
405 case Types.T_REFERENCE: // check if the source type is assignment compatible with the destType
406 if (ciArgVal.isInstanceOf(destTypeName)){
414 // do the proper type conversion - Java is pretty forgiving here and does
415 // not throw exceptions upon value truncation
416 private static int pushArg( int argIdx, DirectCallStackFrame frame, ElementInfo eiArg, byte srcType, byte destType, Object attr){
420 double v = eiArg.getDoubleField("value");
421 if (destType == Types.T_DOUBLE){
422 return frame.setDoubleArgument( argIdx, v, attr);
426 case Types.T_FLOAT: // covers float, double
428 float v = eiArg.getFloatField("value");
431 return frame.setFloatArgument( argIdx, v, attr);
433 return frame.setDoubleArgument( argIdx, v, attr);
439 long v = eiArg.getLongField("value");
442 return frame.setLongArgument(argIdx, v, attr);
444 return frame.setFloatArgument(argIdx, v, attr);
446 return frame.setDoubleArgument( argIdx, v, attr);
452 int v = eiArg.getIntField("value");
455 return frame.setArgument( argIdx, v, attr);
457 return frame.setLongArgument( argIdx, v, attr);
459 return frame.setFloatArgument(argIdx, v, attr);
461 return frame.setDoubleArgument( argIdx, v, attr);
467 int v = eiArg.getShortField("value");
471 return frame.setArgument( argIdx, v, attr);
473 return frame.setLongArgument( argIdx, v, attr);
475 return frame.setFloatArgument(argIdx, v, attr);
477 return frame.setDoubleArgument( argIdx, v, attr);
483 byte v = eiArg.getByteField("value");
488 return frame.setArgument( argIdx, v, attr);
490 return frame.setLongArgument( argIdx, v, attr);
492 return frame.setFloatArgument(argIdx, v, attr);
494 return frame.setDoubleArgument( argIdx, v, attr);
500 char v = eiArg.getCharField("value");
504 return frame.setArgument( argIdx, v, attr);
506 return frame.setLongArgument( argIdx, v, attr);
508 return frame.setFloatArgument(argIdx, v, attr);
510 return frame.setDoubleArgument( argIdx, v, attr);
514 case Types.T_BOOLEAN:
516 boolean v = eiArg.getBooleanField("value");
517 if (destType == Types.T_BOOLEAN){
518 return frame.setArgument( argIdx, v ? 1 : 0, attr);
524 int ref = eiArg.getObjectRef();
525 if (destType == Types.T_ARRAY){
526 return frame.setReferenceArgument( argIdx, ref, attr);
530 case Types.T_REFERENCE:
532 int ref = eiArg.getObjectRef();
533 if (destType == Types.T_REFERENCE){
534 return frame.setReferenceArgument( argIdx, ref, attr);
545 public int invoke__Ljava_lang_Object_2_3Ljava_lang_Object_2__Ljava_lang_Object_2 (MJIEnv env, int mthRef, int objRef, int argsRef) {
546 ThreadInfo ti = env.getThreadInfo();
547 MethodInfo miCallee = getMethodInfo(env, mthRef);
548 ClassInfo calleeClass = miCallee.getClassInfo();
549 DirectCallStackFrame frame = ti.getReturnedDirectCall();
551 if (frame == null){ // first time
553 //--- check the instance we are calling on
554 if (!miCallee.isStatic()) {
555 if (objRef == MJIEnv.NULL){
556 env.throwException("java.lang.NullPointerException");
560 ElementInfo eiObj = ti.getElementInfo(objRef);
561 ClassInfo objClass = eiObj.getClassInfo();
563 if (!objClass.isInstanceOf(calleeClass)) {
564 env.throwException(IllegalArgumentException.class.getName(), "Object is not an instance of declaring class. Actual = " + objClass + ". Expected = " + calleeClass);
570 //--- check accessibility
571 ElementInfo eiMth = ti.getElementInfo(mthRef);
572 if (! (Boolean) eiMth.getFieldValueObject("isAccessible")) {
573 StackFrame caller = ti.getTopFrame().getPrevious();
574 ClassInfo callerClass = caller.getClassInfo();
576 if (callerClass != calleeClass) {
577 env.throwException(IllegalAccessException.class.getName(), "Class " + callerClass.getName() +
578 " can not access a member of class " + calleeClass.getName()
579 + " with modifiers \"" + Modifier.toString(miCallee.getModifiers()));
584 //--- push the direct call
585 frame = miCallee.createDirectCallStackFrame(ti, 0);
586 frame.setReflection();
589 if (!miCallee.isStatic()) {
590 frame.setReferenceArgument( argOffset++, objRef, null);
592 if (!pushUnboxedArguments( env, miCallee, frame, argOffset, argsRef)) {
593 // we've got a IllegalArgumentException
599 //--- check for and push required clinits
600 if (miCallee.isStatic()){
601 calleeClass.initializeClass(ti);
604 return MJIEnv.NULL; // reexecute
606 } else { // we have returned from the direct call
607 return createBoxedReturnValueObject( env, miCallee, frame);
612 // this one has to collect annotations upwards in the inheritance chain
613 static int getAnnotations (MJIEnv env, MethodInfo mi){
614 String mname = mi.getName();
615 String msig = mi.genericSignature;
616 ArrayList<AnnotationInfo> aiList = new ArrayList<AnnotationInfo>();
618 // our own annotations
619 ClassInfo ci = mi.getClassInfo();
620 for (AnnotationInfo ai : mi.getAnnotations()) {
624 // our superclass annotations
625 for (ci = ci.getSuperClass(); ci != null; ci = ci.getSuperClass()){
626 mi = ci.getMethod(mname, msig, false);
628 for (AnnotationInfo ai: mi.getAnnotations()){
635 return env.newAnnotationProxies(aiList.toArray(new AnnotationInfo[aiList.size()]));
636 } catch (ClinitRequired x){
637 env.handleClinitRequest(x.getRequiredClassInfo());
643 public int getAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
644 return getAnnotations( env, getMethodInfo(env,mthRef));
647 // the following ones consist of a package default implementation that is shared with
648 // the constructor peer, and a public model method
649 static int getAnnotation (MJIEnv env, MethodInfo mi, int annotationClsRef){
650 ClassInfo aci = env.getReferredClassInfo(annotationClsRef);
652 AnnotationInfo ai = mi.getAnnotation(aci.getName());
654 ClassInfo aciProxy = aci.getAnnotationProxy();
656 return env.newAnnotationProxy(aciProxy, ai);
657 } catch (ClinitRequired x){
658 env.handleClinitRequest(x.getRequiredClassInfo());
667 public int getAnnotation__Ljava_lang_Class_2__Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef, int annotationClsRef) {
668 return getAnnotation(env, getMethodInfo(env,mthRef), annotationClsRef);
671 static int getDeclaredAnnotations (MJIEnv env, MethodInfo mi){
672 AnnotationInfo[] ai = mi.getAnnotations();
675 return env.newAnnotationProxies(ai);
676 } catch (ClinitRequired x){
677 env.handleClinitRequest(x.getRequiredClassInfo());
683 public int getDeclaredAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
684 return getDeclaredAnnotations( env, getMethodInfo(env,mthRef));
687 static int getParameterAnnotations (MJIEnv env, MethodInfo mi){
688 AnnotationInfo[][] pa = mi.getParameterAnnotations();
689 // this should always return an array object, even if the method has no arguments
692 int paRef = env.newObjectArray("[Ljava/lang/annotation/Annotation;", pa.length);
694 for (int i=0; i<pa.length; i++){
695 int eRef = env.newAnnotationProxies(pa[i]);
696 env.setReferenceArrayElement(paRef, i, eRef);
701 } catch (ClinitRequired x){ // be prepared that we might have to initialize respective annotation classes
702 env.handleClinitRequest(x.getRequiredClassInfo());
708 public int getParameterAnnotations_____3_3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
709 return getParameterAnnotations( env, getMethodInfo(env,mthRef));
713 public int toString____Ljava_lang_String_2 (MJIEnv env, int objRef){
714 StringBuilder sb = new StringBuilder();
716 MethodInfo mi = getMethodInfo(env, objRef);
718 sb.append(Modifier.toString(mi.getModifiers()));
721 sb.append(mi.getReturnTypeName());
724 sb.append(mi.getClassName());
727 sb.append(mi.getName());
731 String[] at = mi.getArgumentTypeNames();
732 for (int i=0; i<at.length; i++){
733 if (i>0) sb.append(',');
739 int sref = env.newString(sb.toString());
744 public boolean equals__Ljava_lang_Object_2__Z (MJIEnv env, int objRef, int mthRef){
745 ElementInfo ei = env.getElementInfo(mthRef);
746 ClassInfo ci = ClassLoaderInfo.getSystemResolvedClassInfo(JPF_java_lang_Class.METHOD_CLASSNAME);
748 if (ei.getClassInfo() == ci){
749 MethodInfo mi1 = getMethodInfo(env, objRef);
750 MethodInfo mi2 = getMethodInfo(env, mthRef);
751 if (mi1.getClassInfo() == mi2.getClassInfo()){
752 if (mi1.getName().equals(mi2.getName())){
753 if (mi1.getReturnType().equals(mi2.getReturnType())){
754 byte[] params1 = mi1.getArgumentTypes();
755 byte[] params2 = mi2.getArgumentTypes();
756 if (params1.length == params2.length){
757 for (int i = 0; i < params1.length; i++){
758 if (params1[i] != params2[i]){
772 public int hashCode____I (MJIEnv env, int objRef){
773 MethodInfo mi = getMethodInfo(env, objRef);
774 return mi.getClassName().hashCode() ^ mi.getName().hashCode();